このページでわかること
npm run
の基本的な使い方と役割package.json
に書くスクリプトの書き方- よく使われるスクリプトの例と実行方法
はじめに
「npm installは知ってるけど、npm runって何に使うの?」 「自分でスクリプト書けって言われてもよくわからない…」
そんなNode.js初心者さんに向けて、今回は npm run
の基礎をやさしく紹介します!
npm runを使えば、開発でよく使う作業(ビルド・テスト・サーバー起動など)を コマンド1つでサクッと実行できるようになります。
npm run
ってなに?
npm run
は、package.jsonに定義されたスクリプトを実行するためのコマンドです。
たとえば、package.json
にこんな記述があるとします:
"scripts": {
"start": "node index.js",
"test": "echo \"テスト実行中\""
}
この場合、以下のようにコマンドを打つと:
npm run start
→ node index.js
が実行されます!
実際によく使うスクリプトの例
スクリプト名 | 内容 | コマンド例 |
---|---|---|
start | アプリ起動や開発用サーバー起動 | npm run start |
build | プロジェクトのビルド処理 | npm run build |
lint | コードの静的解析(チェック) | npm run lint |
test | テスト実行 | npm run test |
これらはあくまで”慣例”なので、名前は自由に設定してOKです。
“npm run”を省略できるケース
一部のスクリプト(start
やtest
など)は特別扱いされていて、 run
を省略して以下のようにも書けます:
npm start
npm test
ただし、他のスクリプト名(例えば build
, lint
など)は省略できないので注意です!
よくあるエラーと対処法
❌ missing script: xxx
「その名前のスクリプトが存在しないよ」という意味です。 → package.json
に正しく定義されてるか確認!
❌ Permission denied(権限エラー)
実行ファイルに実行権限がない可能性があります。 → chmod +x
で権限付与してみましょう。
まとめ
npm run
は package.json 内のスクリプトを実行するコマンド!- 開発作業を自動化・簡略化できる便利な機能
- よく使うのは
start
,build
,lint
,test
など
「npm install だけで満足してたけど、runも便利だな」と思ってもらえたらうれしいです!
よくある質問(FAQ)
Q. スクリプトは何語で書くの?
A. 基本はNode.jsで実行できるコマンド(bashなど)です。
Q. 複数のコマンドをつなげられる?
A. &&
や ;
でつなげばOK。たとえば:
"scripts": {
"start": "npm run build && node app.js"
}
Q. スクリプト名って自由?
A. 自由です!ただし start
や test
は省略特典があるのでおすすめ。
コメント