[fix] Remove unused dependencies, add check to run-qa-checks #484

Closes #484

---------

Co-authored-by: Iishaan Tanwar <iishaantanwar@MacBook-Air-3.local>
Co-authored-by: Federico Capoano <f.capoano@openwisp.io>

Author: 3 people

.github/workflows/ci.yml

@@ -18,6 +18,11 @@ jobs:
         with:
           ref: ${{ github.event.pull_request.head.sha }}
 
+      - name: Set up Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version-file: ".nvmrc"
+
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn cache dir)"
@@ -50,6 +55,11 @@ jobs:
     steps:
       - uses: actions/checkout@v6
 
+      - name: Set up Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version-file: ".nvmrc"
+
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn cache dir)"

.nvmrc

@@ -0,0 +1 @@
+lts/krypton

knip.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://unpkg.com/knip@5/schema.json",
+  "project": ["src/**/*.js", "test/**/*.js"],
+  "ignore": ["examples/**", "lib/js/**", "public/**", "scripts/**"],
+  "ignoreBinaries": ["wait-on"]
+}

lib/js/echarts-gl.min.js

@@ -2,7 +2,7 @@
   "name": "netjsongraph.js",
   "version": "0.3.0",
   "description": "NetJSON NetworkGraph visualizer",
-  "main": "index.js",
+  "main": "src/js/netjsongraph.js",
   "scripts": {
     "test": "jest --silent",
     "dev": "webpack serve --open --mode development",
@@ -55,7 +55,6 @@
     "@babel/preset-env": "^7.23.9",
     "@testing-library/jest-dom": "^6.4.2",
     "@types/jest": "^30.0.0",
-    "acorn": "^8.11.3",
     "copy-webpack-plugin": "^13.0.0",
     "coveralls": "^3.1.1",
     "css-loader": "^7.1.2",
@@ -67,15 +66,16 @@
     "eslint-plugin-jsx-a11y": "^6.8.0",
     "eslint-plugin-react": "^7.33.2",
     "html-webpack-plugin": "^5.6.0",
-    "husky": "^9.0.11",
     "identity-obj-proxy": "^3.0.0",
     "jest": "^30.0.3",
     "jest-environment-jsdom": "^30.0.5",
+    "knip": "^5.81.0",
     "lint-staged": "^16.1.0",
     "prettier": "^3.6.2",
     "selenium-webdriver": "^4.29.0",
     "style-loader": "^4.0.0",
     "terser-webpack-plugin": "^5.3.10",
+    "typescript": "^5.9.3",
     "webpack": "^5.90.3",
     "webpack-cli": "^6.0.1",
     "webpack-dev-server": "^5.0.2"

package.json

@@ -151,6 +151,7 @@
         },
       });
       netjsonmap.render();
+      // needed for selenium tests
       window._geoMap = netjsonmap;
 
       function createIndoorMapContainer() {

public/example_templates/netjsonmap-indoormap-overlay.html

@@ -15,3 +15,5 @@ openwisp-qa-check --skip-checkmigrations \
                   --skip-checkendline \
                   --csslinter \
                   --jslinter
+
+node scripts/ci-knip.js

run-qa-checks

@@ -0,0 +1,114 @@
+const {execSync} = require("child_process");
+
+function parseAndReportKnipResults(result) {
+  const issues = {
+    dependencies: new Set(),
+    devDependencies: new Set(),
+    unresolved: new Set(),
+    unusedFiles: new Set(),
+    unusedExports: [],
+  };
+
+  let hasIssues = false;
+
+  // Check for unused files
+  if (result.files && result.files.length > 0) {
+    result.files.forEach((file) => issues.unusedFiles.add(file));
+    hasIssues = true;
+  }
+
+  // Parse each file's issues
+  if (result.issues && result.issues.length > 0) {
+    result.issues.forEach((fileIssue) => {
+      if (fileIssue.dependencies && fileIssue.dependencies.length > 0) {
+        fileIssue.dependencies.forEach((dep) => issues.dependencies.add(dep));
+        hasIssues = true;
+      }
+      if (fileIssue.devDependencies && fileIssue.devDependencies.length > 0) {
+        fileIssue.devDependencies.forEach((dep) => issues.devDependencies.add(dep));
+        hasIssues = true;
+      }
+      if (fileIssue.unresolved && fileIssue.unresolved.length > 0) {
+        fileIssue.unresolved.forEach((item) => issues.unresolved.add(item.name));
+        hasIssues = true;
+      }
+      if (fileIssue.exports && fileIssue.exports.length > 0) {
+        fileIssue.exports.forEach((exp) => {
+          issues.unusedExports.push({
+            file: fileIssue.file,
+            name: exp.name,
+          });
+        });
+        hasIssues = true;
+      }
+    });
+  }
+
+  if (hasIssues) {
+    console.error("❌ Knip found issues:\n");
+    if (issues.dependencies.size > 0) {
+      console.error("Unused dependencies:");
+      Array.from(issues.dependencies)
+        .sort()
+        .forEach((d) => console.error(`  - ${d.name}`));
+      console.error("");
+    }
+    if (issues.devDependencies.size > 0) {
+      console.error("Unused devDependencies:");
+      Array.from(issues.devDependencies)
+        .sort()
+        .forEach((d) => console.error(`  - ${d.name}`));
+      console.error("");
+    }
+    if (issues.unresolved.size > 0) {
+      console.error("Unresolved imports:");
+      Array.from(issues.unresolved)
+        .sort()
+        .forEach((d) => console.error(`  - ${d}`));
+      console.error("");
+    }
+    if (issues.unusedFiles.size > 0) {
+      console.error("Unused files:");
+      Array.from(issues.unusedFiles)
+        .sort()
+        .forEach((f) => console.error(`  - ${f}`));
+      console.error("");
+    }
+    if (issues.unusedExports.length > 0) {
+      console.error("Unused exports:");
+      issues.unusedExports
+        .sort((a, b) => a.file.localeCompare(b.file))
+        .forEach((exp) => console.error(`  - ${exp.name} (${exp.file})`));
+      console.error("");
+    }
+    return true; // has issues
+  }
+  return false; // no issues
+}
+
+try {
+  const output = execSync("npx knip --reporter json", {
+    encoding: "utf-8",
+    stdio: ["pipe", "pipe", "pipe"],
+  });
+  const result = JSON.parse(output);
+  const hasIssues = parseAndReportKnipResults(result);
+  if (hasIssues) {
+    process.exit(1);
+  }
+  console.log("✅ Knip passed: no issues found");
+} catch (error) {
+  if (error.stdout) {
+    try {
+      const result = JSON.parse(error.stdout);
+      parseAndReportKnipResults(result);
+    } catch (parseError) {
+      console.error("❌ Knip failed (could not parse JSON output):");
+      console.error(error.message);
+    }
+  } else {
+    console.error("❌ Knip failed:");
+    console.error(error.message);
+  }
+  process.exit(1);
+}