Clean up description parsing
#256
Merged
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
tommy-mitchell
commented
Feb 29, 2024
| @@ -76,7 +78,7 @@ const buildResult = (options, parserOptions) => { | |||
| input, | |||
| flags, | |||
| unnormalizedFlags, | |||
| pkg: package_, | |||
| pkg: packageJson, | |||
There was a problem hiding this comment.
Thoughts on renaming cli.pkg to package or packageJson?
There was a problem hiding this comment.
It cannot be package as it's a reserved keyword, so it cannot be destructured. But we could indeed make it packageJson.
There was a problem hiding this comment.
Hadn't considered the destructuring part, fair point. I'm ambivalent on the change, but feel free to add it to #233 if you'd like to change it (or just go for it). The consistency (and not having to rename variables) would be nice though.
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.
Separating out from #252. Updates readme for
descriptionandhelpto match JSDoc, and adds note about defaulting to code 2 (#252 (comment)).Probably shouldn't have written this to begin with: