feat: --show-hidden

[laggingreflex]

Adds a --show-hidden flag to show options defined with hidden: true property

Recap: (#962) Earlier, a fix was made to address the issue where .options({...}) without a description property did not show up up in --help. The fix introduced a new hidden: true property to truly hide an option from --help, and to show all other options (even without description property)

Issue with the fix: There was no way to show options defined with hidden:true property (they were hidden permanently)

Solution (this patch): This introduces a new flag: --show-hidden (pre-configured) which can be used to show those hidden options.

The default key for this new flag may also be custom configured with a new function property .showHidden('custom-show-hidden')

[Morishiri]

The code looks fine, but maybe you could write some UT for that?

[laggingreflex]

@Morishiri done

[bcoe]

this looks good to me 👍 but mind adding the showHidden method to the api docs?

[laggingreflex]

@bcoe done

[bcoe]

@gajus @laggingreflex @Morishiri thanks for the help landing this feature, sorry that it took so long to get over the finish line.

[kopax]

Hi, I was looking for such feature. I am using 11.0.0, I presume this have not been release yet right ?
When will it be?

[laggingreflex]

It's released in 11.1.0 but there seems to be an issue regarding latest npm release.

Try installing/setting 11.1.0 version manually.

[kopax]

@laggingreflex thanks, I have updated to 11.1.0.

I have the following options:

  .option('copyright-holder', {
    alias: 'c',
    describe: 'Change the default copyright-holder',
    hidden: true,
  })

Executing the cli with --help and --show-hidden did not work:

Options:
  --version   Show version number                                                          [boolean]
  --help      Show help                                                                    [boolean]

[laggingreflex]

You also need to execute .showHidden()

[kopax]

@laggingreflex so we must have this hidden program documented to everyone?
I rather not show some command to everyone, could be nice to have a .showHidden({ noHelp: true })

[laggingreflex]

@kopax I'm not sure I understand, could you please elaborate with an example.

[kopax]

@laggingreflex

Sure for example this use case:

I want to have a --change-copyright-holder options within a script. I am the only one who can do that, it's my license. I want to keep it hidden to everyone, using the hidden: true on my option, I can do it

I want to keep the --show-hidden for my self, doing .showHidden() will inform users of such hidden option.

[laggingreflex]

@kopax If I understand correctly, what you tried earlier should work. I.e. without .showHidden() --help should show neither --show-hidden nor --copyright. --help --show-hidden should show --copyright.

If that doesn't work, or it's not what you wanted, could you please open a new detailed issue, possibly with a reproduction repo and expected vs. actual outputs.