Closed MathieuAA closed 4 years ago
Merging #50 into master will not change coverage. The diff coverage is
n/a
.
@@ Coverage Diff @@
## master #50 +/- ##
=======================================
Coverage 97.88% 97.88%
=======================================
Files 11 11
Lines 189 189
Branches 29 29
=======================================
Hits 185 185
Misses 4 4
Impacted Files | Coverage Δ | |
---|---|---|
packages/lockfile-lint/src/cli.js | 0% <ø> (ø) |
:arrow_up: |
Continue to review full report at Codecov.
Legend - Click here to learn more
Δ = absolute <relative> (impact)
,ø = not affected
,? = missing data
Powered by Codecov. Last update c7671ac...8a6e1ad. Read the comment docs.
Looks good, thanks @MathieuAA 💜
I'll follow-up this PR with a travis update that also tests for other locales
I don't think it's a good idea. Checking whether some word appears in an output controlled by a dependency is good if you're testing the dependency's integration with your tool. If the word changes, or a typo is introduced, your tests will fail. The coupling is too strong.
@MathieuAA I don't fancy the change introduced in this PR to disable automatic locale detection just to fix the developer-side failing test but I'm ok with it as a workaround since localization of the CLI text isn't a feature I expect out of this tool.
The actual fix should be that when the tests run they invoke the CLI in a way that doesn't auto-detect the locale.
Testing based on CLI output makes sense because I do want to ensure that the CLI has helplful information like showing an example to the user.
If it's actually something that matters, then yes: disabling locale detection for tests may be the way to go.
In this case, instead of checking if the "examples" word is present (yargs introduces this word), might I suggest that what you wrote as text be checked directly? That way you're in control of what you provide to the user and what's displayed by yargs and don't depend on what the dependency may or may not provide as extra chars. And if you really want to check an "examples" string be present, you can always write dependency tests separately.
Description
Made the tests not fail if the user locale isn't the default one (en). This issue occurred because yargs detects the locale to output things.
Types of changes
Disabled the locale detection when configuring yargs.
Related Issue
Fix #41
Motivation and Context
I wanted to play with this great package but the tests didn't pass.
How Has This Been Tested?
I cloned the project, installed the packages' dependencies and launched the tests. They failed. I did the fix and checked the tests passed.
Screenshots (if appropriate):
Checklist: