commander的option事件不执行

qq_14820093

已于 2024-01-30 17:42:06 修改

阅读量493

点赞数 3

文章标签： node.js 前端 javascript

于 2024-01-30 17:40:03 首次发布

本文链接：https://blog.csdn.net/qq_14820093/article/details/135936154

版权

一、问题现象说明：

1. 问题描述：

commander 的 option 事件不执行；

2. 问题现象：

安装 commander 的 11.1.0版本

npm i commander@11.1.0

二、问题原因：

program.on("option: target-path", function(){
  console.log("target path test");
});

option:后面不能加空格，加了空格，这个命令就监听不到了。

三、解决方案

去掉 option冒号后面的空格就可以了，如下所示：

program.on("option:target-path", function(){
  console.log("target path test");
});

四、复现上述问题的完整步骤

1. 创建项目test-cli

mkdir test-cli-commander

2. 初始化项目test-cli-commander

cd test-cli-commander
npm init

3. 安装 commander 依赖包版本11.1.0

npm i --save-dev commander@11.1.0

4. 添加入口文件 bin/index.js 并添加如下代码

#! /usr/bin/env node

const commander  = require("commander");
const program = new commander.Command();

program
  .name("test-cli") 
  .usage("<command> [options]")
  .version("1.0.0")
  .option("-tp, --target-path <target-path>", "Whether to specify a local debug file path?", "");
  
program
  .command("init [projectName]")
  .option("-f, --force", "Whether to force  to init the program? ")
  .action(function (projectName, cmdObj, program)  {
  //console.log("init 的回调");
})

program.on("option: target-path", function(){
  console.log("target path test");
});

program.parse(process.argv);

5. 在package.json 中添加脚手架命令 test-cli 的配置；

{
  "name": "test-cli-commander",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "bin": {
    "test-cli": "bin/index.js"
  },
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "commander": "^11.1.0"
  }
}

6. 执行npm link本地调试脚手架文件；

npm link

7. 执行脚手架命令 test-cli 查看现象；

上述执行现象可以看到没有返回 target-path 的option事件中的打印文字 “target path test”；

8. 问题解决之后的完整代码如下：

#! /usr/bin/env node

const commander  = require("commander");
const program = new commander.Command();

program
  .name("test-cli") 
  .usage("<command> [options]")
  .version("1.0.0")
  .option("-tp, --target-path <target-path>", "Whether to specify a local debug file path?", "");
  
program
  .command("init [projectName]")
  .option("-f, --force", "Whether to force  to init the program? ")
  .action(function (projectName, cmdObj, program)  {
//   console.log("init 的回调");
})

program.on("option:target-path", function(){
  console.log("target path test");
});

program.parse(process.argv);