Skip to content

Commit e73e749

Browse files
committed
docs: add section headers to all .mdc and instructions.md files
Generated-by: aiautocommit
1 parent 7ab42a0 commit e73e749

23 files changed

Lines changed: 53 additions & 1 deletion

.cursor/rules/fastapi.mdc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@ description:
33
globs: app/routes/**/*.py
44
alwaysApply: false
55
---
6+
## FastAPI
7+
68
- When generating a HTTPException, do not add a `detail=` and use a named status code (`status.HTTP_400_BAD_REQUEST`)

.cursor/rules/pytest-integration-tests.mdc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ description:
33
globs: tests/integration/**/*.py
44
alwaysApply: false
55
---
6+
## Pytest Integration Tests
7+
68
- Look to tests/factories.py to generate any required database state
79
- Here's an example of how to create + persist a factory `DistributionFactory.build(domain=PYTHON_TEST_SERVER_HOST).save()`
810
- Add the `server` factory to each test

.cursor/rules/python-app.mdc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ description:
33
globs: **/*.py
44
alwaysApply: false
55
---
6+
## Python App
7+
68
* Files within `app/commands/` should have:
79
* Are not designed for CLI execution, but instead are interactor-style internal commands.
810
* Should not be used on the queuing system

.cursor/rules/python.mdc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ description:
33
globs: **/*.py
44
alwaysApply: false
55
---
6+
## Python
7+
68
When writing Python:
79

810
* Assume the latest python, version 3.13.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
22
description: Move logic into a client loader
33
---
4+
## React Router Client Loader
5+
6+
47
Do this in a `clientLoader` and use `loaderData` to render the component. DO NOT create mock data, new interfaces, or mock data loader functions. Instead, assume `loaderData` has all of the data you need to render the component.

.cursor/rules/react-router.mdc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ description:
33
globs: web/app/routes/**/*.tsx
44
alwaysApply: false
55
---
6+
## React Router
7+
68
- The primary export in a routes file should specify `loaderData` like `export default function RouteNamePage({ loaderData }: Route.ComponentProps)`. `loaderData` is the return value from `clientLoader`.
79
- When using an import from `~/configuration/client` (1) use `body:` for request params and (2) always `const { data, error } = await theCall()` (3) add `invariant(data, "error loading $xyz")`
810
- Use `href("/products/:id", { id: "abc123" })` to generate a url path for a route managed by the application.

.cursor/rules/react.mdc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ description:
33
globs: **/*.tsx
44
alwaysApply: false
55
---
6+
## React
7+
68
- Do not write any backend code. Just frontend logic.
79
- For any backend requirements, create mock responses. Use a function to return mock data so I can easily swap it out later.
810
- When creating mock data, always specify it in a dedicated `mock.ts` file

.cursor/rules/secrets.mdc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
description: Add or mutate system secrets
33
---
4+
## Secrets
5+
6+
47
Here's how environment variables are managed in this application:
58

69
- `.envrc` entry point to load the correct env stack. Should not contain secrets and should be simple some shell logic and direnv stdlib calls.

.cursor/rules/shell.mdc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@ description:
33
globs: **/*.sh
44
alwaysApply: false
55
---
6+
## Shell
7+
68
- Assume zsh for any shell scripts. The latest version of modern utilities like ripgrep (rg), fdfind (fd), bat, httpie (http), zq (zed), jq, procs, rsync are installed and you can request I install additional utilities.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
22
description: Add a docstring to a TypeScript file
33
---
4+
## TypeScript DocString
5+
6+
47
Add a file-level docstring with a simple description of what this file does.

0 commit comments

Comments
 (0)