Skip to content

chore: dev environment setup (lockfile fix + AGENTS.md) #19

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

Closed
getBoolean wants to merge 1 commit into from
Closed

chore: dev environment setup (lockfile fix + AGENTS.md) #19

Show file tree
Hide file tree
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
20 changes: 20 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# AGENTS.md

## Cursor Cloud specific instructions

This repo is a **Discord bot** (TypeScript + Discord.js, SQLite via Drizzle ORM). It runs directly from TypeScript with no compile step thanks to `@swc-node/register/esm`. Standard scripts live in `package.json`; setup/run details are in `README-dev.md`.

### Setup / dependencies
- Dependencies install via `npm ci` (the startup update script handles this). The native module `better-sqlite3` and the `@swc-node` loader must build successfully — they do on the default VM toolchain.

### Common commands
- Lint: `npm run lint:check` (use `npm run lint` to auto-fix).
- Typecheck: `npm run typecheck`.
- Tests: `npm test` (vitest, `--passWithNoTests`).
- Run the bot: `npm start`.

### Running the bot (non-obvious caveats)
- `npm start` requires real Discord credentials in `.env`: `TOKEN` and `CLIENT_ID`. Without them the bot throws `Required environment variable ... not set` at login. These are user-provided secrets; a live bot also needs a Discord application + a test server it has been invited to.
- The database is local SQLite at `data/main.sqlite` (gitignored). It is created automatically and **pending Drizzle migrations are auto-applied on startup** (`src/db/db.ts`). Do not run drizzle migrate manually unless authoring a new migration (`npx drizzle-kit generate`).
- The data layer (Drizzle + `better-sqlite3` + migrations) can be exercised without Discord credentials by importing `src/db/db.ts` / `src/db/schema.ts` and running queries under the same loader (`node --loader @swc-node/register/esm --env-file .env <file>.ts`). This is the core queue/event domain model.
- `better-sqlite3` is opened with `.defaultSafeIntegers()`, so integer columns are returned/bound as `bigint` — use `BigInt(...)` for integer values when writing ad-hoc scripts.
Loading