Commander.js中-h或help命令使用问题

Commander.js中-h或help命令使用问题

program.usage() 中出现index

问题描述 & 现象

在使用commandName -h命令时（这里的commandName是自己定义的执行命令的名称），打印的内容多出了一个index,但是在代码逻辑部分并没有index

Terminal 打印：

Usage: index <command>|<option> 命令使用规则

相关代码

program.usage('<command>|<option> 命令使用规则');

问题分析

经过分析，最直观的是发现上述代码中并没有index 内容，所以经过调试，查看usage的源码部分，到program的helpInfomation的分析发现是缺少了对总的命令进行命名

解决方案

设置commander命令对象的名称
在初始化引入commander的文件./bin/index.js中：

const program = require('commander');
//这里将名称定义在了package.json 文件中
program.name(require('../package').commandName);

或者

const commander = require('commander');
//这里将名称定义在了package.json 文件中
const program = new commander.Command(require('../package').commandName);

package.json

  "commandName":  "box",
  "bin": {
    "box": "./bin/index.js"
  },

请注意这两处的值，即commandName处与于bin处"box"需要对应,是命令的执行名称

此时，再执行命令

box -h

Terminal 打印：

Usage: box <command>|<option> 命令使用规则

此时，不再是无意义的index而是我们设置的命令名称，打印出的内容也即表明了执行自定命令的规则

源代码

//命令行
box -h
//终端打印
Usage: box <command>|<option> 命令使用规则

Options:
  -v, --version       output the version number//默认选项
  -h, --help          output usage information//默认选项

Commands://自定义的命令
  init|i <name>       init project,load data,need project name after init
  add|a <name>    add folder & select file type
  del|d <name>        delete command

command自定义命令打印多个参数

问题描述 & 现象

使用-h和help命令时，当定义了自定义命令的缩写命令时，打印的自定义命令显示了两个参数，并且参数显示的比较奇怪

Terminal 打印：

Commands://定义的命令
  del|d <name> <name>    delete command//name被打印两遍

相关代码

以下是自定义命令的代码：

program.command('del <name>')
.description('delete command')//描述
.alias('d <name>')//缩写
.action((name) => {
 /*
 逻辑
 */
});

问题分析

因为看打印结果可以明确看出是参数被多次打印，并且根据打印出的命令显示方式猜测参数不需要多次定义

解决方案

program.command('del <name>')
.description('delete command')//描述
.alias('d')//缩写 参数<name>无需再写一遍
.action((name) => {
  require('../****/*****')(name);//可以将命令中的参数传递到指定的问价中
});