npmスクリプト

長いコマンドに名前を付ける

開発を進めると、起動のコマンドはだんだん長くなります。環境変数を付けたり、監視の指定を足したりするからです。

毎回それを打つ代わりに、package.json の scripts に名前を付けて登録できます。

{
  "scripts": {
    "start": "node server.js",
    "preview": "node preview.js"
  }
}

登録したら、次のように呼び出します。

npm run preview

打つのは短い名前だけです。中身が変わっても、チームの全員が同じ npm run preview を打ち続けられます。手順を覚えるのではなく、手順をファイルに書いておくという考え方です。

start だけは run を省ける

start は特別扱いされていて、npm start でも動きます。npm run start と書いても同じです。

それ以外の名前は npm run が必要です。npm dev では動きません。

値は実行するコマンド

上の例では、npm start は node server.js を実行します。npm run preview なら、preview の右側にある node preview.js がコマンドです。名前が違っても、左側の名前を探し、右側の文字列を読むという手順は同じです。

値が空文字 "" なら、登録はありますが実行するコマンドは空です。

よく置かれる名前

決まりはありませんが、慣習はあります。

この 3 つは多くのプロジェクトで同じ意味で使われています。初めて触るプロジェクトでも、package.json の scripts を見れば動かし方が分かります。

手を動かす

演習では、別の package.json の scripts を読んで、npm start や npm run dev で実行されるコマンドを答えます。関数やスクリプトの存在確認は用意してあるので、読み取った文字列だけを書いてください。

1. answers.dev に、上の設定で npm run dev が実行するコマンドを書く
2. answers.start に、上の設定で npm start が実行するコマンドを書く
3. answers.test に、上の設定で npm run test に対応する値を書く。空文字も文字列として答える