feat(schematics): Generate --help for every CLI function. #417
Conversation
mrmeku
force-pushed
the
help
branch
2 times, most recently
from
f01ce09 to
0655f5d
Compare
| .alias('update', 'migrates') // TODO: Remove after 1.0 | ||
| .command( | ||
| 'lint [files..]', | ||
| 'Line workspace or set of files', |
There was a problem hiding this comment.
Is this supposed to be "Lint workspace or...:" instead of "Line"?
| '-- files="<file,list>"', | ||
| 'Targets a comma delimited list of files' | ||
| ) | ||
| .command('-- --uncommitted', 'Targets uncommited changes') |
There was a problem hiding this comment.
uncommitted spelling in description
| .command( | ||
| '<action> -- files="<file,list>"', | ||
| 'Targets a comma delimited list of files' | ||
| ) |
There was a problem hiding this comment.
The files example wraps in my terminal (not sure if that is something you can adjust or not...)
Commands:
nx affected <action> -- <SHA1 SHA2> Targets within a range of SHAs
nx affected <action> -- Targets a comma delimited list of
files="<file,list>" files
nx affected <action> -- --uncommitted Targets uncommited changes
nx affected <action> -- --untracked Targets untracked changes
nx affected dep-graph Generate a graph showing links
between targets
| .command( | ||
| // TODO: delete this after 1.0 | ||
| 'update <check|skip>', | ||
| 'Migrate to the latest version of NX', |
| format(args); | ||
| } | ||
| ) | ||
| .command( |
There was a problem hiding this comment.
I think we want to move away from using the migrate terminology. So maybe update the terms in the descriptions in here to be update, updates instead of migrate, migrations.
| .demandCommand() | ||
| .demand('file') | ||
| .demand('output') | ||
| .choices('output', [ |
There was a problem hiding this comment.
Should there be some documentation for using this?
| ) | ||
| .command( | ||
| 'workspace-schematic <name>', | ||
| 'Generate a schematic `ng g <name>`', |
There was a problem hiding this comment.
Maybe a bit more descriptive for this line?:
Generate a custom schematic that can be run via `ng g <name>`
mrmeku
force-pushed
the
help
branch
6 times, most recently
from
1b2b920 to
3e7ba25
Compare
This PR introduces the yargs package as our CLI command handler. We build up commands using yargs to take advantage of its built in --help flag formatter.
|
This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request. |
This PR introduces the
yargspackage as our CLI command handler.We build up commands using
yargsto take advantage of its builtin
--helpflag formatter.