Node.jsのnpm startスクリプトを変更・カスタマイズする方法

Node.jsアプリケーションの「startスクリプト」とは、特定のタスクを実行するために使用されるコマンド群のことです。Node.jsプロジェクトを開始・初期化する際には、アプリケーションを実行するための定義済みスクリプトが自動的に作成されます。これらのスクリプトは、プロジェクトのニーズや要件に応じて自由に変更することが可能です。

スクリプトコマンドは、Node.jsやReactなどでプログラムの起動用スクリプトを作成するために広く活用されています。「npm start」コマンドを使えば、長い実行コマンドを毎回入力しなくても、起動スクリプトを簡単に実行できるようになります。

package.jsonファイルの編集

以下は、package.jsonファイルに追加するstartスクリプトの記述例です。ここではエントリーファイルの名前を「index.js」としていますが、この名前はプロジェクトの構成に合わせて自由に変更できます。

"scripts"{
    "start": "node index.js" //ファイル名
}

以下は、startスクリプトの実装イメージを示した図です。

実行例

まず、「index.js」という名前のファイルを作成し、以下のコードをコピーして保存してください。ファイル作成後、次のコマンドを実行することでコードが動作します。

npm start

index.js

// expressモジュールの読み込み
const express = require('express');
const app = express();

// データを文字列で初期化
var data = "Welcome to TutorialsPoint !"

// '/'パスへのリクエストに対してレスポンスを送信
app.get('/' , (req,res)=>{

    // データをテキストとして返す
    res.send(data);
})

// ポート3000でサーバーを起動
app.listen(3000 , ()=>{
    console.log("server running");
});

出力結果

C:\home\node>> npm start

上記のコマンドを実行すると、index.jsファイルが自動的に実行されます。つまり、このコマンドひとつでプロジェクトのメインファイルが起動し、サーバーの準備が整います。

サーバー起動後、ブラウザから以下のURLにアクセスすると、Webページが正しく表示されていることを確認できます。

https://localhost:3000

まとめ

package.jsonのscriptsセクションを編集すれば、プロジェクトに合わせた独自のコマンドやオプションを簡単に組み込めます。開発効率を高めるためにも、startスクリプトのカスタマイズはぜひ活用してみてください。