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.

Sign up for GitHub

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

Jump to bottom

[TASK] use yargs group to set special command options aside from the generic ones #991

Closed
JoernBerkefeld opened this issue Jun 14, 2023 · 1 comment · Fixed by #996 or #1023
Closed

[TASK] use yargs group to set special command options aside from the generic ones #991

JoernBerkefeld opened this issue Jun 14, 2023 · 1 comment · Fixed by #996 or #1023
Assignees
@JoernBerkefeld
Labels
chore Jira issue-type "Task" NEW not yet analyzed new issues get this label
Milestone
5.2.0

Comments

@JoernBerkefeld
Copy link
Contributor

.group(key(s), groupName)
Given a key, or an array of keys, places options under an alternative heading when displaying usage instructions, e.g.,

require('yargs/yargs')(['--help'])
  .help()
  .group('batman', 'Heroes:')
  .describe('batman', "world's greatest detective")
  .wrap(null)
  .argv

Output:

Heroes:
  --batman  world's greatest detective

Options:
  --help  Show help  [boolean]
@JoernBerkefeld JoernBerkefeld added chore Jira issue-type "Task" NEW not yet analyzed new issues get this label labels Jun 14, 2023
@JoernBerkefeld JoernBerkefeld self-assigned this Jun 26, 2023
@JoernBerkefeld JoernBerkefeld added this to the 5.1.1 milestone Jun 26, 2023
JoernBerkefeld added a commit that referenced this issue Jun 26, 2023
@JoernBerkefeld
#991: group command-options in --help to make it easier to read
ab36858
@JoernBerkefeld JoernBerkefeld mentioned this issue Jun 26, 2023
Merged
4 tasks
@github-actions
Copy link

Closed by #996.

@JoernBerkefeld JoernBerkefeld linked a pull request Jun 26, 2023 that will close this issue
bugfix/991: group command-options in --help to make it easier to read #996
Merged
4 tasks
@JoernBerkefeld JoernBerkefeld modified the milestones: 5.2.1, 5.2.0 Jun 29, 2023
@JoernBerkefeld JoernBerkefeld mentioned this issue Jul 13, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JoernBerkefeld JoernBerkefeld

Labels
chore Jira issue-type "Task" NEW not yet analyzed new issues get this label
Projects
None yet
Milestone
5.2.0
1 participant
@JoernBerkefeld