NativeScript / NativeScript/nativescript-cli
Document all hooks and how to use them
Open
Nobody has claimed this yet.
docs
hooks
- Dominant language
- JavaScript
- Stars
- 1.1k
- Forks
- 204
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 8
Description
Did you verify this is a real problem by searching Stack Overflow and the other open issues in this repo?
Yes, the current hooks documentation does not describe all hooks and use-cases. Also the link in https://github.com/NativeScript/nativescript-cli/blob/master/README.md#extending-the-cli is broken.
Tell us about the problem
We need to document all hooks for CLI and how the plugins and users can get benefit of them.
Tasks:
- Fix the link in https://github.com/NativeScript/nativescript-cli/blob/master/README.md#extending-the-cli
- Document all hooks and when they are executed.
- Describe how to use the hooks and add examples.
- Add tests that verify the examples in the previous step work correctly and will not be broken in future release.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the CLI README's “Extending the CLI” section and its broken link. Inventory the hooks and their execution points, then document their use and examples for plugins and users. Add tests that exercise the documented examples and confirm they continue to work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100