Nodemonで開発のストレスを軽減！Node.jsスタートスクリプト実行のベストプラクティス
Node.js で Nodemon を使ってスタートスクリプトを実行する方法
Nodemon を使ってスタートスクリプトを実行するには、以下の 2 つの方法があります。
package.json ファイルに start スクリプトを定義することで、Nodemon を使ってスタートスクリプトを実行できます。
{
"scripts": {
"start": "nodemon index.js"
}
}
上記の場合、npm start コマンドを実行すると、Nodemon が index.js ファイルを監視し、変更を検知した場合は自動的に再起動します。
コマンドラインで Nodemon を直接実行する
Nodemon を直接実行して、スタートスクリプトを指定することもできます。
nodemon index.js
オプション
Nodemon には、さまざまなオプションが用意されています。オプションの詳細については、Nodemon のドキュメントを参照してください。
補足
- Nodemon を使用する場合は、Node.js と npm がインストールされていることを確認してください。
- Nodemon は、グローバルにインストールするか、ローカルにインストールすることができます。グローバルにインストールすると、どのディレクトリからでも
nodemonコマンドを実行できます。ローカルにインストールすると、そのディレクトリ内でのみ使用できます。
例
以下の例では、app.js という名前の Express アプリケーションを Nodemonを使って起動する方法を示します。
package.json
{
"scripts": {
"start": "nodemon app.js"
}
}
app.js
const express = require('express');
const app = express();
app.get('/', (req, res) => {
res.send('Hello, World!');
});
app.listen(3000, () => {
console.log('Server listening on port 3000');
});
この例では、npm start コマンドを実行すると、Nodemon が app.js ファイルを監視し、変更を検知した場合は自動的に再起動します。ブラウザで http://localhost:3000 にアクセスすると、「Hello, World!」というメッセージが表示されます。
Node.js で Nodemon を使ってスタートスクリプトを実行するサンプルコード
例 1: package.json ファイルを使用する
{
"scripts": {
"start": "nodemon app.js"
}
}
const express = require('express');
const app = express();
app.get('/', (req, res) => {
res.send('Hello, World!');
});
app.listen(3000, () => {
console.log('Server listening on port 3000');
});
npm start
ブラウザで http://localhost:3000 にアクセスすると、「Hello, World!」というメッセージが表示されます。
例 2: コマンドラインで Nodemon を直接実行する
この例では、index.js という名前の Node.js スクリプトをコマンドラインで Nodemon を直接実行して起動する方法を示します。
nodemon index.js
index.js
console.log('Hello, World!');
この例を実行すると、Nodemon が index.js ファイルを監視し、変更を検知した場合は自動的に再起動します。コンソールに "Hello, World!" というメッセージが表示されます。
Node.js で Nodemon を使ってスタートスクリプトを実行するその他の方法
nodemon.json ファイルを使用して、Nodemon の設定を指定することができます。このファイルを使用すると、package.json ファイルに記載されている start スクリプトをオーバーライドすることができます。
{
"watch": ["index.js", "src/**/*.js"],
"exec": "node index.js"
}
上記の場合、Nodemon は index.js ファイルと src ディレクトリ内のすべての .js ファイルを監視します。ファイルに変更が加えられると、Nodemon は node index.js コマンドを実行してアプリケーションを再起動します。
--config オプションを使用する
nodemon コマンドに --config オプションを指定して、nodemon.json ファイルの場所を指定することができます。
nodemon --config nodemon.json
nodemon --exec "node index.js"
nodemon --watch index.js src/**/*.js
環境変数を使用する
NODE_ENV 環境変数を使用して、Nodemon の動作を変更することができます。
- NODE_ENV=development：Nodemon は開発モードで実行され、ファイルの変更を監視し、自動的に再起動します。
これらの方法は、それぞれ異なる状況で役立ちます。自分に合った方法を選択してください。
node.js nodemon
