docs: add compact testing guidelines to project rules (#5353)

This commit is contained in:
Daniel 2025-07-02 17:48:50 -05:00 • committed by GitHub
parent 6355cb010c
commit c72f4a4b5e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -6,6 +6,12 @@
- Ensure all tests pass before submitting changes
- The vitest framework is used for testing; the `describe`, `test`, `it`, etc functions are defined by default in `tsconfig.json` and therefore don't need to be imported
- Tests must be run from the same directory as the `package.json` file that specifies `vitest` in `devDependencies`
- Run tests with: `npx vitest <relative-path-from-workspace-root>`
- Do NOT run tests from project root - this causes "vitest: command not found" error
- Tests must be run from inside the correct workspace:
- Backend tests: `cd src && npx vitest path/to/test-file` (don't include `src/` in path)
- UI tests: `cd webview-ui && npx vitest src/path/to/test-file`
- Example: For `src/tests/user.test.ts`, run `cd src && npx vitest tests/user.test.ts` NOT `npx vitest src/tests/user.test.ts`
2. Lint Rules: