npm run-script
npm run-scriptは、任意のコマンドを実行するコマンドです。
エイリアスrun、rum、urn
解説
package.jsonのscripts欄に定義したコマンドを実行します。
定義したコマンド名を指定せずにnpm run-scriptのみ実行すると、
定義されたコマンドの一覧が表示されます。
構文
- （構文）定義されているコマンドの一覧を表示する
- npm run-script npm run npm rum npm urn
- （構文）コマンドを実行する
- npm run-script ＜コマンド＞ [引数] npm run ＜コマンド＞ [引数] npm rum ＜コマンド＞ [引数] npm urn ＜コマンド＞ [引数]
run-script、run、rum、urn どれを使用しても実行結果は同じです。
| オプション | 説明 |
|---|---|
| --silent | 実行結果のみを表示する |
| -- ＜オプション＞ | オプションを渡す （例）-gオプションを渡す→ npm run-script -- -g |
| -h | コマンドのヘルプを表示する |
サンプル
package.jsonのscript欄のmycmdに定義してあるコマンドを実行する
（C:\test\my-app\package.json）
{
・・・省略・・・
"scripts": {
"mycmd": "npm index.js"
}
・・・省略・・・
}
C:\test\my-app>npm run-script mycmd
コマンド「npm index.js」が実行されます
package.jsonのscript欄のmycmdに定義してあるコマンドに -gオプションを渡してを実行する
（C:\test\my-app\package.json）
{
・・・省略・・・
"scripts": {
"mycmd": "npm ls"
}
・・・省略・・・
}
C:\test\my-app>npm run-script -- -g
コマンド「npm ls -g」が実行されます
npm run-scriptコマンドのヘルプを表示する
npm run-script -h
備考
- package.jsonの scripts欄に定義した start、stop、testに関しては、
専用のコマンド（npm start、npm stop、npm test）でも実行可能です。
関連項目
- npm run-script：任意のコマンドを実行する
- npm start：package.jsonのstartに定義されたコマンドを実行する
- npm stop：package.jsonのstopに定義されたコマンドを実行する
- npm test：package.jsonのtestに定義されたコマンドを実行する
