Skip to content

Commit 66f52ce

Browse files
abnegateclaude
andcommitted
fix: address review bot comments on AGENTS.md and CLAUDE.md
- Standardize `bun run` prefix across all commands table entries - Fix database types table: mark vectorsdb as not yet implemented, dedicateddb as cross-repo - Remove inaccurate DedicatedDB/Compute service claim from console docs - Add $bindable() usage context in Svelte 5 runes example - Note Dependencies enum has 66+ keys for cache invalidation - Mention isSelfHosted alongside isCloud for feature gating - Add explanatory comment in CLAUDE.md for @AGENTS.md syntax Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent de112e3 commit 66f52ce

2 files changed

Lines changed: 25 additions & 24 deletions

File tree

AGENTS.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@ SvelteKit web dashboard for Appwrite. Manages projects, databases, functions, au
44

55
## Commands
66

7-
All commands use **bun** (not pnpm/npm).
8-
9-
| Command | Purpose |
10-
| --------------------- | --------------------------------------------- |
11-
| `bun dev` | Dev server (port 3000) |
12-
| `bun run build` | Production build (custom `build.js` via Vite) |
13-
| `bun check` | `svelte-kit sync && svelte-check` |
14-
| `bun format` | Prettier write + cache |
15-
| `bun run lint` | Prettier check + ESLint |
16-
| `bun tests` | Unit + E2E |
17-
| `bun test:unit` | Vitest (TZ=EST) |
18-
| `bun test:unit-watch` | Vitest watch mode |
19-
| `bun test:e2e` | Playwright |
20-
| `bun run clean` | Remove node_modules, .svelte-kit, reinstall |
7+
All commands use **bun** (not pnpm/npm). Use `bun run <script>` consistently — `bun run build` is required to avoid invoking bun's built-in bundler.
8+
9+
| Command | Purpose |
10+
| ------------------------- | --------------------------------------------- |
11+
| `bun run dev` | Dev server (port 3000) |
12+
| `bun run build` | Production build (custom `build.js` via Vite) |
13+
| `bun run check` | `svelte-kit sync && svelte-check` |
14+
| `bun run format` | Prettier write + cache |
15+
| `bun run lint` | Prettier check + ESLint |
16+
| `bun run tests` | Unit + E2E |
17+
| `bun run test:unit` | Vitest (TZ=EST) |
18+
| `bun run test:unit-watch` | Vitest watch mode |
19+
| `bun run test:e2e` | Playwright |
20+
| `bun run clean` | Remove node_modules, .svelte-kit, reinstall |
2121

2222
**Always run before committing:** `bun run format && bun run check && bun run lint && bun run tests && bun run build`
2323

@@ -119,6 +119,7 @@ Runes (Svelte 5 -- preferred for new and modified code):
119119

120120
```svelte
121121
<script lang="ts">
122+
// $bindable() enables two-way binding so parent components can mutate items directly
122123
let { items = $bindable(), disabled = false }: Props = $props();
123124
let selected = $state<string | null>(null);
124125
const count = $derived(items.length);
@@ -149,18 +150,17 @@ await sdk.forProject(region, projectId).tablesDB.listTables();
149150

150151
### Database types (feat-dedicated-db)
151152

152-
The databases feature unifies four database backends behind a polymorph API (`$database/(entity)/helpers/sdk.ts`):
153+
The databases feature unifies multiple database backends behind a polymorph API (`$database/(entity)/helpers/sdk.ts`):
153154

154-
| Type | Entity | Field | Record |
155-
| ------------- | ---------- | --------- | -------- |
156-
| `tablesdb` | table | column | row |
157-
| `documentsdb` | collection | attribute | document |
158-
| `vectorsdb` | collection | attribute | document |
159-
| `dedicateddb` | table | column | row |
155+
| Type | Entity | Field | Record | Status |
156+
| ------------- | ---------- | --------- | -------- | ------------------------ |
157+
| `tablesdb` | table | column | row | Implemented |
158+
| `documentsdb` | collection | attribute | document | Implemented |
159+
| `vectorsdb` | -- | -- | -- | Not yet implemented |
160+
| `dedicateddb` | table | column | row | Cross-repo (cloud/edge) |
160161

161162
- `useDatabaseSdk()` returns a unified interface regardless of backing type
162163
- `useTerminology()` returns singular/plural names for the current database type
163-
- DedicatedDB uses the `Compute` service (not Appwrite schema APIs) -- creates always-on PostgreSQL/MySQL instances via `compute.createDatabase()` with `Backend.Edge`
164164

165165
### Data loading
166166

@@ -173,7 +173,7 @@ export const load: LayoutLoad = async ({ depends, parent, params }) => {
173173
};
174174
```
175175

176-
Invalidate with `await invalidate(Dependencies.DATABASE)` after mutations. Dependency keys defined in `src/lib/constants.ts` as the `Dependencies` enum.
176+
Invalidate with `await invalidate(Dependencies.DATABASE)` after mutations. The `Dependencies` enum in `src/lib/constants.ts` defines 66+ keys for fine-grained cache invalidation (e.g. `DATABASES`, `TABLES`, `FUNCTIONS`, `USERS`, `DEPLOYMENTS`).
177177

178178
### State management
179179

@@ -198,7 +198,7 @@ Plausible + custom Growth endpoint. Track events via `trackEvent(Click.* | Submi
198198

199199
### Theming and modes
200200

201-
Four theme variants in `src/themes/`: `light`, `dark`, `light-cloud`, `dark-cloud`. Resolved based on `isCloud` flag and user preference. Two modes (`src/lib/system.ts`): `cloud` and `self-hosted`, set via `PUBLIC_CONSOLE_MODE` env var. Gate cloud-only features with `isCloud`.
201+
Four theme variants in `src/themes/`: `light`, `dark`, `light-cloud`, `dark-cloud`. Resolved based on `isCloud` flag and user preference. Two modes (`src/lib/system.ts`): `cloud` and `self-hosted`, set via `PUBLIC_CONSOLE_MODE` env var. Gate features using `isCloud` (for cloud-only) or `isSelfHosted` (for self-hosted-only).
202202

203203
## Code style
204204

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
<!-- Loads AGENTS.md into AI assistant context -->
12
@AGENTS.md

0 commit comments

Comments
 (0)