Node.jsでnpmスクリプト実行時の出力をスッキリ抑制！5つの方法を徹底解説

Node.js の npm スクリプト実行時の出力を抑制する方法

そこで、npm スクリプト実行時の出力を抑制する方法について、いくつかご紹介します。

--silent オプションを使用する

npm スクリプトを実行する際に --silent オプションを指定することで、ほとんどのログ出力を抑制することができます。

npm run script-name --silent

このオプションを使用すると、エラーメッセージや警告メッセージは引き続き出力されますが、デバッグ情報や経過情報などは抑制されます。

省略形として -s オプションを使用することもできます。

npm run script-name -s

.npmrc ファイルに loglevel プロパティを設定することで、npm のログ出力レベルをグローバルに設定することができます。

loglevel=silent

この設定を適用すると、--silent オプションを指定しなくても、すべての npm スクリプト実行時の出力が抑制されます。

ログ出力レベルには、silent の他に error、warn、info、verbose の 5 種類があります。それぞれのレベルで出力されるログの種類は以下の通りです。

• silent: エラーメッセージや警告メッセージも出力されない
• error: エラーメッセージのみ出力される
• info: エラーメッセージ、警告メッセージ、および情報メッセージが出力される
• verbose: すべてのログが出力される

特定のログのみを出力したい場合は、npm コマンドに --loglevel オプションとログレベルを指定することができます。

npm run script-name --loglevel=info

この例では、info レベル以上のログのみが出力されます。

スクリプト内で出力を制御する

npm スクリプト内で console.log などの出力関数を直接使用している場合は、スクリプト内で出力を制御することができます。

// script.js
if (process.env.NODE_ENV === 'production') {
  console.log = () => {}; // 本番環境ではログを出力しない
}

// ... 処理内容 ...

この例では、NODE_ENV 環境変数が production に設定されている場合、console.log 関数は何も出力しなくなります。

npm スクリプト実行時の出力を抑制するには、様々な方法があります。状況に合わせて最適な方法を選択してください。

• 特定のスクリプトのみ出力を抑制したい場合は、--silent オプションを使用するのが簡単です。
• すべての npm スクリプト実行時の出力を抑制したい場合は、.npmrc ファイルで loglevel を設定するのがおすすめです。
• 特定のログのみを出力したい場合は、--loglevel オプションを使用するか、スクリプト内で出力を制御します。

これらの方法を参考に、npm スクリプト実行時の出力を適切に制御し、開発環境を快適にご利用ください。

サンプルコード：Node.js の npm スクリプト実行時の出力を抑制する

--silent オプションを使用する

npm run script-name --silent

.npmrc ファイルで loglevel を設定する

.npmrc ファイルに以下の内容を追加します。

loglevel=silent

特定のログのみを出力する

npm run script-name --loglevel=info

このコマンドを実行すると、script.js という名前の npm スクリプトが実行され、info レベル以上のログのみが出力されます。

スクリプト内で出力を制御する

// script.js
if (process.env.NODE_ENV === 'production') {
  console.log = () => {}; // 本番環境ではログを出力しない
}

// ... 処理内容 ...

このスクリプトを script.js という名前で保存し、npm run script-name と実行すると、本番環境ではログが出力されなくなります。

補足

• これらのサンプルコードは、あくまでも例であり、状況に合わせて調整する必要があります。

Node.js の npm スクリプト実行時の出力を抑制するその他の方法

cross-env パッケージを使用すると、プラットフォームに依存せずに環境変数を設定することができます。このパッケージを使用して、NODE_ENV 環境変数を production に設定し、本番環境ではログを出力しないようにすることができます。

npm install cross-env

cross-env NODE_ENV=production npm run script-name

このコマンドを実行すると、script.js という名前の npm スクリプトが実行され、NODE_ENV 環境変数が production に設定され、本番環境ではログが出力されなくなります。

pkg-up パッケージを使用すると、現在のディレクトリツリーから package.json ファイルを見つけることができます。このパッケージを使用して、package.json ファイルの scripts プロパティに --silent オプションをグローバルに設定することができます。

npm install pkg-up

// package.json
{
  "scripts": {
    "script-name": "cross-env NODE_ENV=production node script.js --silent"
  }
}

nps パッケージは、npm スクリプトをより簡単に実行できるようにするツールです。このパッケージを使用して、--silent オプションをデフォルトで設定することができます。

npm install nps

npx script-name

今回紹介した方法は、あくまでも例であり、状況に合わせて最適な方法を選択する必要があります。

• 上記の方法に加えて、cross-env、pkg-up、nps などのパッケージを使用することもできます。