🐷 Improve config error logs and messages #274
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
refs TryGhost#216 This PR changes the `Config.exists()` method in a way that rather than simply returning false, we're catching the error and return a `ConfigError` object that includes the received error object from `fs.readJsonSync()` as a message. There are two places, where `Config.exists()` is being called and was expecting a boolean `false` to determine if the config is valid. But this can mean, that the config either doesn't exist or has a syntax error. It remained a secret to the user. I changed this to check for an `options` property (I'm not very happy with the wording of this, but the CLI uses its own errors and not Ignition and I didn't want to change this within this PR), which than has the `message` property that includes a better error message which we then can log for the user. e. g. ``` A ConfigError occured. Error detected in the production configuration. Message: The config.production.json file is missing or not valid JSON Context: Error: /Users/aileennowak/Code/cli-installs/cli_3/config.production.json: ENOENT: no such file or directory, open '/Users/aileennowak/Code/cli-installs/cli_3/config.production.json' Debug Information: Node Version: v6.11.0 Ghost-CLI Version: 1.0.0-beta.3 Environment: production Command: 'ghost start' ```
|
Going to close this for now - as per the task in #216 the solution should instead try to point to the specific place in the config where the JSON is invalid. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
refs #216
This PR changes the
Config.exists()method in a way that rather than simply returning false, we're catching the error and return aConfigErrorobject that includes the received error object fromfs.readJsonSync()as a message.There are two places, where
Config.exists()is being called and was expecting a booleanfalseto determine if the config is valid. But this can mean, that the config either doesn't exist or has a syntax error. It remained a secret to the user.I changed this to check for an
optionsproperty (I'm not very happy with the wording of this, but the CLI uses its own errors and not Ignition and I didn't want to change this within this PR), which than has themessageproperty that includes a better error message which we then can log for the user.e. g.