Node.js CLI工具开发完全指南

命令行工具(CLI)是开发者日常工作中不可或缺的利器。本文将带你从零开始，使用Node.js开发一个功能完整的CLI工具。

1. 为什么选择Node.js开发CLI？

• 跨平台支持
• 丰富的npm生态
• JavaScript语法简单易学
• 适合自动化任务和工具链开发

2. 快速开始

使用commander.js创建CLI

首先安装commander.js:

npm install commander

创建一个简单的CLI工具示例:

#!/usr/bin/env node
const { program } = require('commander');

program
  .name('my-cli')
  .description('一个简单的CLI工具')
  .version('1.0.0');

program.command('greet <name>')
  .description('向某人问好')
  .action((name) => {
    console.log(`你好, ${name}!`);
  });

program.parse();

在package.json中添加bin字段:

{
  "bin": {
    "my-cli": "cli.js"
  }
}

3. 本地调试

3.1 使用npm link

1. 在CLI项目目录下运行：

npm link

2. 这会在全局node_modules中创建一个符号链接指向你的项目
3. 现在可以在任何地方直接运行你的CLI命令

取消npm link

当不再需要本地链接时，可以取消链接：

1. 在CLI项目目录下运行：

npm unlink

2. 或者在全局node_modules中取消链接：

npm unlink -g your-package-name

注意事项：

• 取消链接后，全局命令将不再可用
• 如果遇到权限问题，可能需要使用管理员权限运行
• 取消链接不会删除项目文件，只会移除符号链接

3.2 使用npm pack

npm pack是另一种本地调试方法，它会创建一个.tgz安装包，更接近真实发布环境：

1. 在项目根目录运行：

npm pack

2. 这会生成一个.tgz文件（如my-cli-1.0.0.tgz）
3. 在测试项目中安装本地包：

npm install /path/to/your-package.tgz

4. 测试CLI功能是否正常

与npm link相比，npm pack的优势：

• 更接近真实发布环境
• 可以测试安装包生成过程
• 避免符号链接可能带来的问题

3.3 调试技巧

• 使用console.log()输出调试信息
• 添加--debug参数启用详细日志
• 使用Node.js内置调试器：

node inspect your-cli.js

3.4 常见问题排查

• 权限问题：确保CLI文件有可执行权限
• 路径问题：检查package.json中的bin字段配置是否正确
• 依赖问题：确保所有依赖已正确安装
• 包问题：使用npm ls检查依赖树

4. 发布你的CLI工具

1. 确保你的工具在本地测试通过
2. 创建npm账号(如果没有)
3. 运行npm publish发布
4. 用户可以通过npm install -g your-cli-name全局安装

4. 高级功能

• 添加颜色输出(chalk库)
• 显示进度条(ora库)
• 交互式提示(inquirer库)
• 文件操作(fs-extra库)