Node.js 命令行程序开发教程 - 阮一峰的网络日志

link管理

链接快照平台

输入网页链接，自动生成快照
标签化管理网页链接

三、新建进程

脚本可以通过 child_process 模块新建子进程，从而执行 Unix 系统命令。

#!/usr/bin/env node var 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 tom hello tom

四、shelljs 模块

shelljs 模块重新包装了 child_process，调用系统命令更加方便。它需要安装后使用。

npm install --save shelljs

然后，改写脚本。

#!/usr/bin/env node var 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 node var argv = require('yargs').argv; console.log('hello ', argv.name);

使用时，下面两种用法都可以。

$ hello --name=tom hello tom $ hello --name tom hello tom

也就是说，process.argv 的原始返回值如下。

$ node hello --name=tom [ 'node', '/path/to/myscript.js', '--name=tom' ]

yargs 可以上面的结果改为一个对象，每个参数项就是一个键值对。

var argv = require('yargs').argv; // $ node hello --name=tom // argv = { // name: tom // };

如果将 argv.name 改成 argv.n，就可以使用一个字母的短参数形式了。

$ hello -n tom hello tom

可以使用 alias 方法，指定 name 是 n 的别名。

#!/usr/bin/env node var argv = require('yargs') .alias('n', 'name') .argv; console.log('hello ', argv.n);

这样一来，短参数和长参数就都可以使用了。

$ hello -n tom hello tom $ hello --name tom hello tom

argv 对象有一个下划线（_）属性，可以获取非连词线开头的参数。

#!/usr/bin/env node var argv = require('yargs').argv; console.log('hello ', argv.n); console.log(argv._);

用法如下。

$ hello A -n tom B C hello tom [ 'A', 'B', 'C' ]

六、命令行参数的配置

yargs 模块还提供3个方法，用来配置命令行参数。

demand：是否必选

default：默认值

describe：提示

八、子命令

yargs 模块还允许通过 command 方法，设置 Git 风格的子命令。

#!/usr/bin/env node var 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 tom Good Morning hello tom

可以将这个功能与 shellojs 模块结合起来。

#!/usr/bin/env node require('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 node require('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 Morning Are 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' | ./hello hello foo

（3）系统信号

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

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

发送信号的方法如下。

$ kill -s SIGINT [process_id]

node.js 内置了 process.argv 用于访问参数列表，这是跨平台的。
只不过为了方便，我们可以借助于专门的模块来做 parser，比如 commander 和这里提到的 yargs，从控制台读入可以用 readline 等模块。

使用类似的方法，在 Windows 上也很容易，不过我没有试过 npm link。

阮老师好：
我在通过你的blog学习node。
我刚刚看完第一个例子，我安装了node，写了hello，赋权限，“./hello”控制台成功现实，继续，我在使用npm link 命令加载package.json的时候，程序异常了

pm ERR! Error: EACCES, symlink '/Users/Yang/Project/NodeFactory/Test1'
npm ERR! at Error (native)
npm ERR! { [Error: EACCES, symlink '/Users/Yang/Project/NodeFactory/Test1']
npm ERR! errno: -13,
npm ERR! code: 'EACCES',
npm ERR! path: '/Users/Yang/Project/NodeFactory/Test1' }
npm ERR!
npm ERR! Please try running this command again as root/Administrator.

npm ERR! Please include the following file with any support request:
npm ERR! /Users/Yang/Project/NodeFactory/Test1/npm-debug.log

我自己尝试解决了下问题，但没成功，请问老师，这个是什么原因？

首先感谢阮老师回复我的提问（PS：真没想到阮老师会回复，有些感动）
我看了软老师给我提供的资料连接（https://docs.npmjs.com/getting-started/fixing-npm-permissions）
由于我的npm路径在“/usr”下，为了不影响其他文件的访问权限控制，我按资料中的提示，修改了npm的默认路径
➜ Test1 hello
hello world
➜ Test1
目前以完成练习1的内容，我会继续学习
最后感谢阮老师的文章

npm WARN build@ No description
npm WARN build@ No repository field.
npm WARN build@ No license field.
/usr/local/bin/build -> /usr/local/lib/node_modules/build/build
/usr/local/lib/node_modules/build -> /Users/Programer/Desktop/build_script
------------
然后我命令行运行build，输出以下：
/usr/local/bin/build: line 1: syntax error near unexpected token `'shelljs/global''
/usr/local/bin/build: line 1: `require('shelljs/global');'
------------
我个人认为跟安装shelljs的路径有关系,以下是我shelljs的路径：
/usr/local/bin/shjs -> /usr/local/lib/node_modules/shelljs/bin/shjs
------------

我已经是全局安装了shelljs，为什么require不到shelljs模块呢，望老师指点一下~

npm link那步骤有问题，走不下去
up to date in 0.056s
npm ERR! path /usr/local/lib/node_modules/hello/hello
npm ERR! code ENOENT
npm ERR! errno -2
npm ERR! syscall chmod
npm ERR! enoent ENOENT: no such file or directory, chmod '/usr/local/lib/node_modules/hello/hello'
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent

npm ERR! A complete log of this run can be found in:

阮老师，我在electron中使用shelljs执行命令，提示我command not found是什么原因呢？
我在项目目录下面执行这个命令是好用的，但是执行electron的执行文件就不能执行这个命令了。
var shell = require("shelljs/global")
exec("pxt serve --no-browser & ")

在本地工程目录下运行npm link 创建的cmd文件内容如下：（windows环境下）

@"%~dp0\node_modules\circle-count\bin\circle-count.js" %*

通过命令行执行时，打开了这个js文件，而note.exe circle-count.js这个文件
个人感觉，创建的cmd文件中，少了note.exe这个命令，不知道是为什么？