A flag to display a list of available parameters

[alexeagle]

From @sebawita on December 4, 2017 18:50

Bug Report or Feature Request (mark with an x)

- [ ] bug report -> please search issues before submitting
- [x] feature request

Area

- [ ] devkit
- [x] schematics

Desired functionality

Currently the only way to check the available parameters for a schematics is by looking into its json schema file.
It would be great to have a way in the CLI to display the list of params, like this:
schematics @schematics:schematic --schema

Copied from original issue: angular/devkit#311

[alexeagle]

From @ssilvert on January 10, 2018 15:31

+1

It seems like the proper flag for this would be --help. Of course, --help is used for something else now, but perhaps schema help should be incorporated into that.

[Splaktar]

It would indeed be nice to give some helpful output rather than just a default message like this:

• schematics @schematics/angular:application --help

schematics [CollectionName:]SchematicName [options, ...]

By default, if the collection name is not specified, use the internal collection provided
by the Schematics CLI.

Options:
    --debug             Debug mode. This is true by default if the collection is a relative
                        path (in that case, turn off with --debug=false).
    --allowPrivate      Allow private schematics to be run from the command line. Default to
                        false.
    --dry-run           Do not output anything, but instead just show what actions would be
                        performed. Default to true if debug is also true.
    --force             Force overwriting files that would otherwise be an error.
    --list-schematics   List all schematics from the collection, by name.
    --verbose           Show more information.

    --help              Show this message.

Any additional option is passed to the Schematics depending on

[angular-robot]

Just a heads up that we kicked off a community voting process for your feature request. There are 20 days until the voting process ends.

Find more details about Angular's feature request process in our documentation.