Ярги помогают не отображать все параметры справки - PullRequest
0 голосов
/ 04 октября 2018

Я использую yargs , чтобы добавить параметры командной строки для аргументов, передаваемых в сценарий.Когда я запускаю команду справки вместе с именем скрипта, она не отображает справку для параметра add .

const yargs=require('yargs');
 const argv= yargs.command('add', 'ADD A NOTE TO A FILE', {
    title : {
        describe : 'title of the file',
        demand: 'true'
    }
})
.help()
.argv;




root# node mainFile_node.js --help
Options:
  --help     Show help                                                 [boolean]
  --version  Show version number

     node mainFile_node.js add
YARGS ARGV:-{ _: [ 'add' ], '$0': 'mainFile_node.js' }

Ответы [ 3 ]

0 голосов
/ 22 июля 2019
const yargs=require('yargs');
const argv= yargs.command('add', 'ADD A NOTE TO A FILE', {
    title : {
        describe : 'title of the file',
        demand: 'true'
    }
}).parse()   

в конце нужно добавить метод parse ().parse () также выполнит функцию-обработчик, если вы будете использовать ее в будущем.

или под кодом

console.log(yargs.argv) 

этот метод полезен, если вы не написали какой-либо код наваш файл, но вы работаете в командной строке.Допустим,

узел app.js add --title = "somthing" --help

, чтобы увидеть меню справки, вам нужно набрать console.log(yargs.argv) в файле.

0 голосов
/ 01 августа 2019
const yargs = require("yargs");

yargs.command({
  command: "add",
  describe: "Add new note",
  builder: {
    title: {
      // describe: 'note title',
      demandOption: true,
      type: "string"
    }
  },
  handler: function(argv) {
    console.log("My title: " + argv.title);
  }
});

yargs.parse();

Затем запустите в командной строке:

node filename.js add --title="title name"
0 голосов
/ 05 апреля 2019

Попробуйте с кодом ниже

const yargs = require("yargs")
yargs.command({
  command: 'add',
  describe: 'ADD A NOTE TO A FILE',
  handler: function(){
    console.log('Adding to a file')
  }
})

Затем выполните с командой ниже

root# node mainFile_node.js --help
...