npm-shrinkwrap を使って Node.js プロジェクトのモジュールバージョンを固定する方法

2024-04-02

Node.js の "devDependencies" のインストールを抑制する方法

--production フラグを使用する

npm install コマンドに --production フラグを指定すると、devDependencies はインストールされません。

npm install --production

NODE_ENV 環境変数を "production" に設定すると、npm install コマンドは devDependencies を無視します。

NODE_ENV=production npm install

依存関係を別々のパッケージに分割する

開発用と本番用の依存関係を別々の package.json ファイルに分割する方法もあります。例えば、dev-dependencies.json ファイルと prod-dependencies.json ファイルを作成し、それぞれに開発用と本番用の依存関係を記述します。

# dev-dependencies.json
{
  "devDependencies": {
    "mocha": "^9.2.0",
    "chai": "^4.3.4"
  }
}

# prod-dependencies.json
{
  "dependencies": {
    "express": "^4.17.1",
    "body-parser": "^1.19.0"
  }
}

そして、それぞれの環境に合わせて npm install コマンドを実行します。

# 開発環境
npm install --package dev-dependencies.json

# 本番環境
npm install --package prod-dependencies.json

Yarn を使用する

Yarn は npm の代替パッケージマネージャーであり、devDependencies のインストールを抑制する機能が備わっています。

yarn install --production

これらの方法を組み合わせることで、Node.js プロジェクトで必要なモジュールのみをインストールすることができます。

package.json

{
  "name": "my-project",
  "version": "1.0.0",
  "description": "My Node.js project",
  "main": "index.js",
  "scripts": {
    "start": "node index.js"
  },
  "dependencies": {
    "express": "^4.17.1",
    "body-parser": "^1.19.0"
  },
  "devDependencies": {
    "mocha": "^9.2.0",
    "chai": "^4.3.4"
  }
}

index.js

const express = require('express');
const app = express();

app.get('/', (req, res) => {
  res.send('Hello, World!');
});

app.listen(3000, () => {
  console.log('App listening on port 3000');
});

使用方法

上記のコードを my-project というディレクトリに保存します。
以下のコマンドを実行して、本番用の依存関係をインストールします。

npm install --production

npm install --dev

以下のコマンドを実行して、アプリケーションを起動します。

npm start

ブラウザで http://localhost:3000 を開くと、「Hello, World!」と表示されます。

devDependencies は、開発時にのみ必要なモジュールを記述するために使用されます。本番環境では不要なモジュールまでインストールされないように、上記のいくつかの方法を参考にしてください。

その他の "devDependencies" のインストールを抑制する方法

.npmrc ファイルを使用する

npmrc ファイルは、npm の設定を記述するためのファイルです。このファイルに dev フィールドを追加することで、devDependencies のインストールを抑制できます。

dev=false

npm-shrinkwrap は、プロジェクトに必要なモジュールのバージョンを固定するためのツールです。npm-shrinkwrap を使用することで、devDependencies のバージョンも固定することができ、インストール時にバージョンが異なるモジュールがインストールされるのを防ぐことができます。