Skip to content

Add AGENTS.md for Cursor Cloud development environment setup #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
evermake wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −0
Draft

Add AGENTS.md for Cursor Cloud development environment setup #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# AGENTS.md

## Cursor Cloud specific instructions

This is a **pure TypeScript library** (`@grom.js/tgx`) — a JSX runtime for composing Telegram Bot messages. There are no services, databases, or Docker containers.

### Key commands

All commands are in `package.json` scripts. Quick reference:

| Task | Command |

Check failure on line 11 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Lint 

Replace `|·Command·` with `········|·Command·······························································`
|---|---|

Check failure on line 12 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Lint 

Replace `---|---` with `·------------·|·---------------------------------------------------------------------·`
| Install deps | `pnpm install --frozen-lockfile` |

Check failure on line 13 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Lint 

Insert `·····································`
| Lint | `pnpm run lint` |

Check failure on line 14 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Lint 

Replace `|·`pnpm·run·lint`·` with `········|·`pnpm·run·lint`·······················································`
| Typecheck | `pnpm run typecheck` |

Check failure on line 15 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Lint 

Replace `|·`pnpm·run·typecheck`·` with `···|·`pnpm·run·typecheck`··················································`
| Test | `pnpm run test` (watch mode) or `pnpm run test -- --run` (single run) |

Check failure on line 16 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Lint 

Insert `········`
| Build | `pnpm run build` |

Check failure on line 17 in AGENTS.md

View workflow job for this annotation

GitHub Actions / Lint 

Replace `|·`pnpm·run·build`` with `·······|·`pnpm·run·build`·····················································`

### Gotchas

- **TypeScript is not a direct devDependency** — it is resolved transitively via `@antfu/eslint-config`. The `tsc` binary is not accessible via `pnpm exec`. The update script installs `typescript` globally to make `tsc` available for `build` and `typecheck` scripts.
- **esbuild postinstall**: pnpm may warn about ignored build scripts for `esbuild`. This does not affect vitest (which bundles its own esbuild wasm fallback) but may emit a warning during install.
- **Vitest runs in watch mode by default** — use `pnpm run test -- --run` for a single pass.
- **ESM only** — the package uses `"type": "module"`. All dist output is ESM.
Loading