Update README and quick-start for allowExcessArguments change #2266
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
abetomo
reviewed
Oct 12, 2024
| @@ -2,7 +2,7 @@ const { program } = require('commander'); | |||
|
|
|||
| // This is used as an example in the README for the Quick Start. | |||
|
|
|||
| program.option('--first').option('-s, --separator <char>'); | |||
| program.option('--first').option('-s, --separator <char>').argument('<string>'); | |||
There was a problem hiding this comment.
Suggested change
| program.option('--first').option('-s, --separator <char>').argument('<string>'); | |
| program | |
| .option('--first') | |
| .option('-s, --separator <char>') | |
| .argument('<string>'); |
How about a line break to match the README?
There was a problem hiding this comment.
We run Prettier over the example files (but not over the source code in the README) and Prettier uses the compact layout for the short chaining calls in the simple example.
There was a problem hiding this comment.
I have wondered about whether should use the Prettier layout in the README, but I prefer being able to manually layout code and take extra space where I think it helps. Might just be habit though!
abetomo
approved these changes
Oct 12, 2024
shadowspawn
added
the
pending release
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.
The README had not been updated to describe excess arguments as now an error by default. While doing so, I noticed some examples which need updating due to the stricter checks.