開発環境と本番環境で異なるNode.jsバージョンを指定する方法

2024-04-02

package.jsonで必要なNode.jsバージョンを指定する方法

必要なNode.jsバージョンを指定することで、以下のメリットがあります。

開発者・利用者が、互換性のあるNode.jsバージョンで実行できることを確認できる
古いバージョンのNode.jsで発生する、互換性問題を防ぐことができる

必要なNode.jsバージョンを指定する方法

必要なNode.jsバージョンは、package.jsonファイルのenginesフィールドで指定します。enginesフィールドは、オブジェクト形式で記述します。

{
  "name": "my-package",
  "version": "1.0.0",
  "engines": {
    "node": ">=14.0.0"
  }
}

上記の例では、Node.js 14.0.0以上が必要であることを指定しています。

バージョン指定には、以下の記号を使用できます。

>=: 指定されたバージョン以上
^: 指定されたメジャーバージョン.マイナーバージョン.0以上

例：

>=14.0.0: Node.js 14.0.0以上

複数のバージョンを指定する場合は、カンマで区切ります。

{
  "name": "my-package",
  "version": "1.0.0",
  "engines": {
    "node": ">=14.0.0, <=16.0.0"
  }
}

package.jsonファイルのenginesフィールドを使用することで、必要なNode.jsバージョンを簡単に指定できます。互換性問題を防ぎ、開発者・利用者に快適な開発環境を提供するために、必要なNode.jsバージョンを明記することを強く推奨します。

補足

npm installコマンドを実行する際に、--engine-strictオプションを指定すると、enginesフィールドで指定されたバージョン以外のNode.jsでインストールしようとすると警告が表示されます。
enginesフィールドは、開発環境と本番環境で異なるバージョンを指定することができます。

{
  "name": "my-package",
  "version": "1.0.0",
  "description": "This is a sample package.",
  "main": "index.js",
  "scripts": {
    "start": "node index.js"
  },
  "keywords": ["node", "sample"],
  "author": "Bard",
  "license": "MIT",
  "dependencies": {
    "express": "^4.17.1"
  },
  "devDependencies": {
    "mocha": "^8.4.0"
  },
  "engines": {
    "node": ">=14.0.0, <=16.0.0"
  }
}