roundMoney takes digits now, Currency is open with the dataset as authority, codes are identity, and an amount field parses its own currency. Also folds in the two CSS guards earned during the redesign. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
8.6 KiB
Default to using Bun instead of Node.js.
- Use
bun <file>instead ofnode <file>orts-node <file> - Use
bun testinstead ofjestorvitest - Use
bun build <file.html|file.ts|file.css>instead ofwebpackoresbuild - Use
bun installinstead ofnpm installoryarn installorpnpm install - Use
bun run <script>instead ofnpm run <script>oryarn run <script>orpnpm run <script> - Use
bunx <package> <command>instead ofnpx <package> <command> - Bun automatically loads .env, so don't use dotenv.
APIs
Bun.serve()supports WebSockets, HTTPS, and routes. Don't useexpress.bun:sqlitefor SQLite. Don't usebetter-sqlite3.Bun.redisfor Redis. Don't useioredis.Bun.sqlfor Postgres. Don't usepgorpostgres.js.WebSocketis built-in. Don't usews.- Prefer
Bun.fileovernode:fs's readFile/writeFile - Bun.$
lsinstead of execa.
Testing
Use bun test to run tests.
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:
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>
<body>
<h1>Hello, world!</h1>
<script type="module" src="./frontend.tsx"></script>
</body>
</html>
With the following 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
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, noDate.now(), nonew Date()without an explicit argument. It must be testable with no DOM.- Money is a float. Always round with
roundMoneyfromsrc/domain/money.tsafter any division, after any FX conversion, and before persisting. roundMoney(amount, digits)takes a DIGIT COUNT, not a currency code. Decimal places live inDataset.currencies, because the owner defines currencies; resolve them withdigitsFor(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. MonthIdis the string"YYYY-MM". Stored data never containsDateobjects.Currencyis an open string code;Dataset.currenciesis the authority. There is no global list of valid currencies any more. A code is IDENTITY — it keys the FX table and every storedMoney— so codes are normalised uppercase, are never editable, and a currency still referenced cannot be removed (currencyUsagenames what refers to it).parseDatasetJsonvalidates the table and everyMoneyagainst 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 inputtype="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 atry/catchaccessor — see the gotcha below. - A post's allocation is a dated series,
Post.rules: RuleVersion[], resolved byruleAt(post, monthId).Post.standingRuleno 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.valueinside amutate()callback.mutatedefers behind the write queue; React resets the input's DOM value first, so you commit the old value. Capture into aconstin the handler.src/ui/eventCapture.test.tsfails the build otherwise. process.env.BUN_PUBLIC_*must be read viatry/catch(seereadBasePathEnv). Bun inlines the literal only when the variable is set; unset, the bare reference reaches the browser and throws before the app boots. Atypeof processguard does not work — it survives inlining and discards the inlined value, silently breaking subpath deploys.- Never define a bare
--accentCSS 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.tsenforces it — and put brand colour on--primary, never--accent. Project tokens are--budget-*. - A
var(--token)naming a tokensrc/index.cssdoes not define paints NOTHING, silently. An undefined custom property invalidates the whole declaration: no warning, no throw, no fallback. Renaming--rulethis way killed the carry meter and no test noticed.src/ui/cssTokens.test.tsguards 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
bun scripts/screenshot.ts <url> <out.png> drives it over CDP: it waits past
the async IndexedDB read (which plain --screenshot does not), can seed data
with --eval-file, click with --click, and reports console errors and
uncaught exceptions. Read the PNG it writes — you can see the app. Use it
before claiming anything about layout.
Two things to know before trusting a screenshot:
- This container's fontconfig resolves every generic family to Fira Code, a
monospace font, so the whole UI renders monospaced in a way no real user
sees. Point
FONTCONFIG_FILEat an override that maps the generics to installed sans/mono faces, or you will "fix" a font bug that does not exist. - Chrome launches with a fresh profile each run, so IndexedDB starts empty and
the app re-seeds. Pass
--eval-file=<seed.js> --reloadfor populated data.
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.