feature: add method to hide option extras #2156

jly36963 · 2022-03-27T16:57:53Z

Addresses: #2153

Description

Given the following:

yargs('cmd1 --help')
  .command(
    'cmd1',
    'cmd1 desc',
    yargs => yargs
      .option('opt1', {
        type: 'string',
        choices: ['foo', 'bar', 'baz'],
        alias: 'o',
        required: true,
        description: "A long description that might break formatting"
      }),
    argv => console.log(argv)
  )
  .hideOptionExtras()
  .strict()
  .parse()

The hideOptionExtras would cause the following output

cmd1 desc

Options:
      --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]
  -o, --opt1     A long description that might break formatting
                              [string] [required] [choices: "foo", "bar", "baz"]

to look like this instead

cmd1 desc

Options:
      --help     Show help
      --version  Show version number
  -o, --opt1     A long description that might break formatting

Questions

If this works, I'll add unit tests.
What other things would need to change? (docs, examples, etc)

bcoe

I'm worried about adding one off functions to tweak yargs' default layout. What if instead we did something like we did with parserConfiguration. Add a helper usageConfiguration, which we can gradually add more layout options to:

yargs.usageConfiguration({
  'show-types': false
})

bcoe

@jly36963 this is great work, thank you 👏

One ask, would it be possible to add this setting in the list here: https://github.com/yargs/yargs/blob/main/docs/api.md#parserconfigurationobj

bcoe

Love this. I think usageConfiguration will help us provide nuanced configuration without adding 1,000,000 additional methods.

ljharb · 2023-01-29T16:13:06Z

I’m a bit confused; how can i show types in general, but hide types for an a specific option?

jly36963 · 2023-01-29T16:59:49Z

@ljharb I don't think there is a way currently. It would likely be a new property on option/positional objects like hideUsageTypes, or potentially a refactor on the usage logic to allow for customizations.

I won't be involved with this package much in the future, so I won't be much help in implementing this change

ljharb · 2023-01-29T21:48:54Z

In that case, this does not solve #1145, thanks for confirming.

| datasource | package | from | to | | ---------- | ------------ | ------ | ------- | | npm | yargs | 17.6.0 | 17.7.2 | | npm | @types/yargs | 16.0.0 | 17.0.33 | ##### [\`v17.7.2\`](https://github.com/yargs/yargs/blob/HEAD/CHANGELOG.md#1772-2023-04-27) ##### Bug Fixes - do not crash completion when having negated options ([#2322](yargs/yargs#2322)) ([7f42848](yargs/yargs@7f42848)) ##### [\`v17.7.1\`](https://github.com/yargs/yargs/blob/HEAD/CHANGELOG.md#1771-2023-02-21) ##### Bug Fixes - address display bug with default sub-commands ([#2303](yargs/yargs#2303)) ([9aa2490](yargs/yargs@9aa2490)) ##### [\`v17.7.0\`](https://github.com/yargs/yargs/blob/HEAD/CHANGELOG.md#1770-2023-02-13) ##### Features - add method to hide option extras ([#2156](yargs/yargs#2156)) ([2c144c4](yargs/yargs@2c144c4)) - convert line break to whitespace for the description of the option ([#2271](yargs/yargs#2271)) ([4cb41dc](yargs/yargs@4cb41dc)) ##### Bug Fixes - copy the description of the option to its alias in completion ([#2269](yargs/yargs#2269)) ([f37ee6f](yargs/yargs@f37ee6f)) ##### [\`v17.6.2\`](https://github.com/yargs/yargs/blob/HEAD/CHANGELOG.md#1762-2022-11-03) ##### Bug Fixes - **deps:** update dependency yargs-parser to v21.1.1 ([#2231](yargs/yargs#2231)) ([75b4d52](yargs/yargs@75b4d52)) - **lang:** typo in Finnish unknown argument singular form ([#2222](yargs/yargs#2222)) ([a6dfd0a](yargs/yargs@a6dfd0a)) ##### [\`v17.6.1\`](https://github.com/yargs/yargs/blob/HEAD/CHANGELOG.md#1761-2022-11-02) ##### Bug Fixes - **lang:** fix "Not enough non-option arguments" message for the Czech language ([#2242](yargs/yargs#2242)) ([3987b13](yargs/yargs@3987b13))

| datasource | package | from | to | | ---------- | ------------ | ------ | ------- | | npm | yargs | 17.6.0 | 17.7.2 | | npm | @types/yargs | 16.0.0 | 17.0.33 | ## [v17.7.2](https://github.com/yargs/yargs/blob/HEAD/CHANGELOG.md#1772-2023-04-27) ##### Bug Fixes - do not crash completion when having negated options ([#2322](yargs/yargs#2322)) ([7f42848](yargs/yargs@7f42848)) ## [v17.7.1](https://github.com/yargs/yargs/blob/HEAD/CHANGELOG.md#1771-2023-02-21) ##### Bug Fixes - address display bug with default sub-commands ([#2303](yargs/yargs#2303)) ([9aa2490](yargs/yargs@9aa2490)) ## [v17.7.0](https://github.com/yargs/yargs/blob/HEAD/CHANGELOG.md#1770-2023-02-13) ##### Features - add method to hide option extras ([#2156](yargs/yargs#2156)) ([2c144c4](yargs/yargs@2c144c4)) - convert line break to whitespace for the description of the option ([#2271](yargs/yargs#2271)) ([4cb41dc](yargs/yargs@4cb41dc)) ##### Bug Fixes - copy the description of the option to its alias in completion ([#2269](yargs/yargs#2269)) ([f37ee6f](yargs/yargs@f37ee6f)) ## [v17.6.2](https://github.com/yargs/yargs/blob/HEAD/CHANGELOG.md#1762-2022-11-03) ##### Bug Fixes - **deps:** update dependency yargs-parser to v21.1.1 ([#2231](yargs/yargs#2231)) ([75b4d52](yargs/yargs@75b4d52)) - **lang:** typo in Finnish unknown argument singular form ([#2222](yargs/yargs#2222)) ([a6dfd0a](yargs/yargs@a6dfd0a)) ## [v17.6.1](https://github.com/yargs/yargs/blob/HEAD/CHANGELOG.md#1761-2022-11-02) ##### Bug Fixes - **lang:** fix "Not enough non-option arguments" message for the Czech language ([#2242](yargs/yargs#2242)) ([3987b13](yargs/yargs@3987b13))

Add method to hide option extras

83e5317

jly36963 requested a review from bcoe March 27, 2022 16:59

bcoe requested changes Mar 28, 2022

View reviewed changes

jly36963 added 4 commits March 29, 2022 20:46

fixes

c13f2de

spelling

1b31785

remove comment

8cb2dd2

cleanup

92ab0ca

jly36963 requested a review from bcoe March 30, 2022 02:57

jly36963 and others added 2 commits March 29, 2022 21:02

console log

4e313ff

Merge branch 'main' into hide-option-extras

b32ef96

bcoe requested changes May 14, 2022

View reviewed changes

jly36963 added 2 commits May 14, 2022 15:57

Merge branch 'main' into hide-option-extras

b6b15d5

Merge branch 'main' into hide-option-extras

798148c

i-siso mentioned this pull request Oct 4, 2022

Can I prevent yargs .describe feature from showing auto-generated info about type, default, etc? #2153

Closed

bcoe approved these changes Oct 5, 2022

View reviewed changes

bcoe approved these changes Dec 28, 2022

View reviewed changes

Merge branch 'main' into hide-option-extras

bbdae8a

bcoe merged commit 2c144c4 into yargs:main Dec 28, 2022

github-actions bot mentioned this pull request Dec 28, 2022

chore(main): release 17.7.0 #2285

Merged

06000208 mentioned this pull request Jan 29, 2023

[Feature Request] Hide default value and flag type #1145

Closed

ljharb mentioned this pull request Feb 13, 2023

[feature request] hide default value and flag type on individual option #2299

Open

seansund mentioned this pull request May 24, 2024

[Snyk] Upgrade yargs from 17.5.1 to 17.7.2 cloud-native-toolkit/ibm-garage-cloud-cli#646

Open

NOUIY mentioned this pull request May 25, 2024

[Snyk] Upgrade yargs from 17.3.1 to 17.7.2 NOUIY/security-wg#54

Closed

This was referenced Jun 20, 2024

[Snyk] Upgrade yargs from 13.2.4 to 17.7.2 YoutacRandS-VA/focus-dt#3

Open

[Snyk] Upgrade yargs from 8.0.2 to 17.7.2 YoutacRandS-VA/brotli#1

Open

rsaz mentioned this pull request Jul 6, 2024

[Snyk] Upgrade yargs from 17.6.2 to 17.7.2 expressots/expressots-cli#50

Merged

LasaKaru mentioned this pull request Aug 2, 2024

[Snyk] Upgrade yargs from 17.6.2 to 17.7.2 LasaKaru/phoenix-bonds#3

Open

shadowspawn mentioned this pull request Aug 12, 2024

[Question] How do I remove [boolean] from the default help description? #792

Open

PavinStrickland mentioned this pull request Aug 19, 2024

[Snyk] Upgrade yargs from 16.2.0 to 17.7.2 PavinStrickland/compat-table#2

Open

nurrony mentioned this pull request Aug 30, 2024

[Snyk] Upgrade yargs from 7.1.0 to 17.7.2 nurrony/gtni#158

Open

nurrony mentioned this pull request Sep 8, 2024

[Snyk] Upgrade: , async-each, git-url-parse, ora, path-exists, shelljs, yargs nurrony/gtni#161

Open

seansund mentioned this pull request Sep 8, 2024

[Snyk] Upgrade: tslib, rxjs, yargs, tar, follow-redirects, inquirer, open, openshift-rest-client cloud-native-toolkit/ibm-garage-cloud-cli#649

Open

This was referenced Sep 12, 2024

[Snyk] Upgrade: , async-each, git-url-parse, ora, path-exists, shelljs, yargs nurrony/gtni#162

Open

[Snyk] Upgrade: , async-each, git-url-parse, ora, path-exists, shelljs, yargs nurrony/gtni#163

Open

seansund mentioned this pull request Sep 14, 2024

[Snyk] Upgrade: tslib, rxjs, yargs, tar, follow-redirects, inquirer, open, openshift-rest-client cloud-native-toolkit/ibm-garage-cloud-cli#650

Open

nurrony mentioned this pull request Sep 16, 2024

[Snyk] Upgrade: , async-each, git-url-parse, ora, path-exists, shelljs, yargs nurrony/gtni#164

Open

dasunhegoda mentioned this pull request Sep 17, 2024

[Snyk] Upgrade: , yargs OpenSPP/openfn-adaptors#52

Open

Mustafaovais mentioned this pull request Sep 22, 2024

[Snyk] Upgrade: , , dotenv, ethers, yargs Mustafaovais/wormhole#3

Open

snyk-io bot mentioned this pull request Sep 23, 2024

[Snyk] Upgrade yargs from 7.1.2 to 17.7.2 SherfeyInv/etherchain-light#6

Open

AeonArriving mentioned this pull request Sep 30, 2024

[Snyk] Upgrade yargs from 17.6.2 to 17.7.2 AeonArriving/audit-ci#4

Open

HaLaGu1L mentioned this pull request Nov 3, 2024

[Snyk] Upgrade yargs from 12.0.5 to 17.7.2 HaLaGu1L/bitcoin-token-smart-contracts#2

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feature: add method to hide option extras #2156

feature: add method to hide option extras #2156

jly36963 commented Mar 27, 2022 •

edited

Loading

Uh oh!

bcoe left a comment

Uh oh!

bcoe left a comment

Uh oh!

bcoe left a comment

Uh oh!

ljharb commented Jan 29, 2023

Uh oh!

jly36963 commented Jan 29, 2023

Uh oh!

ljharb commented Jan 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feature: add method to hide option extras #2156

feature: add method to hide option extras #2156

Conversation

jly36963 commented Mar 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Questions

Uh oh!

bcoe left a comment

Choose a reason for hiding this comment

Uh oh!

bcoe left a comment

Choose a reason for hiding this comment

Uh oh!

bcoe left a comment

Choose a reason for hiding this comment

Uh oh!

ljharb commented Jan 29, 2023

Uh oh!

jly36963 commented Jan 29, 2023

Uh oh!

ljharb commented Jan 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jly36963 commented Mar 27, 2022 •

edited

Loading