Skip to content

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

@BadIdeaException

Description

@BadIdeaException

When using yargs .describe method to generate usage information, is there some way to prevent yargs from auto-adding information about type, default value, choices etc.?

I.e. the following

        .option('foo', {
            type: 'string',
            choices: ['bar','baz'],
            required: true,
            default: 'bar',
            description: 'The most important option of all'
        })

results in this output when doing --help:

--foo      The most important option of all      [string] [required] [choices: "bar", "baz"] [default: "bar"]

I have to confess I find that to be a bit ugly, and it is out of line with how help texts are generally formatted in linux. Also, on longer description texts that include line breaks, it breaks formatting.

I haven't found anything in the docs. Is there some way to suppress generation of the bracketed [] parts, without having to completely give up using the describe feature?

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions