Please check if your PR fulfills the following requirements:
[ ] Docs have been reviewed and added / updated if needed (for bug fixes / features)
[x] Build (npm run build) was run locally and any changes were pushed
[x] Tests (npm test) were run locally and passed
[x] Prettier (npm run prettier) was run locally and passed
Pull request type
Please check the type of change your PR introduces:
- [ ] Bugfix
- [x] Feature
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] Documentation content changes
- [ ] Other (please describe):
## What is the current behavior?
GitHub Issue Number: N/A
What is the new behavior?
this commit adds additional runtime information to using the CLI. it adds additional flag information under the --help flag at runtime. it also expounds on using a custom starter in the README
Does this introduce a breaking change?
[ ] Yes
[x] No
Testing
Built locally and ran:
node index.js -- --help
This CLI has two operation modes, interactive and command mode.
Interactive Mode Usage:
npm init stencil
Command Mode Usage:
npm init stencil [starter] [project-name]
General Use Flags:
--help - show usage examples for the CLI
--info - print the current version of the CLI
Additional Information: https://github.com/ionic-team/create-stencil
Other information
At some point, I think it'd be nice to add some better CLI arg handling (perhaps we actually pull in a real library?). For now, I think this helps us a bit in terms of feature parity between the README, the help command, and what the CLI can actualy do
Pull request checklist
Please check if your PR fulfills the following requirements:
npm run build) was run locally and any changes were pushednpm test) were run locally and passednpm run prettier) was run locally and passedPull request type
Please check the type of change your PR introduces: - [ ] Bugfix - [x] Feature - [ ] Refactoring (no functional changes, no api changes) - [ ] Build related changes - [ ] Documentation content changes - [ ] Other (please describe): ## What is the current behavior?GitHub Issue Number: N/A
What is the new behavior?
this commit adds additional runtime information to using the CLI. it adds additional flag information under the
--helpflag at runtime. it also expounds on using a custom starter in the READMEDoes this introduce a breaking change?
Testing
Built locally and ran:
Other information
At some point, I think it'd be nice to add some better CLI arg handling (perhaps we actually pull in a real library?). For now, I think this helps us a bit in terms of feature parity between the README, the help command, and what the CLI can actualy do