あるプログラミング言語が使いやすいかどうかは、多くの場合、コマンドラインプログラムを開発する能力に依存します。
Node.js は現在最も人気のある開発ツールの一つです。これを使ってコマンドラインプログラムを開発する方法は、Web 開発者が身に付けるべきスキルです。
最近、Npm のブログには一連のシリーズ記事があります。とてもよく書かれていると思います。以下はそれを基に拡張したチュートリアルで、現在のところ最良の解決策です。
一、実行可能スクリプト
最も簡単なところから説明します。
まず、JavaScript 言語を使用して、実行可能スクリプト hello を書きます。
#!/usr/bin/env node
console.log('hello world');
次に、hello の権限を変更します。
$ chmod 755 hello
これで、hello を実行できるようになりました。
$ ./hello hello world
hello の前にあるパスを省略したい場合は、hello のパスを環境変数 PATH に追加します。しかし、もう一つのより良い方法は、現在のディレクトリに package.json を作成し、以下の内容を書き込むことです。
{
"name": "hello",
"bin": {
"hello": "hello"
}
}
次に npm link コマンドを実行します。
$ npm link
これで hello を実行する際、パスを入力する必要がなくなります。
$ hello hello world
二、コマンドライン引数の基本的な書き方
コマンドライン引数はシステム変数 process.argv で取得できます。
#!/usr/bin/env node
console.log('hello ', process.argv[2]);
実行時、スクリプトファイルの後に直接パラメータを追加するだけです。
$ ./hello tom hello tom
三、プロセスの新規作成
スクリプトは 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);
使用時は、以下の2つの使い方のどちらでも構いません。
$ hello --name=tom hello tom $ hello --name tom hello tom
argv.name を argv.n に変更すると、1文字の短いパラメータ形式を使用できます。
$ 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：説明
#!/usr/bin/env node
var argv = require('yargs')
.demand(['n'])
.default({n: 'tom'})
.describe({n: 'your name'})
.argv;
console.log('hello ', argv.n);
上記のコードは、n パラメータを省略不可とし、デフォルト値を tom に指定し、1行の説明を表示します。
options メソッドを使用すると、これらの設定をすべて1つのオブジェクトにまとめて記述できます。
#!/usr/bin/env node
var 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 node
var argv = require('yargs')
.boolean(['n'])
.argv;
console.log('hello ', argv.n);
上記のコードでは、パラメータ n は常にブール値を返します。使い方は以下の通りです。
$ hello hello false $ hello -n hello true $ hello -n tom hello true
boolean メソッドはプロパティとして option オブジェクトに記述することもできます。
#!/usr/bin/env node
var argv = require('yargs')
.option('n', {
boolean: true
})
.argv;
console.log('hello ', argv.n);
七、ヘルプ情報
yargs モジュールは、ヘルプ情報を生成するための以下のメソッドを提供します。
- usage：使用方法の形式
- example：例の提供
- help：ヘルプ情報の表示
- epilog：ヘルプ情報の最後に表示
#!/usr/bin/env node
var 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 -h Usage: hello [options] Options: -f, --name your name [string] [required] [default: "tom"] -h, --help Show help [boolean] Examples: hello -n tom say hello to Tom copyright 2015
八、サブコマンド
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
この機能を shelljs モジュールと組み合わせることができます。
#!/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]
原文：http://www.ruanyifeng.com/blog/2015/05/command-line-with-node.html