Command flag deprecated not well documented

[xmedeko]

yargs can mark command as deprecated. However, it's not documented and it may be tricky.

Documentation

Positional and object arguments are described neither in https://yargs.js.org/docs/#api-reference-commandcmd-desc-builder-handler nor in https://github.com/yargs/yargs/blob/main/docs/advanced.md#commands The deprecated and middleware options are missing completely. It would be nice to have same doc like for the options https://yargs.js.org/docs/#api-reference-optionkey-opt

Usage

Object parameter is working OK:

.command({command: 'cmd', description: 'Do command', deprecated: true})

(Just .options() takes also deprecate property, too)

Positional argument is necessary to specify as:

.command('cmd', 'Do command', {}, () => {}, [], true)

Because neither of these is working:

.command('cmd', 'Do command', true) // Error: Invalid third argument. Expected function or object but received boolean.
.command('cmd', 'Do command', undefined, undefined, undefined, true) // Error: TypeError: t.map is not a function

[shadowspawn]

Related: #1518 #1559 #1624