docs: improve --help #555
Open
docs: improve --help #555
Conversation
This file contains hidden or 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
bcoe
reviewed
May 2, 2025
| describe: 'path to JSON configuration file. By default, c8 searches for ' + | ||
| 'files named .c8rc, .c8rc.json, .nycrc, or .nycrc.json, ' + | ||
| 'starting from cwd and walking up the filesystem tree.', | ||
| defaultDescription: 'as described', |
Owner
There was a problem hiding this comment.
could this just be cwd, and drop the last sentence:
starting from cwd and walking up the filesystem tree?
Also, rather than writing out .c8rc, .c8rc.json, etc.,
Why not pull ['.c8rc', '.c8rc.json', '.nycrc', '.nycrc.json'] into a variable, and use the array we pass to find-up to create the description? That way someone doesn't need to update in both places.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
fixes #342
Checklist
npm test, tests passingnpm run test:snap(to update the snapshot)