Node.js と npm の使い方（その３：npm-scripts）

npm-scripts は package.json ファイルの "scripts" 項目として記載することで登録することができます。

{
	"name": "demo-app",
	"version": "1.0.0",
	"scripts": {
		"foo": "echo \"foo !!\"",
		"bar": "node bar.js"
	}
}

登録したスクリプトは、npm run-script コマンドで実行することができます。 npm run-script コマンドには、エイリアス（別名） npm run コマンドがあります。こちらの方が短くて便利でしょう。

npm run foo

> demo-app@1.0.0 foo c:\demo-app
> echo "foo !!"

"foo !!"

登録したスクリプト名のプレフィックスに pre とつけると前処理、 post とつけると後処理としてスクリプトを登録できます。 例えば、メイン処理のスクリプト名が hoge だった場合、前処理スクリプト名は prehoge、後処理スクリプト名は posthoge となります。 メイン処理のスクリプトを実行すると、自動で前処理と後処理のスクリプトも順番に実行されます。

{
	"name": "demo-app",
	"version": "1.0.0",
	"scripts": {
		"prehoge": "echo \"pre hoge !!\"",
		"hoge": "echo \"hoge !!\"",
		"posthoge": "echo \"post hoge !!\""
	}
}

npm run hoge

> demo-app@1.0.0 prehoge c:\demo-app
> echo "pre hoge !!"

"pre hoge !!"

> demo-app@1.0.0 hoge c:\demo-app
> echo "hoge !!"

"hoge !!"

> demo-app@1.0.0 posthoge c:\demo-app
> echo "post hoge !!"

"post hoge !!"

package.json に記載されている各値は、実行されるスクリプトの中で process.env オブジェクトから npm_package_～ という名前で取得できます。 例えば、package.json ファイルに {"name":"demo-app", "version":"1.0.0"} という項目がある場合、 process.env.npm_package_name という名前で "demo-app" という値、process.env.npm_package_version という名前で "1.0.0" という値が取得できます。

package.json に記載されている各値の中で、"config" の項目に記載された値は、npm config コマンドで書き換えることができます。 コマンドによって書き換えられることで、package.json を変更せずに、それぞれの環境にあった値に変更することができます。 変更可能な値は "config" の項目に集めて記載して使用するようにしましょう。

{
	"name": "demo-app",
	"version": "1.0.0",
	"scripts": {
		"foo": "echo \"foo !!\"",
		"bar": "node bar.js"
	},
	"config" : {
		"foo" : "Foo",
		"bar" : "Bar"
	}
}

// package.json の "name"
console.log(process.env.npm_package_name);

// package.json の "config.foo"
console.log(process.env.npm_package_config_foo);

// package.json の "config.bar"
console.log(process.env.npm_package_config_bar);

npm config set demo-app:bar BAR

npm run bar

demo-app
Foo
BAR