【保存版】Node.jsで開発効率を爆上げ！devDependenciesのインストール方法を徹底解説

Node.js で devDependencies のみインストールする方法

一般的に npm install コマンドを実行すると、dependencies と devDependencies 両方の依存関係がインストールされますが、場合によっては devDependencies のみインストールしたいことがあります。

ここでは、npm を使用して devDependencies のみインストールする方法をいくつかご紹介します。

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

最も簡単な方法は、npm install コマンドに --production オプションを指定することです。

npm install --production

このオプションを使用すると、dependencies に記載されているパッケージのみがインストールされ、devDependencies は無視されます。

--only=prod オプションを使用する

npm v7.0.0 以降では、より明確なオプションとして --only=prod が導入されました。

npm install --only=prod

このオプションも --production オプションと同様に、dependencies のみインストールします。

環境変数 NODE_ENV を設定する

NODE_ENV 環境変数を production に設定することで、npm install コマンドが自動的に --production オプション相当の動作になるようにすることもできます。

NODE_ENV=production npm install

この方法は、常に devDependencies を除外してインストールしたい場合に便利です。

npm-prune コマンドを使用する

すでに dependencies と devDependencies がインストール済みの場合、npm-prune コマンドを使用して devDependencies を削除することができます。

npm prune --production

このコマンドは、package.json の dependencies に記載されていないパッケージをすべて削除します。

上記のように、npm には devDependencies のみインストールするための様々なオプションと方法が用意されています。 状況に合わせて適切な方法を選択してください。

補足:

• 上記の方法でインストールした場合、node_modules フォルダには devDependencies が含まれないため、本番環境へのデプロイ前に npm install または npm ci コマンドを実行して dependencies をインストールする必要があります。
• TypeScript など、開発中にのみ必要なコンパイラやリンターなどのツールがある場合は、devDependencies に追加する必要があります。

# package.json ファイル

{
  "name": "my-project",
  "version": "1.0.0",
  "description": "My awesome project",
  "scripts": {
    "start": "node index.js"
  },
  "dependencies": {
    "express": "^4.17.1"
  },
  "devDependencies": {
    "eslint": "^8.0.1",
    "mocha": "^8.6.2"
  }
}

--production オプションを使用する場合

npm install --production

このコマンドを実行すると、node_modules フォルダには以下のディレクトリのみが作成されます。

node_modules
└── express

devDependencies に記載されている eslint や mocha などのパッケージはインストールされません。

npm install --only=prod

node_modules
└── express

NODE_ENV 環境変数を設定する場合

NODE_ENV=production npm install

node_modules
└── express

npm-prune コマンドを使用する場合

npm prune --production

node_modules
├── eslint
└── mocha

これで、node_modules フォルダには dependencies に記載されている express パッケージのみが残ることになります。

Node.js で devDependencies のみインストールするその他の方法

yarn を使用する

yarn は、Node.js 向けのパッケージマネージャーであり、npm と同様の機能を提供しています。 yarn には、--production オプションを使用して devDependencies を除外してインストールする機能があります。

yarn install --production

npx を使用する

npx は、Node.js 10.x 以降に標準で含まれているコマンドラインツールであり、パッケージをインストールせずに локально実行することができます。 npx を使用して devDependencies を除外してインストールするには、以下のコマンドを実行します。

npx install --production <package-name>

<package-name> は、インストールしたいパッケージの名前を置き換えます。

手動でインストールする

devDependencies を手動でインストールするには、以下の手順を実行します。

1. package.json ファイルから devDependencies の一覧を取得します。
2. 各パッケージの最新バージョンをダウンロードします。
3. ダウンロードしたパッケージを node_modules ディレクトリに解凍します。

この方法は、他の方法よりも時間と手間がかかりますが、ネットワーク接続が不安定な場合などに役立ちます。