Set up knip (#37)

* Clean up shared deps * Set up knip * Clean up imports * Add basic knip config * Improve Knip config * Add some missing deps * Add some missing deps * Lift common to a true workspace * Set up knip * Trigger CodeQL * Trigger CodeQL
Siteimprove · Sep 3, 2024 · 0a7a62e · 0a7a62e
1 parent 1864635
commit 0a7a62e
Show file tree

Hide file tree

Showing 28 changed files with 376 additions and 506 deletions.
diff --git a/.github/workflows/integrate.yml b/.github/workflows/integrate.yml
@@ -30,3 +30,4 @@ jobs:
       - run: yarn dedupe --check
       - run: yarn build
       - run: yarn test
+      - run: yarn knip
diff --git a/common/package.json b/common/package.json
@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json.schemastore.org/package",
+  "private": true,
+  "name": "common",
+  "exports": {
+    "./persist": "./persist.js",
+    "./persist.js": "./persist.js"
+  },
+  "devDependencies": {
+    "@siteimprove/alfa-act": "^0.81.0",
+    "@siteimprove/alfa-assert": "^0.65.2",
+    "@siteimprove/alfa-formatter": "^0.65.2",
+    "@siteimprove/alfa-hash": "^0.81.0",
+    "@siteimprove/alfa-mapper": "^0.81.0"
+  },
+  "dependencies": {
+    "@siteimprove/alfa-formatter-earl": "^0.65.2",
+    "@siteimprove/alfa-future": "^0.81.0"
+  }
+}
diff --git a/config/knip.ts b/config/knip.ts
@@ -0,0 +1,39 @@
+import type { KnipConfig } from "knip";
+
+const entry = ["test/**/*.spec.ts", "test/**/*.spec.tsx"];
+const project = ["**/*.ts", "**/*.tsx"];
+
+const config: KnipConfig = {
+  ignoreDependencies: ["prettier"],
+  workspaces: {
+    common: { entry: "persist.ts", project },
+    "custom-testing/*": { entry, project },
+    "custom-testing/crawling": { entry: ["crawling.ts"], project },
+    "custom-testing/measuring-performances": {
+      entry: ["performance.ts"],
+      project,
+    },
+    "custom-testing/scraping": { entry: ["scraping.ts"], project },
+    "end-to-end-testing/*": { entry, project },
+    "end-to-end-testing/cypress": {
+      cypress: {
+        config: "cypress.json",
+        entry: [...entry, "support.ts"],
+        project,
+      },
+    },
+    "end-to-end-testing/webdriver": {
+      "webdriver-io": { config: ["wdio.conf.ts"], entry, project },
+      ignoreDependencies: [
+        // imported through the config file
+        "chromedriver",
+      ],
+    },
+    "unit-testing/*": { entry, project },
+    "unit-testing/angular": { entry: ["components/*.ts", "setup.ts"], project },
+    "unit-testing/react": { entry: ["components/*.tsx", "setup.ts"], project },
+    "unit-testing/vue": { entry: ["components/*.ts", "setup.ts"], project },
+  },
+};
+
+export default config;
diff --git a/custom-testing/adding-rules/package.json b/custom-testing/adding-rules/package.json
@@ -18,6 +18,7 @@
     "@types/chai": "^4.2.3",
     "@types/mocha": "^5.2.7",
     "chai": "^4.3.4",
+    "common": "workspace:^",
     "mocha": "^8.3.2",
     "playwright": "^1.10.0"
   }

diff --git a/custom-testing/adding-rules/test/page.spec.ts b/custom-testing/adding-rules/test/page.spec.ts
@@ -17,7 +17,7 @@ import * as alfa from "@siteimprove/alfa-chai";
 
 import rules from "@siteimprove/alfa-rules";
 
-import { persist } from "../../../common/persist";
+import { persist } from "common/persist";
 
 const { and } = Refinement;
 

diff --git a/custom-testing/answering/package.json b/custom-testing/answering/package.json
@@ -7,18 +7,19 @@
   },
   "devDependencies": {
     "@siteimprove/alfa-act": "^0.81.0",
+    "@siteimprove/alfa-chai": "^0.65.2",
     "@siteimprove/alfa-css": "^0.81.0",
     "@siteimprove/alfa-dom": "^0.81.0",
     "@siteimprove/alfa-future": "^0.81.0",
     "@siteimprove/alfa-hash": "^0.81.0",
     "@siteimprove/alfa-option": "^0.81.0",
+    "@siteimprove/alfa-playwright": "^0.65.2",
     "@siteimprove/alfa-refinement": "^0.81.0",
     "@siteimprove/alfa-rules": "^0.81.0",
-    "@siteimprove/alfa-scraper": "^0.65.2",
-    "@siteimprove/alfa-style": "^0.81.0",
     "@types/chai": "^4.2.3",
     "@types/mocha": "^5.2.7",
     "chai": "^4.3.4",
+    "common": "workspace:^",
     "mocha": "^8.3.2",
     "playwright": "^1.10.0"
   }

diff --git a/custom-testing/answering/test/answering.spec.ts b/custom-testing/answering/test/answering.spec.ts
@@ -2,30 +2,29 @@
 /// <reference types="mocha" />
 
 import * as act from "@siteimprove/alfa-act";
-import { Color, RGB } from "@siteimprove/alfa-css";
+import { Color } from "@siteimprove/alfa-css";
 import { Element, Text } from "@siteimprove/alfa-dom";
 import { Future } from "@siteimprove/alfa-future";
 import { Hashable } from "@siteimprove/alfa-hash";
 import { None, Some } from "@siteimprove/alfa-option";
 import { Playwright } from "@siteimprove/alfa-playwright";
 import { Refinement } from "@siteimprove/alfa-refinement";
-import rules, { Question, Scope } from "@siteimprove/alfa-rules";
-import { Resolver } from "@siteimprove/alfa-style";
+import rules, { Question } from "@siteimprove/alfa-rules";
 
 import * as chai from "chai";
 import * as playwright from "playwright";
 
 import * as alfa from "@siteimprove/alfa-chai";
 
-import { persist } from "../../../common/persist";
+import { persist } from "common/persist";
 
 const { and } = Refinement;
 
 // Creating a Chai plugin which uses all rules.
 chai.use(
   alfa.Chai.createPlugin(
     (value: Playwright.Type) => Future.from(Playwright.toPage(value)),
-    rules.filter(rule => !rule.uri.includes("r111")),
+    rules.filter((rule) => !rule.uri.includes("r111")),
     [persist(() => "test/outcomes/page.spec.json")]
   )
 );

diff --git a/custom-testing/filtering/package.json b/custom-testing/filtering/package.json
@@ -18,6 +18,7 @@
     "@types/chai": "^4.2.3",
     "@types/mocha": "^5.2.7",
     "chai": "^4.3.4",
+    "common": "workspace:^",
     "mocha": "^8.3.2",
     "playwright": "^1.10.0"
   }

diff --git a/custom-testing/filtering/test/filtering.spec.ts b/custom-testing/filtering/test/filtering.spec.ts
@@ -16,15 +16,15 @@ import * as alfa from "@siteimprove/alfa-chai";
 
 import rules, { Scope } from "@siteimprove/alfa-rules";
 
-import { persist } from "../../../common/persist";
+import { persist } from "common/persist";
 
 const { and } = Refinement;
 
 // Creating a Chai plugin which uses all rules.
 chai.use(
   alfa.Chai.createPlugin(
     (value: Playwright.Type) => Future.from(Playwright.toPage(value)),
-    rules.filter(rule => !rule.uri.includes("r111")),
+    rules.filter((rule) => !rule.uri.includes("r111")),
     [persist(() => "test/outcomes/filtering.spec.json")]
   )
 );

diff --git a/custom-testing/interacting/package.json b/custom-testing/interacting/package.json
@@ -13,6 +13,7 @@
     "@types/chai": "^4.2.3",
     "@types/mocha": "^5.2.7",
     "chai": "^4.3.4",
+    "common": "workspace:^",
     "mocha": "^8.3.2",
     "playwright": "^1.10.0"
   }

diff --git a/custom-testing/interacting/test/interacting.spec.ts b/custom-testing/interacting/test/interacting.spec.ts
@@ -13,7 +13,7 @@ import * as alfa from "@siteimprove/alfa-chai";
 import { Rules } from "@siteimprove/alfa-rules";
 const R69 = Rules.get("R69").getUnsafe();
 
-import { persist } from "../../../common/persist";
+import { persist } from "common/persist";
 
 chai.use(
   alfa.Chai.createPlugin(

diff --git a/custom-testing/navigating/test/navigating.spec.ts b/custom-testing/navigating/test/navigating.spec.ts
@@ -13,8 +13,6 @@ import * as alfa from "@siteimprove/alfa-chai";
 import { Rules } from "@siteimprove/alfa-rules";
 const R69 = Rules.get("R69").getUnsafe();
 
-import { persist } from "../../../common/persist";
-
 // Creating a Chai plugin which only uses R69.
 chai.use(
   alfa.Chai.createPlugin(

diff --git a/...-testing/cypress/integration/page.spec.ts → end-to-end-testing/cypress/test/page.spec.ts b/...-testing/cypress/integration/page.spec.ts → end-to-end-testing/cypress/test/page.spec.ts
diff --git a/end-to-end-testing/cypress/tsconfig.json b/end-to-end-testing/cypress/tsconfig.json
@@ -5,5 +5,5 @@
     "skipLibCheck": true,
     "types": ["cypress"]
   },
-  "files": ["integration/page.spec.ts", "support.ts"]
+  "files": ["test/page.spec.ts", "support.ts"]
 }
diff --git a/end-to-end-testing/playwright/package.json b/end-to-end-testing/playwright/package.json
@@ -6,15 +6,14 @@
     "test": "mocha --timeout 10000"
   },
   "devDependencies": {
-    "@siteimprove/alfa-assert": "^0.65.2",
     "@siteimprove/alfa-chai": "^0.65.2",
-    "@siteimprove/alfa-formatter-earl": "^0.65.2",
     "@siteimprove/alfa-future": "^0.81.0",
     "@siteimprove/alfa-playwright": "^0.65.2",
     "@siteimprove/alfa-rules": "^0.81.0",
     "@types/chai": "^4.2.3",
     "@types/mocha": "^5.2.7",
     "chai": "^4.3.4",
+    "common": "workspace:^",
     "mocha": "^8.3.2",
     "playwright": "^1.10.0"
   }

diff --git a/end-to-end-testing/playwright/test/page.spec.ts b/end-to-end-testing/playwright/test/page.spec.ts
@@ -10,12 +10,12 @@ import { Playwright } from "@siteimprove/alfa-playwright";
 import * as alfa from "@siteimprove/alfa-chai";
 import rules from "@siteimprove/alfa-rules";
 
-import { persist } from "../../../common/persist";
+import { persist } from "common/persist";
 
 chai.use(
   alfa.Chai.createPlugin(
     (value: Playwright.Type) => Future.from(Playwright.toPage(value)),
-    rules.filter(rule => !rule.uri.includes("r111")),
+    rules.filter((rule) => !rule.uri.includes("r111")),
     [persist(() => "test/outcomes/page.spec.json")]
   )
 );

diff --git a/end-to-end-testing/puppeteer/package.json b/end-to-end-testing/puppeteer/package.json
@@ -6,14 +6,14 @@
     "test": "mocha -t 10000"
   },
   "devDependencies": {
-    "@siteimprove/alfa-assert": "^0.65.2",
     "@siteimprove/alfa-chai": "^0.65.2",
     "@siteimprove/alfa-future": "^0.81.0",
     "@siteimprove/alfa-puppeteer": "^0.65.2",
     "@siteimprove/alfa-rules": "^0.81.0",
     "@types/chai": "^4.2.3",
     "@types/mocha": "^5.2.7",
     "chai": "^4.3.4",
+    "common": "workspace:^",
     "mocha": "^8.3.2",
     "puppeteer": "^8.0.0"
   }

diff --git a/end-to-end-testing/puppeteer/test/page.spec.ts b/end-to-end-testing/puppeteer/test/page.spec.ts
@@ -9,7 +9,7 @@ import { Puppeteer } from "@siteimprove/alfa-puppeteer";
 import * as alfa from "@siteimprove/alfa-chai";
 import rules from "@siteimprove/alfa-rules";
 
-import { persist } from "../../../common/persist";
+import { persist } from "common/persist";
 
 chai.use(
   alfa.Chai.createPlugin(

diff --git a/end-to-end-testing/webdriver/package.json b/end-to-end-testing/webdriver/package.json
@@ -6,22 +6,19 @@
     "test": "wdio wdio.conf.js"
   },
   "devDependencies": {
-    "@siteimprove/alfa-assert": "^0.65.2",
     "@siteimprove/alfa-chai": "^0.65.2",
     "@siteimprove/alfa-future": "^0.81.0",
     "@siteimprove/alfa-rules": "^0.81.0",
     "@siteimprove/alfa-webdriver": "^0.65.2",
     "@types/chai": "^4.2.3",
     "@types/mocha": "^5.2.7",
     "@wdio/cli": "^5.14.4",
-    "@wdio/local-runner": "^7.1.1",
     "@wdio/mocha-framework": "^7.1.1",
     "@wdio/spec-reporter": "^7.1.1",
     "chai": "^4.3.4",
     "chromedriver": "^119.0.1",
+    "common": "workspace:^",
     "mocha": "^8.3.2",
-    "ts-node": "^9.1.1",
-    "wdio-chromedriver-service": "^7.0.0",
     "webdriverio": "^7.3.1"
   }
 }
diff --git a/end-to-end-testing/webdriver/test/page.spec.ts b/end-to-end-testing/webdriver/test/page.spec.ts
@@ -6,7 +6,7 @@ import { WebElement } from "@siteimprove/alfa-webdriver";
 import * as alfa from "@siteimprove/alfa-chai";
 import rules from "@siteimprove/alfa-rules";
 
-import { persist } from "../../../common/persist";
+import { persist } from "common/persist";
 
 chai.use(
   alfa.Chai.createPlugin(

diff --git a/package.json b/package.json
@@ -6,22 +6,18 @@
     "build": "tsc --build",
     "watch": "tsc --build --watch",
     "clean": "tsc --build --clean",
+    "knip": "knip -c config/knip.ts",
     "test": "yarn workspaces foreach -v -p --exclude 'end-to-end-testing-{cypress,puppeteer,webdriver}' --exclude 'custom-testing-{crawling,scraping,measuring-performance}' --exclude 'unit-testing-angular' run test"
   },
   "workspaces": [
+    "common",
     "custom-testing/*",
     "end-to-end-testing/*",
     "unit-testing/*"
   ],
   "devDependencies": {
-    "@siteimprove/alfa-act": "^0.81.0",
-    "@siteimprove/alfa-assert": "^0.65.2",
-    "@siteimprove/alfa-formatter": "^0.65.2",
-    "@siteimprove/alfa-formatter-earl": "^0.65.2",
-    "@siteimprove/alfa-future": "^0.81.0",
-    "@siteimprove/alfa-hash": "^0.81.0",
-    "@siteimprove/alfa-mapper": "^0.81.0",
     "@types/node": "^20.2.3",
+    "knip": "^5.29.1",
     "prettier": "^2.2.1",
     "typescript": "^5.0.4"
   },

diff --git a/unit-testing/angular/package.json b/unit-testing/angular/package.json
@@ -29,21 +29,18 @@
     "verbose": true
   },
   "dependencies": {
-    "@angular/common": "^8.2.0",
-    "@angular/compiler": "^8.2.0",
     "@angular/core": "^11.0.5",
-    "@angular/platform-browser": "^8.2.0",
     "@angular/platform-browser-dynamic": "^8.2.0",
-    "core-js": "^3.10.1",
     "rxjs": "^6.6.7",
     "zone.js": "^0.11.4"
   },
   "devDependencies": {
     "@siteimprove/alfa-angular": "^0.65.2",
-    "@siteimprove/alfa-assert": "^0.65.2",
+    "@siteimprove/alfa-future": "^0.81.0",
     "@siteimprove/alfa-jest": "^0.65.2",
     "@siteimprove/alfa-rules": "^0.81.0",
     "@types/jest": "^29.5.1",
+    "common": "workspace:^",
     "jest": "^29.5.0",
     "jest-environment-jsdom": "^29.5.0",
     "jest-preset-angular": "^13.1.1"

diff --git a/unit-testing/angular/setup.ts b/unit-testing/angular/setup.ts
@@ -16,7 +16,7 @@ global.TextEncoder = TextEncoder;
 import { Rules } from "@siteimprove/alfa-rules";
 const R12 = Rules.get("R12").getUnsafe();
 
-import { persist } from "../../common/persist";
+import { persist } from "common/persist";
 
 alfa.Jest.createPlugin(
   (value: Angular.Type) => Future.from(Angular.toPage(value)),

diff --git a/unit-testing/react/package.json b/unit-testing/react/package.json
@@ -16,22 +16,20 @@
       "js"
     ]
   },
-  "dependencies": {
-    "@types/react": "^17.0.0",
-    "@types/react-dom": "^17.0.0",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2"
-  },
   "devDependencies": {
-    "@siteimprove/alfa-assert": "^0.65.2",
     "@siteimprove/alfa-enzyme": "^0.65.2",
     "@siteimprove/alfa-jest": "^0.65.2",
     "@siteimprove/alfa-rules": "^0.81.0",
     "@types/enzyme": "^3.10.5",
     "@types/enzyme-adapter-react-16": "^1.0.5",
     "@types/jest": "^29.5.1",
+    "@types/react": "^17.0.0",
+    "@types/react-dom": "^17.0.0",
+    "common": "workspace:^",
     "enzyme": "^3.11.0",
     "enzyme-adapter-react-16": "^1.15.6",
-    "jest": "^29.5.0"
+    "jest": "^29.5.0",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
   }
 }
diff --git a/unit-testing/react/setup.ts b/unit-testing/react/setup.ts
@@ -9,7 +9,7 @@ const R12 = Rules.get("R12").getUnsafe();
 import * as enzyme from "enzyme";
 import Adapter from "enzyme-adapter-react-16";
 
-import { persist } from "../../common/persist";
+import { persist } from "common/persist";
 
 enzyme.configure({ adapter: new Adapter() });