chore: QA tool to detect missing dependencies (#344)

use `knip` to test for missing dependencies.
since the `import/no-extraneous-dependencies` eslint rule is not
working.

---------

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

.github/workflows/nodejs.yml

@@ -133,6 +133,30 @@ jobs:
       - name: test
         run: yarn run test:lint
 
+  test-dependencies:
+    name: test lint
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Checkout
+        # see https://github.com/actions/checkout
+        uses: actions/checkout@v4
+      - run: mkdir -p ${{ env.REPORTS_DIR }}
+      - name: Setup Node.js ${{ matrix.node-version }}
+        # see https://github.com/actions/setup-node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_ACTIVE_LTS }}
+          # cache: 'yarn'
+      - name: Setup yarn
+        run: corepack enable yarn
+      - name: Setup subject
+        run: yarn install --immutable
+      - name: build
+        run: yarn run build:gbti
+      - name: test
+        run: yarn run test:dependencies
+
   test-licenses:
     needs: [ 'build' ]
     name: test licenses

knip.jsonc

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://unpkg.com/knip@5/schema-jsonc.json",
+  "entry": [
+    "src/plugin.ts!",
+    "bin/**!",
+    "index.js!"
+  ],
+  "project": [
+    "src/**!",
+    "bin/**!",
+    "tests/**",
+    "!tests/_data/testbeds/**"
+  ],
+  "ignore": [
+    "tools/**"
+  ],
+  "ignoreDependencies": [
+    // needed to force the installation of the optional dependency of a 3rd party package:
+    "xmlbuilder2"
+  ]
+}

package.json

@@ -86,6 +86,7 @@
     "extract-zip": "^2.0.1",
     "fast-glob": "^3.3.2",
     "globals": "^16.0.0",
+    "knip": "5.61.3",
     "mkdirp": "^3.0.1",
     "mocha": "11.7.1",
     "neostandard": "0.12.2",
@@ -147,6 +148,7 @@
     "test:standard": "eslint .",
     "test:lint": "tsc --noEmit",
     "test:node": "c8 mocha -p",
+    "test:dependencies": "knip --include dependencies,unlisted,unresolved --production",
     "cs-fix": "eslint --fix .",
     "dogfooding": "node $PROJECT_CWD/bin/cyclonedx-yarn-cli.js"
   },