Commander.js: [Question] How to get option name?

[huypvw]

From docs:

program
  .option('-d, --debug', 'output extra debugging')
  .option('-s, --small', 'small pizza size')
  .option('-p, --pizza-type <type>', 'flavour of pizza');

program.parse(process.argv);

const options = program.opts();
if (options.debug) console.log(options);
console.log('pizza details:');
if (options.small) console.log('- small pizza size');
if (options.pizzaType) console.log(`- ${options.pizzaType}`);

so, the question is how do know option pizza-type after parse will get from field pizzaType? Do commanderjs provide any function to get value pizzaType after bind option .option('-d, --debug', 'output extra debugging')?

Thanks!

[shadowspawn]

The simplest answer is that the README says:

Multi-word options such as "--template-engine" are camel-cased, becoming program.opts().templateEngine etc.

[shadowspawn]

For interest, there is a routine to get the property name, given an Option object.

program.option('-e, --example-of-long-option-name');
console.log(program.options[program.options.length - 1].attributeName());

const o = new Option('--camelCaseAlready');
console.log(o.attributeName());

$ node index.js
exampleOfLongOptionName
camelCaseAlready

[huypvw]

Thank you!

[huypvw]

@shadowspawn I use commanderjs with typescript and your resolution was not working.

[shadowspawn]

Oh ok. .attributeName() got left out of the declarations, but it is public and could be added.

For interest, are you likely to use it in production code, or just when exploring how Commander is working?

[huypvw]

I use for my project. Please update its @type, thanks!

[shadowspawn]

attributeName included in Commander v7.2.0.