You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-**Package Manager**: `npm` / `bun`. All scripts are defined in `package.json` and are **compatible with `bun run <script>`**.
29
+
-**Package Manager**: `bun`. All scripts are defined in `package.json` and are **compatible with `bun run <script>`**.
30
30
-**Path Alias**: `@/*` resolves to `src/*` (defined in `vite.config.ts` & `tsconfig.json`).
31
-
-**Code Generation**: GraphQL types & hooks are generated via `npm run generate:graphql`.
31
+
-**Code Generation**: GraphQL types & hooks are generated via `bun run generate:graphql`.
32
32
-**Testing**: Vitest + React Testing Library + MSW for API mocking.
33
33
-**Formatting**: Prettier with `prettier-plugin-tailwindcss` (installed but configuration falls back to defaults).
34
34
35
35
---
36
36
37
37
## Common Development Commands
38
38
39
+
**CRITICAL:** Before running any tests or building the project, **always regenerate the GraphQL files** to ensure they are up‑to‑date. Run:
40
+
41
+
```bash
42
+
bun run generate:graphql
43
+
```
44
+
45
+
This command re‑generates the GraphQL types and hooks (e.g., `src/graphql/generated.ts`). It must be executed any time the GraphQL schema changes and must be run before `bun run test` or `bun run build`. Ensure this step is included in any CI pipeline or local workflow.
- The **ESLint** config extends `eslint:recommended`, `@typescript-eslint/recommended`, and `plugin:react-hooks/recommended`.
186
194
-**Prettier** is enforced via `eslint-config-prettier` – any formatting deviation is reported as an ESLint error.
187
-
-**`npm run lint`** fails on **any warning** (`--max-warnings 0`).
188
-
- CI (GitHub Actions) runs `npm ci && npm run lint && npm run test && npm run coverage`.
195
+
-**`bun run lint`** fails on **any warning** (`--max-warnings 0`).
196
+
- CI (GitHub Actions) runs `bun install && bun run lint && bun run test && bun run coverage`.
189
197
- No `--fix` flag is used in CI – agents must commit correctly formatted code.
190
198
191
199
---
@@ -209,15 +217,17 @@ The repository does **not** contain a `.cursor/` directory or a `.github/copilot
209
217
210
218
---
211
219
212
-
**Agent Restrictions**: Agents must not modify any files outside the project directory.
220
+
**Agent Restrictions**: Agents must not modify any files outside the project directory.
221
+
222
+
**CRITICAL:** Agents must **never** modify any auto‑generated files (e.g., GraphQL generated files such as `src/graphql/generated.ts`).
213
223
214
224
**CRITICAL:** Agents must **never** commit any changes without **explicit user permission**. ALWAYS ask for review and obtain approval **before** running any `git add` / `git commit` commands.
215
225
216
226
**Shell Environment**: Agents should execute commands using **zsh** (as the user’s default shell) to ensure compatibility with tools installed in that environment.
217
227
218
-
**Node Version Management**: Agents must always verify that **nvm** (Node Version Manager) is installed before invoking any `node`or `npm`commands. If `nvm` is not available, they should inform the user and suggest installing it. Agents should never run Node directly without first ensuring the appropriate version is selected via `nvm`.
228
+
**Node Version Management**: Agents must always verify that **nvm** (Node Version Manager) is installed before invoking any `node` commands. If `nvm` is not available, they should inform the user and suggest installing it. Agents should never run Node directly without first ensuring the appropriate version is selected via `nvm`.
219
229
220
-
**Package Manager Preference**: All dependency management should be performed using **bun**. Agents must use `bun install` (or `bun add`/`bun remove` as appropriate) instead of `npm install`. Before running any bun command, agents must check that **bun** is installed; if it is missing, they should inform the user and suggest installing bun (e.g., via `curl -fsSL https://bun.sh/install | bash`).
230
+
**Package Manager Preference**: All dependency management should be performed using **bun**. **Important:** Always use `bun` for all commands in this project; any other package manager must not be used. Agents must use `bun install` (or `bun add`/`bun remove` as appropriate) instead of any other package manager. Before running any bun command, agents must check that **bun** is installed; if it is missing, they should inform the user and suggest installing bun (e.g., via `curl -fsSL https://bun.sh/install | bash`).
221
231
222
232
**Branch Management**: Agents must avoid making code changes directly on the **main** (or **master**) branch. Any modification to code should be performed on a separate feature branch. Agents should always ask for explicit user permission before creating a new branch, and must recommend creating one when working on the main branch.
0 commit comments