fix(usage): tie usage to config #2908
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
wraithgar
commented
Mar 19, 2021
wraithgar
force-pushed
the
gar/usage-from-config
branch
2 times, most recently
from
c4145cd
to
2c3c747
Compare
wraithgar
commented
Mar 19, 2021
| @@ -1311,6 +1313,34 @@ The program to use to view help content. | |||
|
|
|||
| Set to `"browser"` to view html help content in the default web browser. | |||
|
|
|||
| #### `which` | |||
There was a problem hiding this comment.
which was not defined yet, and I re-ran the make to generate this file. We should think about automating this make command
There was a problem hiding this comment.
It's included in the make docs that's part of the release process as a final safety net, but some easier way to run it ahead of time would be nice, too, I agree.
wraithgar
commented
Mar 19, 2021
| @@ -21,6 +21,8 @@ t.test('basic definition', async t => { | |||
| default: 'some default value', | |||
| defaultDescription: '"some default value"', | |||
| type: [Number, String], | |||
| hint: '<key>', | |||
| usage: '--key <key>|--key <key>', | |||
There was a problem hiding this comment.
We can address this once we add a config item that has this kind of type to a command's params.
wraithgar
force-pushed
the
gar/usage-from-config
branch
from
2c3c747
to
eab8246
Compare
wraithgar
added
semver:patch
nlf
approved these changes
Mar 22, 2021
isaacs
approved these changes
Mar 22, 2021
| @@ -1311,6 +1313,34 @@ The program to use to view help content. | |||
|
|
|||
| Set to `"browser"` to view html help content in the default web browser. | |||
|
|
|||
| #### `which` | |||
There was a problem hiding this comment.
It's included in the make docs that's part of the release process as a final safety net, but some easier way to run it ahead of time would be nice, too, I agree.
wraithgar
force-pushed
the
gar/usage-from-config
branch
2 times, most recently
from
8a7855e
to
f37bb68
Compare
This starts us down the path of tying the params our commands accept to their config items. For now it is optional, and not every current config item would cleanly render if we added them today. The ones that are added here DO render nicely, and we can iterate from here. We can also at a later date do the same kind of appraoch with our positional args. PR-URL: #2908 Credit: @wraithgar Close: #2908 Reviewed-by: @nlf, @isaacs
wraithgar
force-pushed
the
gar/usage-from-config
branch
from
f37bb68
to
b876442
Compare
This was referenced Nov 30, 2023
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.
This starts us down the path of tying the params our commands accept to
their config items. For now it is optional, and not every current
config item would cleanly render if we added them today.
The ones that are added here DO render nicely, and we can iterate from
here. We can also at a later date do the same kind of appraoch with our
positional args.
References
Related to npm/statusboard#308
Here we can see the brute-force "Just show a really long complicated usage string" approach for our current save-flag situation in use.
@scopehint exampleShorthand examples
Example of using manual usage declaration in the config to show the
--no-option instead