fix: handle case of invalid package.json with no explicit config #5198
Conversation
Since `readFileSync` is only stubbed `onFirstCall` we get a different answer the second time around which is probably Not What You Want. But also we *already checked that config = false*. So you could just remove this test, it does nothing useful.
|
(signed the CLA!) |
lib/cli/options.js
Outdated
| @@ -195,6 +195,11 @@ const loadPkgRc = (args = {}) => { | |||
| `Unable to read/parse ${filepath}: ${err}`, | |||
| filepath | |||
| ); | |||
| } else if (err.toString().includes('SyntaxError')) { | |||
| throw createUnparsableFileError( | |||
There was a problem hiding this comment.
(On my phone) Will throwing here result in a warning? Feels more like an error to me?
There was a problem hiding this comment.
It will fail with an error, these exceptions are not caught (we could, possibly, catch them at the top level of the CLI and exit cleanly in order to avoid barfing stack traces on the user...)
lib/cli/options.js
Outdated
| @@ -195,6 +195,11 @@ const loadPkgRc = (args = {}) => { | |||
| `Unable to read/parse ${filepath}: ${err}`, | |||
| filepath | |||
| ); | |||
| } else if (err.toString().includes('SyntaxError')) { | |||
There was a problem hiding this comment.
If we want to separate the parsing from the reading errors, then I would suggest instead splitting this try/catch into an initial one for reading followed by a second one for parsing – that way we will not have to check the error as we know it's JSON.parse() that fails
Also gives more granular error for the existing use case – different error message depending on whether it can't read or can't parse
There was a problem hiding this comment.
Seems like a good idea. Also, would it be useful to give an error for parsing errors more like the one npm gives, i.e. "make sure your package.json is JSON and not Javascript"?
There was a problem hiding this comment.
I don’t think it’s needed, just a warning saying “could not check package.json due to error while parsing” is probably the clearest
There was a problem hiding this comment.
I've simply split it into "Unable to read" and "Unable to parse" for the moment, not sure if there is a better wording.
|
Thanks for the PR! Gave some feedback |
dhdaines
changed the title
PR Checklist
package.jsonsection #5141status: accepting prsOverview
Handle the corner case which can happen if:
package.jsonwhich npm was happy withmochaconfiguration inside yourpackage.jsonnpm testyou ranmochadirectly (withnpxor justmocha.js)As detailed here: https://github.com/dhdaines/mocha-5141