用 Node.js 开发命令行工具

03 Jul 2016

假设我们要开发一个 hacker 命令，在 shell 中运行 hacker 命令的效果：

hacker
> Hello, hacker!

首先初始化一个 npm 项目：

npm init

新建一个 index.js，内容如下：

#!/usr/bin/env node
console.log('Hello, hacker!');

第一行称作：shebang，用来告诉 shell 该如何执行该脚本。

然后告诉 npm 你的命令是啥以及去哪里找可执行脚本。修改 package.json，添加一个 bin 属性，如下：

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

键 commandName 就是在 shell 中使用的命令。值是相对于 package.json 文件的路径。

全局安装之后就可以使用了：

npm install -g

npm install -g 会将脚本链接到 PATH 的某个目录

$ which hakcer
> /usr/local/bin/hacker
$ readlink /usr/local/bin/hacker
> ../lib/node_modules/hacker/index.js

在开发阶段，使用 npm link 更方便些。

处理命令行参数

最简单的可以通过 process.argv。也可以使用一些封装好的包，例如：

其中 yargs 不仅可以用来处理命令行参数，它还可以：

另一种从用户获取内容的方式是从标准输入读取。简单的可以使用 process.stdin。同样可以使用一些封装好的包，例如：

根据 Unix 传统，程序执行成功返回 0，否则返回 1 。

if (err) {
  process.exit(1);
} else {
  process.exit(0);
}

脚本可以通过 child_process 模块新建子进程，用于执行 Unix 系统命令。也可以使用封装好的包，例如：

Unix 允许程序之间使用管道重定向数据。

$ ps aux | grep 'node'

脚本可以通过监听标准输入的 data 事件，获取重定向的数据。

process.stdin.resume();
process.stdin.setEncoding('utf8');
process.stdin.on('data', function(data) {
  process.stdout.write(data);
});

下面是用法：

$ echo 'foo' | ./hello
hello foo

操作系统可以向执行中的进程发送信号，process 对象能够监听信号事件。

process.on('SIGINT', function () {
  console.log('Got a SIGINT');
  process.exit(0);
});

发送信号的方法如下。

$ kill -s SIGINT [process_id]