Poll: check for more usage errors #1978

Activity

1. shadowspawn commented on Aug 23, 2023

   

   shadowspawn

   on Aug 23, 2023

   Last edited by shadowspawn

   CollaboratorAuthor

   More actions

   1. Calling program.parse() when an action handler or hook is async . Should be calling program.parseAsync() if any action handler or hook is async.

   Note: this error can not be detected except during parsing, so may not show up on all calls.

   program
      .action(async() => { console.log('async'); })
   
   program.parse(); // oops, should be `program.parseAsync()`
   

   👍React with 👍2Reacted by aweebit and DivisionByZero
2. shadowspawn commented on Aug 23, 2023

   

   shadowspawn

   on Aug 23, 2023

   Last edited by shadowspawn

   CollaboratorAuthor

   More actions

   2. Adding options with overlapping flags.

   program
      .option('-p, --print')
      .option('-p, --port'); // oops, already using '-p'
   

   👍React with 👍3Reacted by Abe Tomoaki, aweebit and DivisionByZero
3. shadowspawn commented on Aug 23, 2023

   

   shadowspawn

   on Aug 23, 2023

   CollaboratorAuthor

   More actions

   3. Adding commands with overlapping names.

   program.command('runnable')
      .alias('run')
      // more configuration
   
   program.command('run') // oops, already using 'run'
      // more configuration
   

   👍React with 👍3Reacted by Abe Tomoaki, aweebit and DivisionByZero
4. shadowspawn commented on Aug 23, 2023

   

   shadowspawn

   on Aug 23, 2023

   Last edited by shadowspawn

   CollaboratorAuthor

   More actions

   4. Calling .parse() more than once. Parse leaves behind state, so the intention is make a new program for every parse.

   program.parse(['--port', '80'], { from: 'user' });
   assert_deep_equal(program.opts(), { port: 80 });
   program.parse(['--name', 'foo'], { from: 'user' });
   assert_deep_equal(program.opts(), { name: 'foo' }); // oops, also has port from first parse
   

   👍React with 👍1Reacted by aweebit
5. shadowspawn commented on Aug 23, 2023

   

   shadowspawn

   on Aug 23, 2023

   Last edited by shadowspawn

   CollaboratorAuthor

   More actions

   5. Calling .parse() on a subcommand.

   This isn't technically wrong, but probably a mistake.

   program.command('sub')
      .action(() => { console.log('Thanks for calling subcommand'); })
      .parse(); // oops, should be calling `program.parse()`
   

   👍React with 👍1Reacted by aweebit
6. shadowspawn

   pinned this issue on Aug 23, 2023
7. shadowspawn commented on Aug 24, 2023

   

   shadowspawn

   on Aug 24, 2023

   Last edited by shadowspawn

   CollaboratorAuthor

   More actions

   6. Enforce format of option flags.

   program
      .option('-en', '--environment') // oops, short option should be a single character
      .option('-h, -?, --help'); // oops, short or long or both, but not more than one of each
   

   👍React with 👍1Reacted by aweebit
8. shadowspawn

   unpinned this issue on Jan 20, 2024
9. shadowspawn commented on Jan 20, 2024

   

   shadowspawn

   on Jan 20, 2024

   CollaboratorAuthor

   More actions

   Not much feedback on this. Numbers at 21 Jan 2024: 2 3 3 1 1 1

   Adding check for conflicting commands (#2059) and options (#2055) in Command v12.
10. shadowspawn

    closed this as completedon Jan 20, 2024