Implement help as a plugin to show detailed command help
Open
Nobody has claimed this yet.
feat
- Dominant language
- JavaScript
- Stars
- 1.9k
- Forks
- 51
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 1
Description
Branching off from #101. It would be cool to implement shx help as a ShellJS plugin, and let this show help output at a finer granularity:
$ shx help ls
Usage: ls [option]... [file]...
-l use a long listing format
...
$ shx help cp
...
Not sure if there's a good way to do this right now without parsing ShellJS docs. But we could certainly support
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 by reviewing the relationship to issue #101 and the current shx command and plugin entry points. Determine how command-specific help can be exposed without parsing ShellJS documentation, then define completion as shx help <command> producing detailed usage output for supported commands.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, node.js
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100