Two things this session depended on lived only in a scratchpad, so the next agent would have had to reinvent them from a prose hint: - scripts/screenshot-fonts.conf, now applied by screenshot.ts itself. Without it this container renders every generic font family as Fira Code and the UI looks monospaced in a way no user sees — a trap that nearly produced a "fix" for a font bug that does not exist. - scripts/demo-data.ts, which seeds a visibly synthetic dataset. Without it every screenshot shows an app full of zeros, because Chrome starts from a fresh profile each run. CLAUDE.md now carries the two-command recipe verbatim instead of "point FONTCONFIG_FILE at an override", and says why --reload is mandatory. Verified from a clean shell with no environment set. Also flags docs/superpowers/plans/2026-09-01-budget-app.md as a historical record: its snippets still show CURRENCIES and CURRENCY_DIGITS, which no longer exist, and an agent reading it as current would be misled. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
232 lines
9.3 KiB
Markdown
232 lines
9.3 KiB
Markdown
|
|
Default to using Bun instead of Node.js.
|
|
|
|
- Use `bun <file>` instead of `node <file>` or `ts-node <file>`
|
|
- Use `bun test` instead of `jest` or `vitest`
|
|
- Use `bun build <file.html|file.ts|file.css>` instead of `webpack` or `esbuild`
|
|
- Use `bun install` instead of `npm install` or `yarn install` or `pnpm install`
|
|
- Use `bun run <script>` instead of `npm run <script>` or `yarn run <script>` or `pnpm run <script>`
|
|
- Use `bunx <package> <command>` instead of `npx <package> <command>`
|
|
- Bun automatically loads .env, so don't use dotenv.
|
|
|
|
## APIs
|
|
|
|
- `Bun.serve()` supports WebSockets, HTTPS, and routes. Don't use `express`.
|
|
- `bun:sqlite` for SQLite. Don't use `better-sqlite3`.
|
|
- `Bun.redis` for Redis. Don't use `ioredis`.
|
|
- `Bun.sql` for Postgres. Don't use `pg` or `postgres.js`.
|
|
- `WebSocket` is built-in. Don't use `ws`.
|
|
- Prefer `Bun.file` over `node:fs`'s readFile/writeFile
|
|
- Bun.$`ls` instead of execa.
|
|
|
|
## Testing
|
|
|
|
Use `bun test` to run tests.
|
|
|
|
```ts#index.test.ts
|
|
import { test, expect } from "bun:test";
|
|
|
|
test("hello world", () => {
|
|
expect(1).toBe(1);
|
|
});
|
|
```
|
|
|
|
## Frontend
|
|
|
|
Use HTML imports with `Bun.serve()`. Don't use `vite`. HTML imports fully support React, CSS, Tailwind.
|
|
|
|
Server:
|
|
|
|
```ts#index.ts
|
|
import index from "./index.html"
|
|
|
|
Bun.serve({
|
|
routes: {
|
|
"/": index,
|
|
"/api/users/:id": {
|
|
GET: (req) => {
|
|
return new Response(JSON.stringify({ id: req.params.id }));
|
|
},
|
|
},
|
|
},
|
|
// optional websocket support
|
|
websocket: {
|
|
open: (ws) => {
|
|
ws.send("Hello, world!");
|
|
},
|
|
message: (ws, message) => {
|
|
ws.send(message);
|
|
},
|
|
close: (ws) => {
|
|
// handle close
|
|
}
|
|
},
|
|
development: {
|
|
hmr: true,
|
|
console: true,
|
|
}
|
|
})
|
|
```
|
|
|
|
HTML files can import .tsx, .jsx or .js files directly and Bun's bundler will transpile & bundle automatically. `<link>` tags can point to stylesheets and Bun's CSS bundler will bundle.
|
|
|
|
```html#index.html
|
|
<html>
|
|
<body>
|
|
<h1>Hello, world!</h1>
|
|
<script type="module" src="./frontend.tsx"></script>
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
With the following `frontend.tsx`:
|
|
|
|
```tsx#frontend.tsx
|
|
import React from "react";
|
|
import { createRoot } from "react-dom/client";
|
|
|
|
// import .css files directly and it works
|
|
import './index.css';
|
|
|
|
const root = createRoot(document.body);
|
|
|
|
export default function Frontend() {
|
|
return <h1>Hello, world!</h1>;
|
|
}
|
|
|
|
root.render(<Frontend />);
|
|
```
|
|
|
|
Then, run index.ts
|
|
|
|
```sh
|
|
bun --hot ./index.ts
|
|
```
|
|
|
|
For more information, read the Bun API docs in `node_modules/bun-types/docs/**.mdx`.
|
|
|
|
## Project invariants (Budget 2.0)
|
|
|
|
- `src/domain/` is pure: no React, no IndexedDB, no `Date.now()`, no `new Date()`
|
|
without an explicit argument. It must be testable with no DOM.
|
|
- Money is a float. Always round with `roundMoney` from `src/domain/money.ts`
|
|
after any division, after any FX conversion, and before persisting.
|
|
- **`roundMoney(amount, digits)` takes a DIGIT COUNT, not a currency code.**
|
|
Decimal places live in `Dataset.currencies`, because the owner defines
|
|
currencies; resolve them with `digitsFor(dataset.currencies, code)`. The
|
|
argument is required on purpose — a default of 2 is right for every currency
|
|
the app shipped with, so a missed call site would pass every test and be
|
|
silently wrong for the first zero-decimal currency added.
|
|
- When splitting an amount, never round the last part independently. Compute it
|
|
as `total - sum(others)` so the parts sum exactly to the whole.
|
|
- `MonthId` is the string `"YYYY-MM"`. Stored data never contains `Date` objects.
|
|
- **`Currency` is an open string code; `Dataset.currencies` is the authority.**
|
|
There is no global list of valid currencies any more. A code is IDENTITY — it
|
|
keys the FX table and every stored `Money` — so codes are normalised
|
|
uppercase, are never editable, and a currency still referenced cannot be
|
|
removed (`currencyUsage` names what refers to it). `parseDatasetJson`
|
|
validates the table and every `Money` against it; that boundary check is
|
|
what replaced the compile-time safety of the old closed union.
|
|
- The envelope rollover fold has exactly one implementation, in
|
|
`src/domain/fold.ts`. Year and summary views aggregate over it — they never
|
|
reimplement the math.
|
|
- Over-budget is always allowed. Never add validation that blocks it.
|
|
- An amount field parses its own currency: "30$" is thirty dollars. Use
|
|
`parseMoneyInput` (`src/ui/moneyInput.ts`) and keep the input `type="text"` —
|
|
a number input discards the "$" before the parser ever sees it.
|
|
- Base path comes from `BUN_PUBLIC_BASE_PATH`; never hardcode a subpath, and
|
|
read it through a `try/catch` accessor — see the gotcha below.
|
|
- A post's allocation is a dated series, `Post.rules: RuleVersion[]`, resolved by
|
|
`ruleAt(post, monthId)`. `Post.standingRule` no longer exists. A post with no
|
|
applicable version allocates zero; a per-month override still wins outright.
|
|
- Posts are archived, never deleted, because purchases reference them. Archived
|
|
posts still fold.
|
|
|
|
## Start here
|
|
|
|
- `ARCHITECTURE.md` — layers, data flow, and why the non-obvious choices are
|
|
what they are. Read it before changing anything structural.
|
|
- `TODO.md` — queued work, each item carrying the reasoning already settled.
|
|
- `PRODUCT.md` — who this is for and what must never break.
|
|
- `docs/superpowers/specs/` — design decisions, including alternatives rejected.
|
|
|
|
## Gotchas that cost real bugs
|
|
|
|
Each of these shipped once. Re-introducing one is a regression, not a style
|
|
choice.
|
|
|
|
- **Never read `event.target.value` inside a `mutate()` callback.** `mutate`
|
|
defers behind the write queue; React resets the input's DOM value first, so
|
|
you commit the old value. Capture into a `const` in the handler.
|
|
`src/ui/eventCapture.test.ts` fails the build otherwise.
|
|
- **`process.env.BUN_PUBLIC_*` must be read via `try/catch`** (see
|
|
`readBasePathEnv`). Bun inlines the literal only when the variable is set;
|
|
unset, the bare reference reaches the browser and throws before the app boots.
|
|
A `typeof process` guard does not work — it survives inlining and discards the
|
|
inlined value, silently breaking subpath deploys.
|
|
- **Never define a bare `--accent` CSS variable.** shadcn owns it as a hover
|
|
BACKGROUND paired with `--accent-foreground`; setting one without the other
|
|
drops hover contrast below WCAG AA app-wide. Redefine shadcn tokens only in
|
|
pairs — `src/cssPairs.test.ts` enforces it — and put brand colour on
|
|
`--primary`, never `--accent`. Project tokens are `--budget-*`.
|
|
- **A `var(--token)` naming a token `src/index.css` does not define paints
|
|
NOTHING, silently.** An undefined custom property invalidates the whole
|
|
declaration: no warning, no throw, no fallback. Renaming `--rule` this way
|
|
killed the carry meter and no test noticed. `src/ui/cssTokens.test.ts` guards
|
|
it.
|
|
- **A React error boundary does not catch event-handler throws.** Domain
|
|
functions that throw must be guarded at the call site when called from one.
|
|
- **Do not "fix" a domain throw by making it return a fallback.** Silently wrong
|
|
numbers are worse than a visible error in a budgeting app.
|
|
|
|
## Deliberately absent validation
|
|
|
|
Adding a "missing" guard here is a regression:
|
|
|
|
- going over budget, anywhere;
|
|
- allocation percentages summing past 100%;
|
|
- splits that do not sum to the total (the remainder-absorbing split reconciles
|
|
them by design);
|
|
- negative amounts — a refund is a normal line.
|
|
|
|
## Verification limits
|
|
|
|
**There IS a browser here.** `google-chrome` is on PATH, and
|
|
`scripts/screenshot.ts` drives it over CDP — it waits past the async IndexedDB
|
|
read (which Chrome's own `--screenshot` does not, which is why the docs used to
|
|
claim no browser existed), and it reports console errors and uncaught
|
|
exceptions. Read the PNG it writes. Use it before claiming anything about
|
|
layout.
|
|
|
|
The whole recipe, from a running `bun run dev`:
|
|
|
|
```sh
|
|
bun scripts/demo-data.ts /tmp/seed.js
|
|
bun scripts/screenshot.ts http://localhost:3000/month/2026-09 /tmp/shot.png \
|
|
--eval-file=/tmp/seed.js --reload
|
|
```
|
|
|
|
Then read `/tmp/shot.png`. Other flags: `--dark`, `--full`, `--w/--h`,
|
|
`--click=<selector>`, `--profile=<dir>` (keeps a service worker and IndexedDB
|
|
across runs — required for anything stateful), `--eval-after-file` (observe a
|
|
flow that ends in a navigation from the far side of it).
|
|
|
|
Two things that would otherwise waste your time:
|
|
|
|
- **`--reload` is not optional.** Chrome starts from a fresh profile each run,
|
|
so the app re-seeds itself empty; seeding IndexedDB only takes effect on the
|
|
next boot. Without it every screenshot shows an app full of zeros.
|
|
- **This container's fontconfig resolves every generic family to Fira Code, a
|
|
monospace font.** The UI then renders monospaced in a way no real user sees,
|
|
and the last agent to look nearly "fixed" a font bug that did not exist.
|
|
`scripts/screenshot-fonts.conf` corrects it and the script applies it
|
|
automatically — do not undo that, and do not trust a screenshot taken with
|
|
`FONTCONFIG_FILE` set to something else.
|
|
|
|
Still **not** verifiable here, so do not claim it: real offline behaviour, the
|
|
install and update prompts, opening the generated `.ods` in a spreadsheet, and
|
|
anything about how the design *feels*. A screenshot proves a layout exists and
|
|
is not broken; it does not prove it is good. Substitute a real check where one
|
|
exists — structural validation of the `.ods`, curl against the dev server,
|
|
pure-function tests — and state plainly what still needs a human.
|