Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing mapping.yaml file is silently replaced with test substitute #6

Open
forikal-uk opened this issue Jun 24, 2018 · 0 comments
Open
Assignees
Labels
bug Something isn't working

Comments

@forikal-uk
Copy link
Collaborator

forikal-uk commented Jun 24, 2018

Steps to recreate

When the mapping file is missing

$ pwd
/Users/x/Documents/Projects/XmlAuthoringSuite/capture-lookups
$ ls
LICENSE     composer.json   docs      src
README.md   composer.lock   mapping_test.yaml tests
bin     credentials_test.json phpunit.xml.dist  vendor

and the command is run:

$ bin/capture-lookups 

Please enter one of the configured Sheet names
+----------------------+------------------------------------------------------------------------------------------+
| Sheet Name           | URL                                                                                      |
+----------------------+------------------------------------------------------------------------------------------+
| TestingSheet         | https://docs.google.com/spreadsheets/d/1ntgjIXTK_-7cOkbyTrnusI8zTu9UxArPJ-C7vQGwYMY/edit |
| TestingSheetBatchGet | https://docs.google.com/spreadsheets/d/1ntgjIXTK_-7cOkbyTrnusI8zTu9UxArPJ-C7vQGwYMY/edit |
+----------------------+------------------------------------------------------------------------------------------+

What happens?

The application asks "please enter one of the configured Sheet names", but offering the mapping_test.yaml.

What is expected?

I was surprised by this and I think it may confuse new users who will not realise that they are responsible for setting the mappings.

As a new user, I would expect either:

  • A "crash early" graceful warning to prompt me to set up my mapping file, or
  • A clear indication output to warn me that mapping_test.yaml is being used and I should be setting up my own mapping file.

This is a minor bug. So, not urgent. I am just logging it here while it is fresh in my mind.

I believe that defaulting to the mapping_test.yaml might be 'helpful' but not necessarily 'good' for the user.

@forikal-uk forikal-uk self-assigned this Jun 24, 2018
@forikal-uk forikal-uk added the bug Something isn't working label Jun 24, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant