groundwork / rules
Cursor rule0 starsChanged 50 days agoMITView on GitHub
NestJS API conventions (apps/api)
In this repository15 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- .cursor/rules/000-project.mdcCursor rule
- .cursor/rules/010-typescript.mdcCursor rule
- .cursor/rules/030-web.mdcCursor rule
- .cursor/rules/040-database.mdcCursor rule
- .cursor/rules/050-worker.mdcCursor rule
- .cursor/rules/060-testing.mdcCursor rule
- llms.txtllms.txt
- add-endpointSkill
- db-migrationSkill
- new-moduleSkill
- verifySkill
- write-testsSkill
The file
Files
--- description: NestJS API conventions (apps/api) globs: ['apps/api/**'] alwaysApply: false --- See `apps/api/AGENTS.md`. In short: - Controllers are thin: DTO in, one action, `DomainException(result.error)` on failure, `@ZodResponse` out. - Actions: `@Injectable()` with one `execute()`, returning `Result<T, ErrorCode>` via `ok()` / `fail()`. - Repositories take the executor first and scope every query by owner (another owner's row is `not_found`). - Multi-statement writes in `db.transaction()`; side effects via `registerAfterCommitHook`. - New error code: `packages/shared/src/errors.ts` + `error-catalog.ts` + `apps/web/src/lib/errors.ts`. - Protect routes with `@Authenticated()`; throttle credential endpoints with `@AuthThrottle()`.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.