feat: add knip CI configuration

Resolves: #12

.github/workflows/knip.yml

@@ -0,0 +1,30 @@
+name: Knip
+
+on:
+  pull_request:
+
+permissions: write-all
+
+jobs:
+  run-knip:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.10.x
+
+      - name: Install toolchain
+        run: yarn install
+
+      - name: Report knip results to pull request
+        uses: Codex-/knip-reporter@v2
+        with:
+          verbose: true
+          comment_id: ${{ github.workflow }}-reporter
+          command_script_name: knip-ci
+          annotations: true
+          ignore_results: false

knip.ts

@@ -0,0 +1,11 @@
+import type { KnipConfig } from "knip";
+
+const config: KnipConfig = {
+  entry: ["build/index.ts"],
+  project: ["src/**/*.ts"],
+  ignore: ["src/types/config.ts"],
+  ignoreExportsUsedInFile: true,
+  ignoreDependencies: [],
+};
+
+export default config;

package.json

@@ -15,6 +15,8 @@
     "format:lint": "eslint --fix .",
     "format:prettier": "prettier --write .",
     "format:cspell": "cspell **/*",
+    "knip": "knip",
+    "knip-ci": "knip --no-exit-code --reporter json",
     "prepare": "husky install"
   },
   "keywords": [