Add knip for detecting unused files and dependencies (#638)

Author: Boshen

.github/workflows/ci.yml

@@ -28,6 +28,7 @@ jobs:
       - uses: oxc-project/setup-node@fdbf0dfd334c4e6d56ceeb77d91c76339c2a0885 # v1.0.4
       - run: pnpm run lint --format github
       - run: pnpm run fmt
+      - run: pnpm run knip
       - run: git diff --exit-code # Must commit everything
       - uses: crate-ci/typos@626c4bedb751ce0b7f03262ca97ddda9a076ae1c # v1.39.2
         with:

knip.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://unpkg.com/knip@5/schema.json",
+  "entry": [
+    ".vitepress/config/index.ts",
+    ".vitepress/theme/index.ts",
+    "src/**/*.md!",
+    ".vitepress/theme/components/**/*.vue!"
+  ],
+  "project": [
+    ".vitepress/**/*.{ts,vue}",
+    "src/**/*.md"
+  ],
+  "ignore": [
+    ".vitepress/cache/**",
+    ".vitepress/dist/**",
+    "build/**"
+  ],
+  "ignoreDependencies": [
+    "esbuild"
+  ],
+  "ignoreBinaries": [
+    "typos"
+  ],
+  "ignoreExportsUsedInFile": true,
+  "ignoreIssues": {
+    ".vitepress/theme/constants/team.ts": ["exports", "types"]
+  }
+}

package.json

@@ -12,6 +12,7 @@
     "lint:fix": "pnpm lint --fix && typos -w && pnpm fmt --write .",
     "typecheck": "tsc && vue-tsc",
     "fmt": "dprint fmt",
+    "knip": "knip",
     "sponsors": "degit Boshen/sponsors temp --force && mv temp/sponsors.svg public/sponsors.svg",
     "prepare": "husky"
   },
@@ -25,6 +26,7 @@
     "esbuild": "0.27.0",
     "feed": "^5.1.0",
     "husky": "^9.1.7",
+    "knip": "^5.69.1",
     "lint-staged": "16.2.6",
     "markdown-it-container": "^4.0.0",
     "oxc-minify": "^0.97.0",