add knip and improve cursor rules (#23)

bebiksior · web-flow · commit d80ed37d5ab9 · 2025-11-26T11:45:40.000-05:00
* improve Cursor rules

* add: knip

* add knip to validate workflow

* fix: oops wrong workflow
diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml
@@ -98,4 +98,4 @@ jobs:
         run: pnpm install
 
       - name: Run linter
-        run: pnpm lint
+        run: pnpm lint
diff --git a/package.json b/package.json
@@ -33,6 +33,7 @@
   "devDependencies": {
     "@caido/eslint-config": "0.5.0",
     "@inquirer/prompts": "7.0.0",
+    "knip": "5.70.2",
     "typescript": "5.6.3",
     "unbuild": "2.0.0"
   }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/templates/frontend-vue/.github/workflows/validate.yml b/templates/frontend-vue/.github/workflows/validate.yml
@@ -62,4 +62,28 @@ jobs:
         run: pnpm install
 
       - name: Run linter
-        run: pnpm lint
+        run: pnpm lint
+
+  knip:
+    name: 'Knip'
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.CAIDO_NODE_VERSION }}
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4.1.0
+        with:
+          version: ${{ env.CAIDO_PNPM_VERSION }}
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Run knip
+        run: pnpm knip
diff --git a/templates/frontend-vue/knip.ts b/templates/frontend-vue/knip.ts
@@ -0,0 +1,20 @@
+import type { RawConfigurationOrFn } from "knip/dist/types/config.js";
+
+const config: RawConfigurationOrFn = {
+  workspaces: {
+    ".": {
+      entry: ["caido.config.ts", "eslint.config.mjs"],
+    },
+    "packages/backend": {
+      entry: ["src/index.ts"],
+      project: ["src/**/*.ts"],
+      ignoreDependencies: ["caido"],
+    },
+    "packages/frontend": {
+      entry: ["src/index.ts"],
+      project: ["src/**/*.{ts,tsx,vue}"],
+    },
+  },
+};
+
+export default config;
diff --git a/templates/frontend-vue/package.json b/templates/frontend-vue/package.json
@@ -5,6 +5,7 @@
   "scripts": {
     "typecheck": "pnpm -r typecheck",
     "lint": "eslint ./packages/**/src --fix",
+    "knip": "knip",
     "build": "caido-dev build",
     "watch": "caido-dev watch"
   },
@@ -13,9 +14,11 @@
     "@caido/eslint-config": "^0.5.0",
     "@caido/tailwindcss": "0.0.1",
     "@vitejs/plugin-vue": "5.2.1",
+    "eslint": "9.29.0",
     "postcss-prefixwrap": "1.51.0",
     "tailwindcss": "3.4.13",
     "tailwindcss-primeui": "0.3.4",
-    "typescript": "5.5.4"
+    "typescript": "5.5.4",
+    "knip": "5.70.2"
   }
 }
diff --git a/templates/no-frontend/.github/workflows/validate.yml b/templates/no-frontend/.github/workflows/validate.yml
@@ -62,4 +62,28 @@ jobs:
         run: pnpm install
 
       - name: Run linter
-        run: pnpm lint
+        run: pnpm lint
+
+  knip:
+    name: 'Knip'
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.CAIDO_NODE_VERSION }}
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4.1.0
+        with:
+          version: ${{ env.CAIDO_PNPM_VERSION }}
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Run knip
+        run: pnpm knip
diff --git a/templates/no-frontend/knip.ts b/templates/no-frontend/knip.ts
@@ -0,0 +1,16 @@
+import type { RawConfigurationOrFn } from "knip/dist/types/config.js";
+
+const config: RawConfigurationOrFn = {
+  workspaces: {
+    ".": {
+      entry: ["caido.config.ts", "eslint.config.mjs"],
+    },
+    "packages/backend": {
+      entry: ["src/index.ts"],
+      project: ["src/**/*.ts"],
+      ignoreDependencies: ["caido"],
+    },
+  },
+};
+
+export default config;
diff --git a/templates/no-frontend/package.json b/templates/no-frontend/package.json
@@ -5,12 +5,15 @@
   "scripts": {
     "typecheck": "pnpm -r typecheck",
     "lint": "eslint ./packages/**/src --fix",
+    "knip": "knip",
     "build": "caido-dev build",
     "watch": "caido-dev watch"
   },
   "devDependencies": {
     "@caido-community/dev": "^0.1.3",
     "@caido/eslint-config": "^0.5.0",
-    "typescript": "5.5.4"
+    "eslint": "9.29.0",
+    "typescript": "5.5.4",
+    "knip": "5.70.2"
   }
 }
diff --git a/templates/no-frontend/packages/backend/package.json b/templates/no-frontend/packages/backend/package.json
@@ -8,6 +8,7 @@
     "build": "vite build"
   },
   "devDependencies": {
-    "@caido/sdk-backend": "^0.46.0"
+    "@caido/sdk-backend": "^0.46.0",
+    "vite": "6.0.11"
   }
 }
diff --git a/templates/shared/cursor-rules/best-practices.mdc b/templates/shared/cursor-rules/best-practices.mdc
@@ -0,0 +1,42 @@
+---
+globs:
+alwaysApply: true
+description: Code Quality Best Practices
+---
+
+## TypeScript and Code Quality
+
+- Use TypeScript for all files.
+- Only use types, not interfaces.
+- Do not use `any` type.
+- Use `undefined` over `null`.
+- Do not add any comments to the code that you generate.
+- Don’t cast to `any`.
+- Don’t unnecessarily add `try`/`catch`.
+- Use `computed` for derived state instead of reactive variables when possible.
+- Use `knip` to remove unused code if making large changes.
+- When refactoring, avoid creating alias types like this:
+```
+export type Options = ScanConfig;
+```
+Instead, actually rename the type and fix all occurrences if needed.
+
+## Structure, Naming, and Organization
+
+- Follow consistent naming conventions:
+    - Folders: camelCase (`intercept`, `replay`, `httpHistory`).
+    - Component folders: PascalCase (`PassiveFormCreate`, `PassiveTable`).
+    - All other files: camelCase (`useForm.ts`, `assistant.graphql`).
+- Avoid massive template blocks; compose smaller components.
+- Colocate code that changes together.
+- Declare variables close to their usage:
+    - Avoid declaring all variables at the top of functions/files.
+    - Place variable declarations as close as possible to where they are first used.
+    - Group related variables together (e.g., event bus declarations next to their corresponding listeners).
+
+## Simplicity and Readability
+
+- Only create an abstraction if it is actually needed.
+- Prefer clear function and variable names over inline comments.
+- Avoid helper functions when a simple inline expression would suffice.
+- Use built-in Tailwind values, occasionally allow dynamic values, rarely globals.
diff --git a/templates/shared/cursor-rules/typescript.mdc b/templates/shared/cursor-rules/typescript.mdc

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@`
`33`	`33`	`"devDependencies": {`
`34`	`34`	`"@caido/eslint-config": "0.5.0",`
`35`	`35`	`"@inquirer/prompts": "7.0.0",`
	`36`	`+ "knip": "5.70.2",`
`36`	`37`	`"typescript": "5.6.3",`
`37`	`38`	`"unbuild": "2.0.0"`
`38`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`"build": "vite build"`
`9`	`9`	`},`
`10`	`10`	`"devDependencies": {`
`11`		`- "@caido/sdk-backend": "^0.46.0"`
	`11`	`+ "@caido/sdk-backend": "^0.46.0",`
	`12`	`+ "vite": "6.0.11"`
`12`	`13`	`}`
`13`	`14`	`}`