Skip to content

Help- and version option description not shown #1820

@OsmanAltun

Description

@OsmanAltun

The code:

const yargs = require('yargs').locale('en')

let output

const options = {
    exec: { alias: 'e', desc: 'Dis supposed to be exec', type: 'string', requiresArg: true },
    h: { alias: 'help', desc: 'Dis supposed to be help' },
    v: { alias: 'version', desc: 'Dis supposed to be version' }
}

yargs.options(options)

yargs.parse(['--help'], (_err, _argv, _output) => { output = _output })

console.log(output)

Expected output:

Options:
  -e, --exec      Dis supposed to be exec                                [string]
  -h, --help      Dis supposed to be help                                [boolean]
  -v, --version  Dis supposed to be version                              [boolean]

Actual output:

Options:
  -e, --exec     Dis supposed to be exec                                [string]
  -h, --help     Show help                                             [boolean]
  -v, --version  Show version number                                   [boolean]

Note
No need for a workaround since I already got one, but I just wanted to mention this so it would get fixed.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions