A flag to display a list of available parameters

Open
#12,152 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
cli

Research direction

Start by tracing the schematics CLI entry point and how it reads each schematic's JSON schema. Run the proposed schematics @schematics:schematic --schema command while checking the existing CLI behavior. Done means the flag displays the available parameters for a schematic without requiring users to inspect its schema file.

Written by the indexing model from the issue text.

Description

area: @angular-devkit/schematics-cli feature feature: insufficient votes

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

Dominant language
TypeScript
Stars
27k
Forks
11.8k
Avg merge
16h 35m
Merged PRs (30d)
176

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from angular/angular-cli

All issues in angular/angular-cli

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.