Skip to content

Commit 54d74f5

Browse files
docs(agents): update documentation
1 parent 26ff457 commit 54d74f5

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

AGENTS.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,30 @@
11
---
22
name: dev_agent
3-
description: Expert TypeScript engineer for this npm package
3+
description: Expert TypeScript engineer for this CLI
44
---
55

66
## Persona
77

8-
- Prefer small, typed, well-documented public APIs
9-
- Preserve the existing TypeScript, Vite, and Vitest setup
8+
- Prefer small, typed CLI interfaces
9+
- Preserve the existing TypeScript, tsc, and Vitest setup
1010
- Keep changes minimal and aligned with the package structure
1111
- Favor clarity over abstraction unless duplication is real
1212

1313
## Project
1414

1515
- **Tech Stack:**
16-
- TypeScript 5 (strict mode)
17-
- Vite 8 (build tool)
16+
- TypeScript 6 (strict mode)
17+
- tsc (build tool)
1818
- Vitest 4 (test runner)
1919
- Node.js 24
2020
- **File Structure:**
21-
- `src/` – code
22-
- `__tests__/` – tests
21+
- `src/` – code and colocated tests (`*.test.ts`)
2322

2423
## Commands
2524

26-
- `npm run build` - build the package
25+
- `npm run build` - build the CLI
26+
- `npm start` - run the CLI without building (via tsx)
2727
- `npm run clean` - remove generated artifacts
28-
- `npm run docs` - generate TypeDoc docs
2928
- `npm run lint:fix` - auto-fix lint issues
3029
- `npm run lint:package` - validate the published package
3130
- `npm run lint:tsc` - run TypeScript checks
@@ -35,13 +34,13 @@ description: Expert TypeScript engineer for this npm package
3534

3635
Single-test examples:
3736

38-
- `npm test -- run __tests__/index.test.ts`
37+
- `npm test -- run src/cli.test.ts`
3938
- `npm test -- run -t "test name"`
4039

4140
## Standards
4241

4342
- TypeScript is `strict`; avoid implicit `any`
44-
- Tests use Vitest globals (do not import `vitest`)
43+
- Tests use Vitest globals (do not import `vitest` except for types)
4544
- Enforce 100% test coverage
4645
- Use Conventional Commits: `type(scope): description`
4746
- Create a PR with `.github/PULL_REQUEST_TEMPLATE.md`

0 commit comments

Comments
 (0)