Node.js NPM スクリプト

1. NPM スクリプトとは？

NPM スクリプト (NPM Scripts) は、package.json ファイル内に定義できるコマンドのセットです。以下のような反復的なタスクを自動化するために非常に役立ちます。

• アプリケーションの実行
• テストの実施
• ビルド（ビルド処理）
• ファイルのクリーンアップ（不要なファイルの削除）

NPM スクリプトを使用することで、複雑なコマンドを覚えたり手動で入力したりすることなく、シンプルなエイリアス（別名）でタスクを管理できるようになります。

2. package.json でのスクリプト定義

package.json ファイル内の scripts セクションに、任意の名前とそれに対応する実行コマンドを記述します。

{
  "scripts": {
    "start": "node index.js",
    "test": "echo \"テストを実行中...\" && exit 0",
    "dev": "nodemon index.js"
  }
}

各スクリプトは、コマンドラインから npm run <スクリプト名> という形式で呼び出すことができます。

3. NPM スクリプトの実行方法

定義したスクリプトを実行するには、ターミナルで以下のコマンドを使用します。

npm run dev

ただし、頻繁に使用される一部の特別なスクリプトについては、run を省略して短縮形で実行することが可能です。

• start スクリプト: npm start
• test スクリプト: npm test

4. NPM スクリプトの主な活用例

現場での開発において、NPM スクリプトは以下のような用途で広く活用されています。

• アプリケーションの起動: node コマンドによる直接実行
• テストの実行: Jest や Mocha などのテストフレームワークの呼び出し
• 開発効率の向上: nodemon（自動再起動）や webpack（バンドル）などのツールとの連携
• ビルドプロセス: コードのコンパイルや、本番環境向けのバンドル生成
• コード品質の維持: eslint（リント）や prettier（フォーマット）の実行

5. まとめ

NPM スクリプトは、プロジェクトのあらゆるタスクを自動化し、ワークフローをシンプルにするための強力なツールです。

• package.json でスクリプトを定義し、一元管理する
• npm コマンドを通じて、チーム全員が同じコマンドでタスクを実行できる
• 複雑なビルドフローやテスト手順も、一つの短いコマンドに凝縮できる

これらを適切に設定することで、開発チーム全体の生産性とプロジェクトの保守性を大幅に向上させることができます。