Fix #80: add autoHelpFlags #82
Closed
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
|
What is the behavior if the user specifies their own |
|
Can you update the main readme example to use it? https://github.com/sindresorhus/meow#usage |
sindresorhus
requested changes
Jun 12, 2019
| it.desc | ||
| ).join('\n'), 2); | ||
| } | ||
| } |
There was a problem hiding this comment.
This should be moved to a top-level function. For readability and maintainability purposes.
| @@ -62,6 +63,64 @@ module.exports = (helpMessage, opts) => { | |||
|
|
|||
| help = (description ? `\n ${description}\n` : '') + (help ? `\n${help}\n` : '\n'); | |||
|
|
|||
| if (opts.autoHelpFlags && opts.flags) { | |||
| const options = Object.keys(opts.flags).reduce((accum, flag) => { | |||
| const o = opts.flags[flag]; | |||
There was a problem hiding this comment.
Use descriptive variable names.
| const option = { | ||
| flag: '', | ||
| value: '', | ||
| desc: '' |
There was a problem hiding this comment.
Suggested change
| desc: '' | |
| description: '' |
|
|
||
| option.flag += o.alias ? `-${o.alias}, ` : ' '.repeat(4); | ||
| option.flag += `--${flag === '--' ? '' : flag}`; | ||
| accum.flagMaxLen = Math.max(accum.flagMaxLen, option.flag.length); |
There was a problem hiding this comment.
Suggested change
| accum.flagMaxLen = Math.max(accum.flagMaxLen, option.flag.length); | |
| accum.flagMaxLength = Math.max(accum.flagMaxLength, option.flag.length); |
| t.deepEqual(cli.flags['--'], ['unicorn', 'cake']); | ||
| t.is(cli.pkg.name, 'meow'); | ||
| t.is(cli.help, indentString('\nCLI app helper\n\n-u, --unicorn <value> Unicorn name\n --meow [<value>] What to meow; default dog\n -- arg(s) option/arg separator', 2)); | ||
| }); |
There was a problem hiding this comment.
This feature needs a lot more tests.
| @@ -148,6 +150,13 @@ Default: `true` | |||
|
|
|||
| Automatically show the version text when the `--version` flag is present. Useful to set this value to `false` when a CLI manages child CLIs with their own version text. | |||
|
|
|||
| ##### autoHelpFlags | |||
There was a problem hiding this comment.
Not a big fan of this option name. Can you suggest some other alternatives?
| } else { | ||
| option.value = `${o.default ? '[' : ''}<value>${o.default ? ']' : ''}`; | ||
| } | ||
| accum.valMaxLen = Math.max(accum.valMaxLen, option.value.length); |
There was a problem hiding this comment.
Suggested change
| accum.valMaxLen = Math.max(accum.valMaxLen, option.value.length); | |
| accum.valueMaxLength = Math.max(accum.valueMaxLength, option.value.length); |
|
Closing for lack of response. |
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.
Automatically generate help for flags. Fixes #80.