ES 模块上的 Node.js yargs package

Question

Yargs example:

require('yargs')
  .scriptName("pirate-parser")
  .usage('$0 <cmd> [args]')
  .command('hello [name]', 'welcome ter yargs!', (yargs) => {
    yargs.positional('name', {
      type: 'string',
      default: 'Cambi',
      describe: 'the name to say hello to'
    })
  }, function (argv) {
    console.log('hello', argv.name, 'welcome to yargs!')
  })
  .help()
  .argv

how would I do this in ESM?

Thanks in advance

Answer 1

Yarg'spackage.json points import s at ./index.mjs which exports a YargsFactory rather than an instance as in the CommonJS module.

So we need not only to import yargs from 'yargs'; , but also to call yargs and pass it the process.argv to parse (slicing to remove the node exe and script paths).

import yargs from 'yargs/yargs';

yargs(process.argv.slice(2))
  .scriptName("pirate-parser")
  .usage('$0 <cmd> [args]')
  .command('hello [name]', 'welcome ter yargs!', (yargs) => {
    yargs.positional('name', {
      type: 'string',
      default: 'Cambi',
      describe: 'the name to say hello to'
    })
  }, (argv) => {
    console.log('hello', argv.name, 'welcome to yargs!')
  })
  .help()
  .argv

At least that worked for me.

Answer 2

All you need to do is change require to import .

import yargs from 'yargs'

yargs.scriptName("pirate-parser")
  .usage('$0 <cmd> [args]')
  .command('hello [name]', 'welcome ter yargs!', (yargs) => {
    yargs.positional('name', {
      type: 'string',
      default: 'Cambi',
      describe: 'the name to say hello to'
    })
  }, function (argv) {
    console.log('hello', argv.name, 'welcome to yargs!')
  })
  .help()
  .argv