[TASK] Streamline nodejs dependency management (#1302)

With #1289 the `nodejs` dependency management has
been changed from `yarn` to `npm` missing the one
or other important requirement.

This change streamlines the management by ...

* adding a `.nvmrc` file to the repository root to
  allow automatic nodejs/npm switch if the nvm shell
  switching is available on the host system.
* adding a `.npmrc` file to specify the lock file
  version and engine option.
* adding `nodejs` and `npm` version constraints as
  `engine` specification to the `package.json` file.
* remove `package-lock.json` from `.gitignore` and
  add it to the repository to ensure reproducable
  setups - which becomes more important if extension
  get custom backend/frontend modules and javascript.
* adding `package-lock.json` to exclude it from archive,
  due to remove from the `.gitignore` file.
* ensuring that new development files are excluded from
  packaging and publishing.
* use `npm ci` in GitHub action workflows to install
  from the lock-file.

Note: This change unblocks adding `npm` dispatching
to `Build/Scripts/runTests.sh`.

Resolves: #1301
Related: #1289

.gitattributes

@@ -5,6 +5,8 @@
 /.github/ export-ignore
 /.gitignore export-ignore
 /.gitlab/ export-ignore
+/.npmrc export-ignore
+/.nvmrc export-ignore
 /.php-cs-fixer.php export-ignore
 /.phpstorm.meta.php export-ignore
 /.prettierrc.js export-ignore
@@ -14,6 +16,7 @@
 /Tests/ export-ignore
 /eslint.config.json export-ignore
 /package.json export-ignore
+/package-lock.json export-ignore
 /phive.xml export-ignore
 /phpcs.xml export-ignore
 /phpstan-baseline.neon export-ignore

.github/workflows/ci.yml

@@ -93,9 +93,11 @@ jobs:
       - name: "Checkout"
         uses: actions/checkout@v4
       - name: "Install modules"
-        run: npm install
+        run: |
+          npm ci
       - name: "Run command"
-        run: "npm run lint:${{ matrix.command }}"
+        run: |
+          npm run lint:${{ matrix.command }}
   unit-tests:
     name: "Unit tests"
     runs-on: ubuntu-22.04

.gitignore

@@ -10,7 +10,6 @@
 /generate-documentation.sh
 /nbproject
 /node_modules/
-/package-lock.json
 /var
 /yarn-error.log
 /yarn.lock

.gitlab/pipeline/jobs/.default-frontend.yml

@@ -1,5 +1,5 @@
 .default-frontend:
-  image: node:latest
+  image: node:18
   needs: [ ]
   cache:
     key: "$CI_PROJECT_ID"

.npmrc

@@ -0,0 +1,2 @@
+lockfile-version=3
+engine-strict=true

.nvmrc

@@ -0,0 +1 @@
+v18.19

composer.json

@@ -192,7 +192,10 @@
 			"rm .prettierrc.js",
 			"rm Configuration/FunctionalTests.xml",
 			"rm Configuration/UnitTests.xml",
+			"rm .npmrc",
+			"rm .nvmrc",
 			"rm package.json",
+			"rm package-lock.json",
 			"rm phive.xml",
 			"rm phpcs.xml",
 			"rm phpstan-baseline.neon",

package.json

@@ -9,6 +9,10 @@
 	"author": "",
 	"version": "1.0.0",
 	"license": "ISC",
+	"engines": {
+		"node": ">=18.19.0 <19.0.0",
+		"npm": ">=10.0.0"
+	},
 	"scripts": {
 		"lint:js": "eslint 'Resources/Public/**/*.js'",
 		"lint:js:fix": "eslint 'Resources/Public/**/*.js' --quiet --fix",