一种编程语言是否易用,很大程度上,取决于开发命令行程序的能力。
Node.js 作为目前最热门的开发工具之一,怎样使用它开发命令行程序,是 Web 开发者应该掌握的技能。
最近,Npm的网志有一组系列文章,我觉得写得非常好。下面就是我在它的基础上扩展的教程,应该是目前最好的解决方案了。
一、可执行脚本
我们从最简单的讲起。
首先,使用 JavaScript 语言,写一个可执行脚本 hello 。
#!/usr/bin/env nodeconsole.log(\'hello world\');
然后,修改 hello 的权限。
$ chmod 755 hello
现在,hello 就可以执行了。
$ ./hellohello world
如果想把 hello 前面的路径去除,可以将 hello 的路径加入环境变量 PATH。但是,另一种更好的做法,是在当前目录下新建 package.json ,写入下面的内容。
{ \"name\": \"hello\", \"bin\": { \"hello\": \"hello\" }}
然后执行 npm link 命令。
$ npm link
现在再执行 hello ,就不用输入路径了。
$ hellohello world
二、命令行参数的原始写法
命令行参数可以用系统变量 process.argv 获取。
#!/usr/bin/env nodeconsole.log(\'hello \', process.argv[2]);
执行时,直接在脚本文件后面,加上参数即可。
$ ./hello tomhello tom
三、新建进程
脚本可以通过 child_process 模块新建子进程,从而执行 Unix 系统命令。
#!/usr/bin/env nodevar name = process.argv[2];var exec = require(\'child_process\').exec;var child = exec(\'echo hello \' + name, function(err, stdout, stderr) { if (err) throw err; console.log(stdout);});
用法如下。
$ ./hello tomhello tom
四、shelljs 模块
shelljs 模块重新包装了 child_process,调用系统命令更加方便。它需要安装后使用。
npm install --save shelljs
然后,改写脚本。
#!/usr/bin/env nodevar name = process.argv[2];var shell = require(\"shelljs\");shell.exec(\"echo hello \" + name);
上面代码是 shelljs 的本地模式,即通过 exec 方法执行 shell 命令。此外还有全局模式,允许直接在脚本中写 shell 命令。
require(\'shelljs/global\');if (!which(\'git\')) { echo(\'Sorry, this script requires git\'); exit(1);}mkdir(\'-p\', \'out/Release\');cp(\'-R\', \'stuff/*\', \'out/Release\');cd(\'lib\');ls(\'*.js\').forEach(function(file) { sed(\'-i\', \'BUILD_VERSION\', \'v0.1.2\', file); sed(\'-i\', /.*REMOVE_THIS_LINE.*/n/, \'\', file); sed(\'-i\', /.*REPLACE_LINE_WITH_MACRO.*/n/, cat(\'macro.js\'), file);});cd(\'..\');if (exec(\'git commit -am \"Auto-commit\"\').code !== 0) { echo(\'Error: Git commit failed\'); exit(1);}
五、yargs 模块
shelljs 只解决了如何调用 shell 命令,而 yargs 模块能够解决如何处理命令行参数。它也需要安装。
$ npm install --save yargs
yargs 模块提供 argv 对象,用来读取命令行参数。请看改写后的 hello 。
#!/usr/bin/env nodevar argv = require(\'yargs\').argv;console.log(\'hello \', argv.name);
使用时,下面两种用法都可以。
$ hello --name=tomhello tom$ hello --name tomhello tom
如果将 argv.name 改成 argv.n,就可以使用一个字母的短参数形式了。
$ hello -n tomhello tom
可以使用 alias 方法,指定 name 是 n 的别名。
#!/usr/bin/env nodevar argv = require(\'yargs\') .alias(\'n\', \'name\') .argv;console.log(\'hello \', argv.n);
这样一来,短参数和长参数就都可以使用了。
$ hello -n tomhello tom$ hello --name tomhello tom
argv 对象有一个下划线(_)属性,可以获取非连词线开头的参数。
#!/usr/bin/env nodevar argv = require(\'yargs\').argv;console.log(\'hello \', argv.n);console.log(argv._);
用法如下。
$ hello A -n tom B Chello tom[ \'A\', \'B\', \'C\' ]
六、命令行参数的配置
yargs 模块还提供3个方法,用来配置命令行参数。
demand:是否必选default:默认值describe:提示
#!/usr/bin/env nodevar argv = require(\'yargs\') .demand([\'n\']) .default({n: \'tom\'}) .describe({n: \'your name\'}) .argv;console.log(\'hello \', argv.n);
上面代码指定 n 参数不可省略,默认值为 tom,并给出一行提示。
options 方法允许将所有这些配置写进一个对象。
#!/usr/bin/env nodevar argv = require(\'yargs\') .option(\'n\', { alias : \'name\', demand: true, default: \'tom\', describe: \'your name\', type: \'string\' }) .argv;console.log(\'hello \', argv.n);
有时,某些参数不需要值,只起到一个开关作用,这时可以用 boolean 方法指定这些参数返回布尔值。
#!/usr/bin/env nodevar argv = require(\'yargs\') .boolean([\'n\']) .argv;console.log(\'hello \', argv.n);
上面代码中,参数 n 总是返回一个布尔值,用法如下。
$ hellohello false$ hello -nhello true$ hello -n tomhello true
boolean 方法也可以作为属性,写入 option 对象。
#!/usr/bin/env nodevar argv = require(\'yargs\') .option(\'n\', { boolean: true }) .argv;console.log(\'hello \', argv.n);
七、帮助信息
yargs 模块提供以下方法,生成帮助信息。
usage:用法格式example:提供例子help:显示帮助信息epilog:出现在帮助信息的结尾
#!/usr/bin/env nodevar argv = require(\'yargs\') .option(\'f\', { alias : \'name\', demand: true, default: \'tom\', describe: \'your name\', type: \'string\' }) .usage(\'Usage: hello [options]\') .example(\'hello -n tom\', \'say hello to Tom\') .help(\'h\') .alias(\'h\', \'help\') .epilog(\'copyright 2015\') .argv;console.log(\'hello \', argv.n);
执行结果如下。
$ hello -hUsage: hello [options]Options: -f, --name your name [string] [required] [default: \"tom\"] -h, --help Show help [boolean]Examples: hello -n tom say hello to Tomcopyright 2015
八、子命令
yargs 模块还允许通过 command 方法,设置 Git 风格的子命令。
#!/usr/bin/env nodevar argv = require(\'yargs\') .command(\"morning\", \"good morning\", function (yargs) { console.log(\"Good Morning\"); }) .command(\"evening\", \"good evening\", function (yargs) { console.log(\"Good Evening\"); }) .argv;console.log(\'hello \', argv.n);
用法如下。
$ hello morning -n tomGood Morninghello tom
可以将这个功能与 shellojs 模块结合起来。
#!/usr/bin/env noderequire(\'shelljs/global\');var argv = require(\'yargs\') .command(\"morning\", \"good morning\", function (yargs) { echo(\"Good Morning\"); }) .command(\"evening\", \"good evening\", function (yargs) { echo(\"Good Evening\"); }) .argv;console.log(\'hello \', argv.n);
每个子命令往往有自己的参数,这时就需要在回调函数中单独指定。回调函数中,要先用 reset 方法重置 yargs 对象。
#!/usr/bin/env noderequire(\'shelljs/global\');var argv = require(\'yargs\') .command(\"morning\", \"good morning\", function (yargs) { echo(\"Good Morning\"); var argv = yargs.reset() .option(\"m\", { alias: \"message\", description: \"provide any sentence\" }) .help(\"h\") .alias(\"h\", \"help\") .argv; echo(argv.m); }) .argv;
用法如下。
$ hello morning -m \"Are you hungry?\"Good MorningAre you hungry?
九、其他事项
(1)返回值
根据 Unix 传统,程序执行成功返回 0,否则返回 1 。
if (err) { process.exit(1);} else { process.exit(0);}
(2)重定向
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\' | ./hellohello foo
(3)系统信号
操作系统可以向执行中的进程发送信号,process 对象能够监听信号事件。
process.on(\'SIGINT\', function () { console.log(\'Got a SIGINT\'); process.exit(0);});
发送信号的方法如下。
$ kill -s SIGINT [process_id]
(完)