How to implement multiple subcommands with Yargs?

Question

I've been trying and trying, but just couldn't digest Yargs' docs.

I need to create a set of commands/subcommands:

~$framework generate routed-module ModuleOne ModuleTwo ModuleThree --animation-style=bounce-up

//would call a handler with:
{ modules: string[], options: {animationStyle?: AnimationStyle}}
type AnimationStyle = 'bounce-up' | 'slide-left'

or

~$framework generate stateful-ui ModuleOne ModuleTwo ModuleThree
//would call a handler with:
{ modules: string[]}

or

~$framework init
//would just call a handler

I'd like aliases: g for generate, r for routed-module, s for stateful-ui.

Autocompletion would be nice.

Here's what I've tried, don't know where to go from here:

  yargs
    .scriptName('elm-framework')
    .command({
      command: 'generate [moduleType] [moduleNames]',
      aliases: ['g'],
      describe: 'Generates a resource',
      handler: config.handleModuleGeneration,
      builder: {
        moduleType: {
          demand: true,
          choices: ['routed', 'stateful'] as const,
          default: 'routed',
        },
        moduleNames: {
          demand: true,
          array: true,
        },
      },
    })

Thanx!

(Doing this with typescript is not necessary. I primarily want to understand how to use the library's api.)

have look at github.com/yargs/yargs/blob/master/docs/examples.md — Sohan
– Sohan, Commented Jan 24, 2020 at 13:07

Daniel Birowsky Popeski · Accepted Answer · 2020-01-24 20:30:25Z

5

Figured it out using this crucial piece of documentation:

  yargs
    .scriptName('framework')
    .command({
      command: 'generate [moduleType] [moduleNames...]',
      aliases: ['g'],
      describe: 'Generates a resource',
      handler: parsed => console.log('your handler goes here', parsed),
      builder: {
        moduleType: {
          demand: true,
          choices: ['routed', 'stateful'] as const,
          default: 'routed',
        },
        moduleNames: {
          demand: true,
          array: true,
        },
      },
    }).parse(process.argv.slice(2))

edited Jan 24, 2020 at 20:30

answered Jan 24, 2020 at 15:02

Daniel Birowsky Popeski

9,39414 gold badges73 silver badges139 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

David · Accepted Answer · 2021-05-28 19:52:15Z

5

To me, the best way to achieve this was following this Github issue, specifically what suggested in this comment. (another builder nested inside the command builder).

The issue with using the suggestion above ('generate [moduleType] [moduleNames...]') is that you can't use different flags for different sub-commands.

answered May 28, 2021 at 19:52

David

2,7561 gold badge28 silver badges31 bronze badges

Collectives™ on Stack Overflow

How to implement multiple subcommands with Yargs?

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related