Skip to content

Commit 9834878

Browse files
maiieulmaiieul
authored
docs: convert Key Commands table to list in AGENTS.md (#8571)
* docs: convert Key Commands table to list in AGENTS.md * chore: prefer build/v2 for PRs
1 parent fddcd2f commit 9834878

1 file changed

Lines changed: 19 additions & 21 deletions

File tree

‎AGENTS.md‎

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -36,29 +36,27 @@ pnpm i
3636

3737
Use `pnpm build.full` only if you modified Rust/optimizer code.
3838

39-
Prefer `pnpm build --qwik --qwikrouter --dev` to build qwik and qwik-city faster.
39+
Prefer `pnpm build build.core.dev` to build qwik and qwik-router faster.
4040

4141
## Key Commands
4242

43-
| Task | Command | Notes |
44-
| ------------------------ | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
45-
| **Install** | `pnpm install` | |
46-
| **Build (no Rust)** | `pnpm build.local` | For a fresh start |
47-
| **Build (with Rust)** | `pnpm build.full` | Only for optimizer changes |
48-
| **Build core only** | `pnpm build.core` | Fast — just Qwik + Router + types |
49-
| **Dev rebuild** | `pnpm build.core.dev` | Very fast iterative rebuild |
50-
| **Watch mode** | `pnpm build.watch` | Rebuilds on change |
51-
| **Unit tests** | `pnpm vitest run` | Vitest — runs `packages/**/*.unit.{ts,tsx}` and `*.spec.{ts,tsx}`, or specify a single file. Add `-u` to update snapshots. **NEVER use `pnpm test.unit`** |
52-
| **E2E tests (Chromium)** | `pnpm test.e2e.chromium` | Playwright - always run the dev rebuild first! |
53-
| **E2E tests (Router)** | `pnpm test.e2e.router` | Router-specific E2E - always run the dev rebuild first! |
54-
| **Lint** | `pnpm lint` | ESLint + Prettier + Rust lint |
55-
| **Lint fix** | `pnpm lint.fix` | Auto-fix ESLint issues |
56-
| **Format** | `pnpm fmt` | Prettier + syncpack |
57-
| **Type check** | `pnpm tsc.check` | Full TypeScript check |
58-
| **Update API docs** | `pnpm api.update` | Regenerates public API `.md` files |
59-
| **Create changeset** | `pnpm change` | Interactive — creates `.changeset/*.md` |
60-
| **Dev server** | `pnpm serve` | Port 3300 |
61-
| **Docs dev** | `pnpm docs.dev` | Documentation site |
43+
- **Install** — `pnpm install`
44+
- **Build (no Rust)** — `pnpm build.local` — for a fresh start
45+
- **Build (with Rust)** — `pnpm build.full` — only for optimizer changes
46+
- **Build core only** — `pnpm build.core` — fast, just Qwik + Router + types
47+
- **Dev rebuild** — `pnpm build.core.dev` — very fast iterative rebuild
48+
- **Watch mode** — `pnpm build.watch` — rebuilds on change
49+
- **Unit tests** — `pnpm vitest run` — Vitest, runs `packages/**/*.unit.{ts,tsx}` and `*.spec.{ts,tsx}`, or specify a single file. Add `-u` to update snapshots. **NEVER use `pnpm test.unit`**
50+
- **E2E tests (Chromium)** — `pnpm test.e2e.chromium` — Playwright, always run the dev rebuild first!
51+
- **E2E tests (Router)** — `pnpm test.e2e.router` — Router-specific E2E, always run the dev rebuild first!
52+
- **Lint** — `pnpm lint` — ESLint + Prettier + Rust lint
53+
- **Lint fix** — `pnpm lint.fix` — auto-fix ESLint issues
54+
- **Format** — `pnpm fmt` — Prettier + syncpack
55+
- **Type check** — `pnpm tsc.check` — full TypeScript check
56+
- **Update API docs** — `pnpm api.update` — regenerates public API `.md` files
57+
- **Create changeset** — `pnpm change` — interactive, creates `.changeset/*.md`
58+
- **Dev server** — `pnpm serve` — port 3300
59+
- **Docs dev** — `pnpm docs.dev` — documentation site
6260

6361
### Running a Single Test File
6462

@@ -215,7 +213,7 @@ This creates a `.changeset/*.md` file describing the change. The core packages (
215213

216214
### Branch Strategy
217215

218-
- **Base branch for PRs:** `main`
216+
- **Base branch for PRs:** `build/v2`
219217
- **Release base branch:** `build/v2` (used by changesets)
220218
- Trunk-based development
221219

0 commit comments

Comments
 (0)