20240105_min_node18.md

Update package configuration to reflect minimum Node.js version required

As Node.js 16 is EOL and Node.js 20 is already available, new adapters should support either Node.js 18 or 20 as the minimum version. There are a few changes necessary in package.json to reflect this when upgrading an existing adapter.

The engines field must specify the minimum version:

  "engines": {
-   "node": ">= 16"
+   "node": ">= 18"
  },

  "engines": {
-   "node": ">= 16"
+   "node": ">= 20"
  },

In addition, the testing workflow also needs to be updated. To do this, edit .github/workflows/test-and-release.yml as follows:

     steps:
       - uses: ioBroker/testing-action-check@v1
         with:
-          node-version: '16.x'
+          node-version: '18.x'
           # Uncomment the following line if your adapter cannot be installed using 'npm ci'
           # install-command: 'npm install'
           lint: true
...
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x]
         os: [ubuntu-latest, windows-latest, macos-latest]

     steps:
...
 #    steps:
 #      - uses: ioBroker/testing-action-deploy@v1
 #        with:
-#          node-version: '16.x'
+#          node-version: '18.x'
 #          # Uncomment the following line if your adapter cannot be installed using 'npm ci'
 #          # install-command: 'npm install'
 #          npm-token: ${{ secrets.NPM_TOKEN }}

---

When using TypeScript or when type-checking is enabled, the type definitions and tsconfig.json need to be updated aswell. First, update TypeScript itself:

npm i -D "typescript@~5.3.3"

To update the Node.js type definitions, run one of the following commands depending on the desired Node.js version:

npm i -D @types/node@18
npm i -D @types/node@20

Next, uninstall the old tsconfig base:

npm uninstall -D @tsconfig/node16

(or an even older version if you still use that).

Then, run one of the following commands depending on the desired Node.js version:

npm i -D @tsconfig/node18
npm i -D @tsconfig/node20

Last, reference this new base in your tsconfig.json by replacing node16 with the version you just installed the tsconfig for, e.g. node18 for Node.js 18:

{
-  "extends": "@tsconfig/node16/tsconfig.json",
+  "extends": "@tsconfig/node18/tsconfig.json",
  // ...
}