Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

--help should list options #101

Closed
binki opened this issue Nov 22, 2016 · 2 comments
Closed

--help should list options #101

binki opened this issue Nov 22, 2016 · 2 comments
Assignees

Comments

@binki
Copy link

binki commented Nov 22, 2016

If I run shx -h I don’t see, for example, documentation about --noglob. It’d be helpful if that was documented there for.

I tested in a1faf54 (v0.2.1) and it doesn’t appear to be there.

@nfischer
Copy link
Member

Yeah, this would probably be a good thing to add support for here. We should modify the help string to start with a header like

Usage: shx [shx-options] <command> [cmd-options]

and explain what those two different types of options are. Then we can iterate over shell.config's properties to show all the shx-options.

We might want to eventually implement help as a ShellJS plugin, so that it can take command names as arguments. Then we can have shx help cp show all of cp's supported cmd-options, similar to how cash's help command works.

@nfischer
Copy link
Member

For this issue, let's aim for the following:

  • change the help string header like I described
  • add a section in the help output to list shx-options such as --noglob, --silent, --verbose, etc.

This should be a reasonable community contribution if someone wants to try it. We'll leave the rest for future work.

@nfischer nfischer self-assigned this Jul 4, 2018
nfischer added a commit that referenced this issue Jul 4, 2018
This adds an 'shx-options' section the help output, covering options
such as --fatal, --silent, etc.

This also reformats existing help text slightly.

Fixes #101
nfischer added a commit that referenced this issue Jul 10, 2018
This adds an 'shx-options' section the help output, covering options
such as --fatal, --silent, etc.

This also reformats existing help text slightly.

Fixes #101
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants