About generate-program
A skill for generating complete Foldkit programs from written requirements. It analyzes state, interactions, async work, and UI needs, then consults tiered examples and production code; unclear behavior prompts targeted questions before implementation.
Key features
- 01Analyze entities, interactions, and async work
- 02Identify routing, UI, and validation needs
- 03Read examples by complexity tier
- 04Follow production code quality references
- 05Clarify behavioral gaps before implementation
Use cases
- 01Generate a Foldkit app from a description
- 02Plan multi-page or real-time app structure
- 03Resolve state transitions and edge cases
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ foldkit/ foldkit --skill generate-programAfter installing, type/generate-programin Claude Code to confirm it loaded.
Bundled files
References and scripts installed along with SKILL.md.
architecture.mdblindSpots.mdchecklist.mdconventions.mdagents/openai.yamlDetails
From the project READMEGenerate a complete Foldkit program based on this description:
$ARGUMENTS
Phase 1: Analyze the Description
Before writing any code, analyze the description to identify:
- Domain entities: nouns that become Model fields (e.g., "todos", "user", "score")
- User interactions: verbs that become Messages (e.g., "add", "delete", "filter", "submit")
- Async operations: external data that becomes Commands (e.g., "fetch weather", "save to localStorage")
- Real-time needs: streaming data that becomes Subscriptions (e.g., "live updates", "countdown", "WebSocket")
- Pages/navigation: URL structure that becomes routes (e.g., "home page", "detail page")
- UI component needs: interactive widgets that map to Foldkit UI components (e.g., "dropdown" → Menu, "modal" → Dialog, "tabs" → Tabs, "autocomplete" → Combobox, "date picker" → DatePicker, "file upload" → FileDrop, "reorderable list" → DragAndDrop, "toast/notification" → Toast, "hover tooltip" → Tooltip, "range/price filter" → Slider, "long scrolling list" → VirtualList)
- Form validation needs: required fields, format checks, async uniqueness →
foldkit/fieldValidationmodule (see Phase 4) - Date handling: birthdays, deadlines, scheduling →
Calendarmodule +DatePickerorCalendarfrom@foldkit/ui - File handling: uploads, attachments, images →
Filemodule +FileDropfrom@foldkit/ui - Remote data: anything fetched, cached, refreshed, or revalidated → the
AsyncDatamodule (see Phase 4). Don't hand-roll a loading/error union - Multi-state flows: a described process that moves through several named steps with rules about which step follows which (checkout, onboarding, multi-step approval, a connection lifecycle) → consider the
Machinemodule (foldkit/experimental). Writing the transitions as a table letsunreachableStates()anddeadTransitions()inspect reachability through the declared Edges frominitialand any caller-supplied extra roots. The analysis cannot see state changes made outside the Machine, so pass restored, deep-linked, hydrated, and other externally entered states as extra roots before treating its findings as application defects. Present it as an experimental option and let the user choose. For a flow with only two or three states, usedefineTaggedUnionand onematch.repos/foldkit/examples/state-machine/is the reference - Host embedding: the program runs inside another app ("a widget in our React app", "embed this in an existing page", "the host needs to control it") →
Runtime.makeElementplus theRuntime.embedlifecycle handle, with Flags for initial data and Ports for ongoing communication in both directions.repos/foldkit/examples/embedding/is the canonical reference: a plain TypeScript host driving a Foldkit widget end to end
Present this analysis to the user before proceeding.
If the description is detailed and unambiguous, summarize the analysis and confirm before moving on. But if there are gaps (unclear state transitions, vague UI requirements, unspecified error handling, missing edge cases, ambiguous domain boundaries, unclear counter/reset semantics), ask targeted clarifying questions before proceeding. Don't ask open-ended questions like "anything else?". Ask specific questions about the gaps you found.
UX/behavior gaps:
- "Should the todo list persist across page reloads (localStorage), or start fresh each session?"
- "When the API call fails, should the app show an inline error or a dialog?"
- "You mentioned 'users can edit items'. Is that inline editing or a separate edit page?"
Domain-logic gaps (easy to miss, expensive to fix):
- "When the user skips an interval, does that count as 'completed' for purposes of the streak?"
- "Does a counter that tracks 'completed' increments on successful actions only, or on skipped actions too?"
- "If the user triggers a reset mid-flow, does the counter reset with it, or persist across resets?"
- "You mentioned 'after N events, trigger X'. Is that N events total, or N events since the last X?"
- "On the Nth action in a cycle, which action does it trigger, the cycle's first or last?"
Domain-logic questions often surface off-by-one bugs before they hit the code. If the description has any counter, cycle, streak, or "after N" phrase, ask about edge cases at 0 and 1 and N specifically.
The goal is to resolve ambiguity early so the generated code matches what the user actually wants, not what you assumed.
Phase 2: Study Reference Examples
Read the architecture and conventions guides to internalize the rules:
- Architecture guide: TEA structure, file organization, type patterns
- Conventions guide: naming, Effect-TS patterns, anti-patterns
- Verification checklist: not just for Phase 5, also the generation bar. Skim the Quality Bar section now so you generate code that already meets it rather than code that will fail review.
- Blind spots: what the Phase 6 reviewer will grade you against. Reading it now is cheaper than fixing it later.
These four files are a snapshot of a moving codebase. When they disagree with the live source (repos/foldkit/, or the .d.ts in node_modules), the live source is right. Treat the disagreement as a bug in this skill and say so in your final report.
If you have access to a context7 MCP tool, use it to look up Effect-TS documentation when you're unsure about an API. Effect is a large library. Verify function signatures rather than guessing.
Quality exemplars
Two codebases are the quality bar for generated apps. Not just "patterns to copy" but "the level of craft to match":
${CLAUDE_SKILL_DIR}/../../packages/typing-game/client/src/: production multi-page app: Submodels, OutMessage, update/view decomposition, curried handler extraction, subscription patterns, domain modules.${CLAUDE_SKILL_DIR}/../../packages/website/src/: production Foldkit website: page organization, shared view primitives, route-driven rendering, idiomatic domain separation.
Before generating, spot-check at least ONE file from each (the shape of update.ts / how handlers get extracted / how domain files are structured) and match that level of craft in your output. The generated code should be indistinguishable from hand-written exemplar code.
Then read the tier-specific example files that match the app's complexity. Always read at least one tier-specific example. Never generate from memory alone.
Complexity tiers
Tier 1: Single page, no async, minimal state:
Read ${CLAUDE_SKILL_DIR}/../../examples/counter/src/main.ts
Tier 2: Timers, subscriptions, simple stateful apps:
Read ${CLAUDE_SKILL_DIR}/../../examples/stopwatch/src/main.ts (timer via subscription, Duration field pattern) and ${CLAUDE_SKILL_DIR}/../../examples/todo/src/main.ts (CRUD with localStorage via Flags)
Tier 3: Async operations, loading/error states, API calls, form validation:
Read ${CLAUDE_SKILL_DIR}/../../examples/weather/src/main.ts (HTTP with HttpClient) and ${CLAUDE_SKILL_DIR}/../../examples/form/src/main.ts (uses foldkit/fieldValidation; see the Form Validation section in Phase 4)
Tier 4: URL routing, multiple pages, query parameters:
Read ${CLAUDE_SKILL_DIR}/../../examples/routing/src/main.ts and ${CLAUDE_SKILL_DIR}/../../examples/query-sync/src/main.ts
Tier 5: Complex state, nested domain models, CRUD, drag-and-drop:
Read ${CLAUDE_SKILL_DIR}/../../examples/shopping-cart/src/main.ts (nested domain schemas, cart state) and ${CLAUDE_SKILL_DIR}/../../examples/kanban/src/main.ts (CRUD with DragAndDrop, Flags restoring from localStorage, subscriptions)
Tier 6: Submodels, OutMessage, multi-step forms, auth flows, multi-module apps:
Read ${CLAUDE_SKILL_DIR}/../../examples/auth/src/main.ts (login/signup with Submodels, OutMessage, protected routes) and ${CLAUDE_SKILL_DIR}/../../examples/job-application/src/main.ts (multi-step form with deeply nested Submodels in step/, DatePicker, FileDrop, Listbox, Calendar module for date handling)
Tier 7: Real-time, WebSocket, Managed Resources, production-grade:
Read ${CLAUDE_SKILL_DIR}/../../packages/typing-game/client/src/update.ts, then explore its page/home/ and page/room/ directories for the full Submodel/OutMessage pattern.
Read examples from the target tier AND all lower tiers. A Tier 4 app should reflect patterns from Tiers 1-3 as well.
Phase 2.5: Identify Foldkit UI Component Opportunities
Foldkit ships accessible UI components that handle keyboard navigation, ARIA attributes, and focus management automatically. They live in a separate package, @foldkit/ui, and are imported by name:
import { Button, Dialog, Input } from '@foldkit/ui'
There is no Ui namespace on the foldkit package. Reach for Dialog.view, not Ui.Dialog.view. Deep imports (@foldkit/ui/dialog) work too when you want to keep the barrel out of the bundle.
Before generating, check if any part of the app maps to a built-in component:
| User Need | Component | What you get for free |
|---|---|---|
| Modal/dialog/confirmation | Dialog | Focus trapping, Escape to close, scroll locking, backdrop |
| Tabbed content | Tabs | Arrow key navigation, aria-selected, roving tabindex |
| Dropdown menu | Menu | Arrow keys, typeahead search, aria-expanded, click-outside |
| Autocomplete/tag input | Combobox | Filtering, arrow key selection, aria-activedescendant |
| Select dropdown | Select | Keyboard selection, aria-selected, positioning |
| Single selection from options | RadioGroup | Arrow key cycling, aria-checked, read-only navigation |
| On/off toggle | Switch | Spacebar toggle, aria-checked |
| Boolean option | Checkbox | Spacebar toggle, aria-checked, indeterminate |
| Expandable section | Disclosure | Enter/Space toggle, aria-expanded |
| Floating content on hover/click | Popover | Positioning, click-outside, focus management |
| Hover tooltip | Tooltip | Show-delay, keyboard dismiss, positioning, aria-describedby |
| Single-select list | Listbox | Arrow keys, typeahead, aria-selected |
| Text input | Input | Consistent styling/behavior wrapper |
| Multi-line text | Textarea | Auto-resize, consistent styling |
| Form group | Fieldset | Disabled state propagation, grouping |
| Styled button | Button | Consistent click/keyboard handling |
| Inline calendar grid | Calendar | Month navigation, keyboard nav, aria-selected, date constraints |
| Date input + popover | DatePicker | Calendar popover, input masking, keyboard nav, constraints |
| File upload zone | FileDrop | Drag-and-drop, click-to-browse, accept filters, validation |
| Reorderable list | DragAndDrop | Pointer + keyboard drag, drop zones, announcement region |
| Transient notifications | Toast | Auto-dismiss, pause-on-hover, stacking, role=status/alert |
| Numeric range / price filter | Slider | Arrow/Home/End keys, aria-valuenow, multi-thumb ranges |
| Long scrolling list | VirtualList | Windowed rendering, scroll anchoring, measured item heights |
| Site/section navigation | Nav | Current-page marking, keyboard traversal, landmark semantics |
The package is not one shape.
Stateful Submodels carry their own Model, Message, update, and (mostly) OutMessage, and are embedded via h.submodel: Menu, Listbox, Combobox, Calendar, DatePicker, Dialog, Popover, RadioGroup, Tabs, Tooltip, FileDrop, DragAndDrop, Slider, VirtualList, plus Toast once built through Toast.make(PayloadSchema).
Stateless render helpers have no Model at all. You call view directly with a ViewConfig and your own h, and store the value in your own Model: Button, Input, Textarea, Select, Fieldset, Checkbox, Switch, Disclosure, Nav.
Don't take that split on faith, because components have moved across it (Checkbox, Switch, and Disclosure became controlled render helpers; RadioGroup became a Submodel; Tabs and Slider moved their selection to the parent Model). Read the component's public.d.ts: exporting Model and update means Submodel, exporting only view and a ViewConfig / ViewInputs type means render helper. A render helper does not want a Got* Message.
To use a stateful Submodel:
- Add its Model to your Model:
confirmDialog: Dialog.Model - Add a
Got*Message:GotConfirmDialogMessagewith{ message: Dialog.Message } - Initialize in init:
confirmDialog: Dialog.init({ id: 'confirm-dialog' }) - Delegate in update:
GotConfirmDialogMessage: ({ message }) => ... - Embed in view via
h.submodel:h.submodel({ slotId: 'confirm-dialog', view: Dialog.view, model: model.confirmDialog, toParentMessage: message => Message.GotConfirmDialogMessage({ message }) })(addviewInputsfor components whose view takes them)
Always prefer Foldkit UI components over hand-rolling interactive widgets. They make accessibility the default, not an afterthought.
For form inputs specifically: every text input, textarea, and button in a form MUST go through Input, Textarea, and Button. This is not optional, even though raw input/textarea HTML elements are available on the view's builder h. The form example (examples/form/src/main.ts) defines inputFieldView and textareaFieldView helpers that wrap Input.view and Textarea.view with label + validation feedback. Copy that helper pattern. Raw input/textarea are for non-form cases (search fields, inline editors) where you're intentionally working below the component layer, and even then, reach for the component first.
If the app uses UI components, always read the ui-showcase example first to understand how components are wired. This is the canonical reference for Foldkit UI integration patterns:
${CLAUDE_SKILL_DIR}/../../examples/ui-showcase/src/main.ts: root wiring,Got*delegation,toParentMessagehelpers${CLAUDE_SKILL_DIR}/../../examples/ui-showcase/src/ui/message.ts: how component Messages are structured${CLAUDE_SKILL_DIR}/../../examples/ui-showcase/src/ui/model.ts: how component Models are composed${CLAUDE_SKILL_DIR}/../../examples/ui-showcase/src/ui/update.ts: how component updates are delegated${CLAUDE_SKILL_DIR}/../../examples/ui-showcase/src/ui/subscriptions.ts: which components need Subscriptions lifted into the parent (DragAndDrop,Slider)${CLAUDE_SKILL_DIR}/../../examples/ui-showcase/src/ui/toast.ts: read when usingToast. It's unique in that it's parameterized on a payload schema viaToast.make(PayloadSchema), returning a typed module you import from
Directory names under examples/ui-showcase/src/ have moved before. List the directory rather than trusting these paths blind.
For apps using DatePicker, FileDrop, or other recently-added components, also read the job-application example (see Tier 6 below). It's the most complete real-world integration of these components together.
Phase 3: Determine File Organization
Match the file structure to the app's complexity. The architecture stays the same at every scale; only the file organization changes.
What lives in which file
Beyond the tier-based layouts below, follow these "schema placement" rules to avoid model.ts bloat:
model.tsholds theModelschema + any schemas that are fields of Model (or composed into fields, like form state / submit state unions). Nothing else.command.tsholds schemas for the payloads commands send to / receive from external systems, in particular the persistence schema thatsaveStateserializes andflagsdeserializes. The persistence schema is a command-layer concern, not a model concern; it often looks like a subset of Model but it isn't part of Model.domain/*.tsholds domain entity schemas and pure operations on them.message.tsholds messages (only).route.tsholds route variants + router pipelines.
A common mistake (because kanban colocates SavedBoard in model.ts): putting the persistence schema in model.ts because "it's schema." It's schema for the persistence layer, not for the Model. Move it to where it's used.
Single file (Tier 1-2, under ~300 lines):
src/main.ts ← Model, Message, init, update, view
src/entry.ts ← Runtime.makeApplication + Runtime.run
Split commands + messages (Tier 3, has async operations):
src/main.ts ← Model, init, update, view
src/entry.ts ← Runtime.makeApplication + Runtime.run
src/message.ts ← Message definitions
src/command.ts ← Command functions
Important rule: if you extract command.ts, you MUST also extract message.ts. Commands reference Message constructors (for example, Message.SucceededFetchWeather({...})) as their Effect return values. If Messages live in main.ts and Commands live in command.ts, command.ts imports from main.ts and main.ts uses Commands from command.ts, a circular import. Pull Messages out first, then both main.ts and command.ts import the Message namespace from message.ts.
Full split (Tier 4-5, multiple concerns):
src/main.ts ← init, update, view
src/entry.ts ← Runtime.makeApplication + Runtime.run
src/model.ts ← Model schema
src/message.ts ← Message definitions
src/command.ts ← Command functions
src/route.ts ← Route parser (if routing)
src/view.ts ← View functions (if view is large)
src/domain/ ← Shared domain schemas (if multiple entities)
Submodel directories (Tier 6-7, independent modules):
src/main.ts ← Root init, update, view
src/entry.ts ← Runtime.makeApplication + Runtime.run
src/model.ts ← Root model (contains submodels)
src/message.ts ← Root messages + Got* bridging
src/command.ts ← Shared commands
src/route.ts ← Route parser
src/domain/ ← Shared domain schemas
src/page/
featureA/
main.ts ← Submodel init, update, view
message.ts ← Submodel messages + OutMessage
command.ts ← Submodel commands
featureB/
...
Phase 3.3: Architecture sketch (Tier 4+ only)
For Tier 4+ apps (routing, domain modules, multiple entities, submodels) produce a compact sketch BEFORE generating implementations. Tier 1-3 apps are small enough to generate in one pass; Tier 4+ apps burn a lot of effort if the structure is wrong.
The sketch has five parts. Emit them inline in the conversation, get confirmation, THEN scaffold:
- File tree: the exact paths you will create. Match Phase 3's organization.
- Model shape: the top-level
Schema.Structfields and their types. Not the full schema, just the shape. - Message list: every Message you plan to define, grouped by category (clicks, inputs, commands, out-messages).
- Route list: if routing, every
defineRouteUnionvariant with its params and the path it maps to. - Domain operations: for each file in
domain/, the operations it will expose (Link.byNewest,Link.filterByTag, etc.).
Example for a Tier 4 link saver:
### Sketch
Files:
src/main.ts, entry.ts, model.ts, message.ts, command.ts, route.ts
src/domain/link.ts, index.ts
src/story.test.ts, scene.test.ts
Model:
route: AppRoute
links: ReadonlyArray<Link>
newLinkForm: NewLinkForm (url: Field<string>, title/description/tagsInput: string, submitState)
Messages:
Clicks: ClickedSaveLink, ClickedDeleteLink
Inputs: UpdatedLinkUrl, UpdatedLinkTitle, UpdatedLinkDescription, UpdatedLinkTagsInput, BlurredLinkUrl
Commands: SubmittedNewLinkForm, SucceededSaveLinks, FailedSaveLinks
Routing: ClickedLink, ChangedUrl, CompletedNavigateInternal, CompletedLoadExternal
Toggles: ToggledFavorite
Routes:
AppRoute.Home → /
AppRoute.NewLink → /new
AppRoute.TagFilter → /tag/:tag
AppRoute.NotFound → /* fallback
Domain:
Link: schema + byNewest, filterByTag, toggleFavorite, remove, updateById
After emitting the sketch, ask the user to confirm or adjust. Don't start scaffolding or generation until they do. If the user confirms silently (e.g. "looks good, continue"), proceed. If they adjust, iterate on the sketch. Don't write code against a version they haven't approved.
This step is frequently tempting to skip because the agent "knows what it's doing." Skip it and you ship a fully-generated app that turns out to need structural changes. That's the expensive form of iteration. The sketch is the cheap form.
Phase 3.5: Scaffold the Project
Before generating code, scaffold a runnable project using create-foldkit-app:
npx create-foldkit-app@latest
Run with no flags to drop into the interactive prompts; pick the counter example as the base (simplest starting point) and the user's preferred package manager. The generated project includes:
package.jsonwith all Foldkit and Effect dependenciesvite.config.tswith Tailwind and the Foldkit Vite plugintsconfig.jsonwith strict TypeScript settingsindex.htmlwith the root containersrc/styles.csswith Tailwind importFOLDKIT.mdwith Foldkit conventions, and anAGENTS.mdstub pointing at it
Offer the Foldkit subtree
After scaffolding, offer to vendor Foldkit in as a git subtree so future AI sessions can reference the full source, examples, and docs directly from the user's project. Commit the scaffold first so subtree has a base commit to merge into:
git init # if not already a git repo
git add .
git commit -m "chore: initial commit"
git subtree add --prefix=repos/foldkit https://github.com/foldkit/foldkit.git "foldkit@$(node -p "require('./node_modules/foldkit/package.json').version")" --squash
The foldkit@<version> tag pins the subtree to the release the scaffold just installed, so the vendored source, examples, and docs match the APIs the app compiles against. Vendoring main instead can hand future sessions examples and APIs from a release the app has not installed. A canary install (x.y.z-canary.<commit>) has no tag; pin to the full hash of the commit its version names instead, which GitHub expands at https://github.com/foldkit/foldkit/commit/<commit>.
This is optional but strongly recommended. The scaffolded AGENTS.md includes a subtree_prompted: false line that agents check on future sessions. If the subtree is absent and this flag is false, the agent offers to add it. Handling it up front here means the user's next AI session already has full context. If the user declines, update the line to subtree_prompted: true so they aren't asked again.
To re-pin the subtree after a Foldkit package upgrade, run the same command with pull in place of add.
Replace the scaffold
Then replace the counter example code in src/main.ts (and add additional source files as needed) with the generated app code.
Phase 3.7: Ground the Foldkit APIs
Before writing any code, READ the type signatures of every Foldkit module you will use. Guessing signatures wastes cycles: each wrong guess is a tsc error, a re-read, an edit, another typecheck. Five minutes of reading prevents thirty minutes of iteration.
The exact files to read
For each Foldkit module you plan to use, read the .d.ts at the paths below. Read the public surface; you don't need the internals. Write a short signature crib in your working notes so you don't have to re-check while generating.
# Every app
<project>/node_modules/foldkit/dist/index.d.ts # top-level re-exports: the authoritative list of what `foldkit` exposes
<project>/node_modules/foldkit/dist/html/index.d.ts # HtmlBuilder<Message>, element signatures, Attribute<Message>, inertHtml
<project>/node_modules/foldkit/dist/message/public.d.ts # defineMessageUnion()
<project>/node_modules/foldkit/dist/schema/public.d.ts # defineTaggedUnion(), taggedStruct()
<project>/node_modules/foldkit/dist/struct/index.d.ts # modifyFields(): check nested-update signature
<project>/node_modules/foldkit/dist/update/public.d.ts # Update.Return, Update.ReturnWithOutMessage, Update.foldChildInit, Update.foldChildInits, Update.withOutMessage, Update.combine, Update.refresh
<project>/node_modules/foldkit/dist/runtime/runtime.d.ts # ApplicationInit, RoutingApplicationInit, makeApplication, makeElement
# If using routing
<project>/node_modules/foldkit/dist/route/public.d.ts # defineRouteUnion, literal, slash, string, int, Route.root, Route.mapTo, Route.oneOf, Route.parseUrlWithFallback
<project>/node_modules/foldkit/dist/url/index.d.ts # toString
<project>/node_modules/foldkit/dist/navigation/index.d.ts # pushUrl, load: all return Effect<void> (no Effect.ignore needed)
# If using async / side effects
<project>/node_modules/foldkit/dist/command/index.d.ts # Command.define: config object with args/messages/interrupt/execute. Command.mapMessages for parent<-child mapping
<project>/node_modules/foldkit/dist/asyncData/public.d.ts # AsyncData: Idle/Loading/Refreshing/Failure/Stale/Success + Schema, match, isPending, hasData, revalidate
<project>/node_modules/foldkit/dist/http/public.d.ts # Http.layer: provide it to Commands that use HttpClient
<project>/node_modules/foldkit/dist/dom/index.d.ts # focus, advanceFocus, scrollIntoView, showDialog, closeDialog, clickElement, lockScroll, unlockScroll, inertOthers, restoreInert, detectElementMovement, waitForAnimationSettled. For time/random/delay use Effect's Clock, Random, Effect.sleep + Duration directly. For UUIDs use Crypto.Crypto's randomUUIDv4 with BrowserCrypto.layer.
# If using subscriptions
<project>/node_modules/foldkit/dist/subscription/index.d.ts # Subscription.make<Model, Message>, Subscription.lift, Subscription.aggregate
# If using mount / managed-resource / custom-element
<project>/node_modules/foldkit/dist/mount/public.d.ts # Mount.define (one-shot) / Mount.defineStream (continuous): per-instance VNode lifecycle
<project>/node_modules/foldkit/dist/managedResource/public.d.ts # ManagedResource.make / lift / aggregate + tag: for stateful runtime objects keyed on Model condition
<project>/node_modules/foldkit/dist/customElement/index.d.ts # CustomElement.define: for typed bindings to native web components
# If the host application drives the program
<project>/node_modules/foldkit/dist/port/public.d.ts # Port.inbound / outbound / emit / stream / subscription
# If using forms
<project>/node_modules/foldkit/dist/fieldValidation/public.d.ts # Field (tagged union), makeRules({required?, rules}), match, validate, allValid; rule constructors on the Rule namespace (Rule.url(options), Rule.email, Rule.minLength, Rule.pattern, Rule.fromSchema, ...)
# Rule.Rule is [Predicate, Rule.RuleMessage], NOT {test, message}. Field.Invalid has `errors: NonEmptyArray<string>`, not `error: string`.
# If using any UI component (SEPARATE PACKAGE)
<project>/node_modules/@foldkit/ui/dist/<component>/public.d.ts # Model, Message, init, update, view (Submodel-shaped) or ViewConfig (render-helper-shaped), OutMessage when applicable
# Check: is it a Submodel (Menu/Listbox/Combobox/Calendar/DatePicker/Dialog/Popover/RadioGroup/Tabs/Tooltip/FileDrop/DragAndDrop/Slider/VirtualList/Toast) embedded via h.submodel, or a stateless render helper (Button/Input/Textarea/Select/Fieldset/Checkbox/Switch/Disclosure/Nav) called directly? Submodels carry their own Model/Message/update/OutMessage; render helpers don't. Check ViewInputs (for Submodels) or ViewConfig (for helpers) for the slot callbacks (toView, itemToConfig, etc.).
# If using dates
<project>/node_modules/foldkit/dist/calendar/index.d.ts # CalendarDate, today.local (returns Effect<CalendarDate>); for raw millis use Clock.currentTimeMillis
If a path above doesn't resolve, list the package's dist/ and find the module. The .d.ts is authoritative and this file is not. Where the two disagree, the .d.ts is right and the disagreement is a bug in this skill worth reporting.
What to record in the crib
For each symbol you'll call, write one line:
h: HtmlBuilder<Message> (view parameter, supplied by the runtime): { div, input (VOID), textarea (VALUE-ONLY), button, Class, Href, For, Id, Role, OnClick(Message), OnInput(value=>Message), OnBlur(Message), OnSubmit(Message), keyed, empty, submodel, ... }
Route.mapTo(schema)(parser): curried
pushUrl(path): Effect<void> // NOT fallible, no Effect.ignore needed
urlToString(url: Url): string
Update.Return<Model, Message>: { model: Model; commands?: ReadonlyArray<Command.Command<Message>>; outMessage?: never }
Command.mapMessages(commands: ReadonlyArray<Command.Command<ChildMessage>> | undefined, toParentMessage): ReadonlyArray<Command.Command<ParentMessage>>
AsyncData.Schema(DataSchema, ErrorSchema): { schema, Idle(), Loading(), Success({data}), Failure({error}), ... }
AsyncData.match(value, { onIdle, onLoading, onRefreshing, onFailure, onStale, onSuccess })
// handlers take BARE values, except onStale:
// onIdle: () => B onLoading: () => B
// onRefreshing: (data) => B onSuccess: (data) => B
// onFailure: (error) => B onStale: ({ error, data }) => B
Command.define(name, { args, messages, execute }): every input is a named field.
`execute` binds at DEFINITION and receives the decoded args object directly, so
you destructure the fields themselves; the call site passes args:
const Fetch = Command.define('Fetch', {
args: { id: Schema.String },
messages: [Ok, Err],
execute: ({ id }) => ...,
})
update: [Fetch({ id })] // NOT Fetch({ id })(effect)
Document: NOT generic, and `body` is a single Html, not an array
Input.view({ id, value, onInput, isInvalid?, type?, placeholder?, toView: (attrs) => Html }, h)
// from '@foldkit/ui', NOT Ui.Input
// attrs: { label: ReadonlyArray<Attribute<M>>, input: ..., description: ... }
Field (schema): NotValidated | Validating | Valid | Invalid(errors: NonEmpty<Rule Message>)
Specific API pitfalls the generator hits repeatedly
Record these in the crib and keep them visible while generating:
inputandbrand other void elements take ONLY attributes:input([...]), neverinput([...], []).textareaalso takes attributes only; set its content withh.Value(text), never children orh.InnerHTML.buttontakes children.- The children argument is optional on elements that accept children. Omit it when there are none:
div([Class('divider')]), notdiv([Class('divider')], []). Attributes stay required, sodiv([])is how an element with neither is written.keyedfollows the element:h.keyed('li')(key, [attrs]), noth.keyed('li')(key, [attrs], []); useh.keyed('textarea')(key, [h.Value(text)])without children. UrlRequesttags areInternalandExternal, notInternalUrl/ExternalUrl.OnClickandOnSubmittake a Message directly, not a() => Message. OnlyOnInputtakes(value) => Messagebecause it needs the input value.keyed,emptyare properties on the builderhthe view receives as its last parameter. They are not top-level exports offoldkit/html.- Attribute helpers are specific:
Value(...),Type(...),Placeholder(...),Href(...),Target(...),Rel(...),Rows(n),Id(...),For(...),Role(...),AriaLabel(...). There is no genericAttr('...', '...'). ApplicationInit<Model, Message, Flags>has no URL parameter. For routed apps, useRoutingApplicationInit<Model, Message, Flags>: the second arg isurl: Url.Route.mapTotakes the route schema, not a factory function.pipe(literal('new'), Route.mapTo(AppRoute.NewLink)). NOTRoute.mapTo(() => AppRoute.NewLink()).Effect.ignoreis ONLY for fallible Effects.pushUrl(path).pipe(Effect.as(Message())). NoEffect.ignorebecausepushUrlreturnsEffect<void>.Command.definetakes a config object with amessagesarray:Command.define('Fetch', { messages: [Message.SucceededFetch, Message.FailedFetch], execute }).messagesis required and is always an array, even for one Message:Command.define('ReadClock', { messages: [Message.RecordedTime], execute }).makeRulestakes{ required?: Rule.RuleMessage, rules: Array<Rule.Rule> }whereRule.Rule = [Predicate, Rule.RuleMessage]: a tuple, NOT{ test, message }. Rule constructors live on theRulenamespace (Rule.url({ message }),Rule.email(message?),Rule.minLength(n, message?),Rule.pattern(regex, message?),Rule.fromSchema(schema, message)).Field.Invalidhaserrors: NonEmptyArray<string>, noterror: string. UseArray.headNonEmpty(errors)to get the first message; useRule.resolveMessage(message, value)to resolve a rule message to its final string.- Route variants stay on
AppRouteand drop the repeatedRoutesuffix. WriteAppRoute.HomeandAppRoute.NewLink, not sibling bindings namedHomeRouteandNewLinkRoute. - Routers are callable for printing:
homeRouter()returns'/',tagFilterRouter({ tag: 'foo' })returns'/tag/foo'. Never hand-construct URLs. - UI components come from
@foldkit/ui, not from aUinamespace onfoldkit.import { Dialog, Input } from '@foldkit/ui', thenDialog.view(...). There is noUiexport on thefoldkitpackage. HttpClientandHttpClientRequestcome fromeffect/http, not@effect/platform. Provide the client to the Command's Effect withEffect.provide(effect, Http.layer), whereHttpis imported fromfoldkit.@effect/platform-browseris a different thing, used forBrowserKeyValueStoreandBrowserCrypto.- Use
Update.foldChildInitfor one child init or boot result, andUpdate.foldChildInitswhen several child results enter one parent Model. UseUpdate.foldChildfor a child update that receives input orUpdate.foldChildStepfor a child helper that receives only its Model. The folds lift the child's Commands throughtoParentMessage. UseCommand.mapMessagesdirectly only for lower-level helpers or route-gated initialization. - Inline a one-use update return type. Use
Message.match<Update.Return<Model, Message>>when the matcher is its only use. Create anUpdateReturnalias when another matcher, helper, or exported signature reuses the type. The match generic constrains the whole update, so omit a redundant return annotation. Constrain a domain union match inside a handler the same way, through its ownmatchormatchOrElsegeneric (Submission.match<UpdateReturn>(submission, { ... }));Match.withReturnType<UpdateReturn>()is only for EffectMatch(partial Message matches, shared multi-tag handlers, or unions without their own matcher). - Preserve the plain-return OutMessage guard. Use
Update.Return<Model, Message>when an update cannot emit an OutMessage. It prevents a result containing an OutMessage from entering code that would keep only its Model and Commands. A result with nooutMessagecan still be used whereUpdate.ReturnWithOutMessage<Model, Message, OutMessage>is expected. The missing field means that update emitted no OutMessage. A hand-written plain-return type must preserve theoutMessage?: neverfield. - Omit only statically empty Commands. A producer with statically no Commands omits
commands. A producer with a computed collection returns it without checking whether it is empty. Never writecommands: []. - Keep update-like results together. Bind each result to a value named after the operation and use dot access. Use a trailing underscore such as
init_when the operation name collides with the function. Do not destructure or renamemodel,commands, oroutMessage. Name a child fold'swriteparameter after the next child Model, such asnextSettings. Pass optional Commands directly toCommand.mapMessages; useresult.commands ?? []only when the next operation requires a concrete array. Dot access keeps the operation and all of its returned fields visible together but does not prevent someone from ignoringoutMessage. - Use the update combinators for their full patterns. Use
Update.combinewhen a later Step should receive the Model produced by an earlier Step. It takes two or more Steps. Do not wrap one Step inUpdate.combine; call that operation directly. Name an inline Step parameterstepModelwhen combining several. When the OutMessage is already known while constructing a new result, include it directly. UseUpdate.withOutMessagefor an existing plain return or a value with the typeOutMessage | undefined: pipe an existing return into the helper, and pass a new result literal first. UseUpdate.foldChildInitfor one child init or boot result,Update.foldChildInitswhen several child results enter one parent Model,Update.foldChildfor a child update that receives input, andUpdate.foldChildStepfor a child helper that receives only its Model. AddtoParentOutMessageonly when at least one child OutMessage should continue to the current Submodel's parent. For partial forwarding, match every child variant and returnundefinedfor the variants that stop here. OmittoParentOutMessagewhen every variant stops here.foldOutMessagestill handles each variant locally, including variants that continue upward. Never addtoParentOutMessage: () => undefined. - Branch on a Model array with
Array.match, not the predicates.Array.isArrayEmptyandArray.isArrayNonEmpty(note the names: notisEmptyArray/isNonEmptyArray) take a mutableArray<A>, so neither compiles against theReadonlyArrayanSchema.Array(...)field decodes to.Array.matchtakesReadonlyArrayand is what the exemplars use. emptyandkeyedare properties onh, so they are never in thefoldkit/htmlimport list. Import the types (import type { Document, Html, HtmlBuilder } from 'foldkit/html') and reach forh.empty/h.keyedoff the view's builder.
Phase 4: Generate the App
Generate files following the architecture and conventions guides exactly. Write all source files into the scaffolded project's src/ directory. For each file, follow these rules:
Model
- Define as
Schema.Structwith Effect Schema types - Use discriminated unions for state:
Idle | Loading | Error | Ok, never booleans for multi-valued state - Use
Optionfor fields that may be absent. Never empty strings or null - Prefix Option-typed fields with
maybe:maybeCurrentUser,maybeError - For remote data, use the
AsyncDatamodule rather than hand-rolling a union.AsyncData.Schema(WeatherData, Schema.String)returns{ schema, Idle, Loading, Refreshing, Failure, Stale, Success }; putschemain the Model and build values with the constructors. TheRefreshingandStalestates are the point: they let a reload keep the current data on screen, and a failed reload keep it rather than discarding it.repos/foldkit/examples/weather/src/main.tsis the canonical use. ReadAsyncData.match's signature before calling it: the handlers take bare values (onSuccess: data => ...,onFailure: error => ...), exceptonStale, which takes{ error, data } - For non-remote multi-valued state (form steps, editor modes, connection phases), declare the whole union with
defineTaggedUnion(). See Discriminated Unions for State in conventions.md - For apps with multiple domain entities referenced across modules, extract shared schemas into
src/domain/(e.g.,domain/product.ts,domain/session.ts). See the shopping-cart and auth examples for this pattern, and read${CLAUDE_SKILL_DIR}/../../packages/website/src/page/projectOrganization.tsfor guidance on when and how to structure domain modules
Messages
Declare the Message union and its type together:
export const Message = defineMessageUnion({
ClickedSubmit: {},
UpdatedEmail: { value: Schema.String },
SucceededLogin: { user: User },
FailedLogin: { error: Schema.String },
CompletedFocusInput: {},
})
export type Message = typeof Message.Type
Keep the defineMessageUnion() declaration and type Message alias adjacent. Construct variants through the namespace, such as Message.ClickedSubmit() and Message.UpdatedEmail({ value }). Never destructure constructors from Message or OutMessage; the owning namespace stays visible at every call site.
Keep each case's payload object on one line when it fits. Let Oxfmt wrap payloads that need more space, so the declaration remains easy to scan as one variant per line.
Name messages by category:
Clicked*: button/link clicksUpdated*: input value changes (with{ value: Schema.String }) and external state updates from subscriptions (UpdatedRoom,UpdatedPlayerProgress)Submitted*: form submissionsSucceeded*/Failed*: paired, for commands that can meaningfully failCompleted*: every other Command result, named from the Command (verb+object:CompletedFocusInput,CompletedGenerateCardId)Got*: child module results via OutMessage patternPressed*: keyboard inputBlurred*: focus lossSelected*: choice made from a listToggled*: binary state flip
Every message must carry meaning. No NoOp.
Flags (if the initial Model needs side effects)
- Define a
FlagsSchema for data the initial Model needs from side effects - Define
flagsas anEffect<Flags>that computes the values (localStorage reads, current time, etc.) - Pass
flagstoRuntime.run(application, { flags })for a fresh browser boot. Hydrated applications callRuntime.hydrate(application)and use only the server-encoded Flags payload.@foldkit/vite-plugincompiles the shared deployment identity into Foldkit for coordinated client and server builds - Pass the result into init. Never perform side effects at module level or inside init directly
- See the Flags section in architecture.md for the full pattern
Init
- Return an
Update.Return<Model, Message>record. Omitcommandswhen init statically creates no Commands; return a computed Commands collection directly - If Flags are used, accept them as the first parameter. For example:
(flags: Flags) => ({ model: initialModel(flags) })or(flags: Flags, url: Url) => ({ model: initialModel(flags, url) }) - Include startup Commands (initial fetch, focus first input, etc.)
- Use callable Schema constructors for the initial Model:
Model({ field: value })
Update
- Use
Message.match<Update.Return<Model, Message>>(message, {...})when the return type appears only at that matcher. Create anUpdateReturnalias when another matcher, helper, or exported signature reuses it.Update.ReturnWithOutMessage<Model, Message, OutMessage>is the Submodel counterpart. Match an OutMessage exhaustively through its owning union'smatch; pass a structurally refined OutMessage type as the second generic when a generic child narrows the Schema-backed payload type. A hand-written plain-return type is equivalent only when it includesoutMessage?: never. Never switch. Use adefineTaggedUnionordefineRouteUnionnamespace'smatchOrElsefor partial matches with fallbacks. Keep EffectMatchfor partial Message matches, handlers shared across several tags, and unions without their own matcher - Omit
commandswhen an update, init, boot, or component helper statically creates no Commands. Return a computed Commands collection directly without checking whether it is empty. Never write the literalcommands: [] - When composing an update, init, boot, or component helper result, bind the whole result to a value named after the operation and use dot access. Use a trailing underscore such as
init_when the name collides with the function. Do not destructure or renamemodel,commands, oroutMessage. Name a child fold'swriteparameter after the next child Model. Pass optional Commands directly toCommand.mapMessages, and useresult.commands ?? []only where the next operation requires a concrete array. Dot access keeps the operation and all of its returned fields visible together but does not prevent someone from ignoringoutMessage. UseUpdate.foldChildInitfor one init or boot result,Update.foldChildInitswhen several child results enter one parent Model,Update.foldChildfor a child update that receives input, orUpdate.foldChildStepfor a child helper that receives only its Model - Use
Update.combinewhen a later Step should receive the Model produced by an earlier Step. It takes two or more Steps. Do not wrap one Step inUpdate.combine; call that operation directly. Name an inline Step parameterstepModelwhen combining several. When the OutMessage is already known while constructing a new result, include it directly. UseUpdate.withOutMessagefor an existing plain return or a value with the typeOutMessage | undefined: pipe an existing return into the helper, and pass a new result literal first. AddtoParentOutMessageonly when at least one child OutMessage should continue to the current Submodel's parent. For partial forwarding, match every child variant and returnundefinedfor the variants that stop here. OmittoParentOutMessagewhen every variant stops here.foldOutMessagestill handles each variant locally, including variants that continue upward - Use
modifyFields(model, { field: () => newValue })for immutable updates - When a
Succeeded*handler has to write several caches and kick off refetches, sequence them withUpdate.combine(model, [step, step, ...])and build the refetch steps withUpdate.refresh({ read, revalidate, write, load }), which reloads a cache only when it actually holds data.examples/route-transitions/src/main.tsshows both - In
modifyFields, use point-free field transformers when the update only depends on that field's current value:items: Array.map(updateItem),count: Number.increment,priceSlider: Slider.reflectRange({ min: minPrice, max: maxPrice }). Use() => valuefor replacement values from Messages, child updates, Commands, or other Model fields. - Extract complex handlers to separate functions when a case exceeds ~15 lines
- For Submodels, return
Update.ReturnWithOutMessage<Model, Message, OutMessage>. OmitoutMessagewhen there is nothing to report - See the OutMessage pattern in architecture.md. Child modules signal to parents through
outMessage; parents handle the value throughfoldOutMessageonUpdate.foldChild,Update.foldChildInit, orUpdate.foldChildInits
Commands
- Define Command identities with
Command.define, whose second argument is a config object:args(optional) declares the args Schema,messageslists every Message the Command can produce, andexecuteholds the Effect. With args the shape isCommand.define('Fetch', { args: { id: Schema.String }, messages: [Message.SucceededFetch, Message.FailedFetch], execute: ({ id }) => Effect }):executebinds at definition and receives the args, and the update returnsFetch({ id }) - To make a Command interruptible, add
interrupt.interrupt: truekeys every invocation by the Command name;interrupt: { keyFields, toKey }selects the args that identify an invocation and derives its key so concurrent invocations can be cancelled independently. The selected fields become the args required by the Definition'sInterruptconstructor - Always assign definitions to PascalCase constants. Never inline in pipe chains
- Definitions live where they're produced, colocated with the update function
- Let TypeScript infer return types. No explicit
Command<typeof A>annotations - Use
Effect.genfor multi-step async - Always
Effect.catch(() => Effect.succeed(Message.FailedX(...)))for fallible Effects. Commands never throw. Exception: if the Effect is infallible at the type level (Clock.currentTimeMillis,Random.nextIntBetween, etc.), nocatchis needed and noFailed*Message is needed. Follow the types: if there's no error channel, there's nothing to catch. - Use
Effect.providefor services - Factory functions named by action:
fetchWeather, notfetchWeatherCommand - Name each Command for the effect its
executebody performs, not the later Model transition caused when update handles its result. A timer that only waits before update starts a dismissal isWaitBeforeDismissal, notDismissAfter - Commands that can't meaningfully fail return
Completed*Messages named from the Command, payload-carrying ones included:DetermineStartTime→CompletedDetermineStartTime, notDeterminedStartTime - Use Foldkit's
Dommodule for DOM operations (Dom.focus,Dom.scrollIntoView,Dom.showDialog,Dom.lockScroll, etc.) and Effect built-ins for everything else (Clock.currentTimeMillis,Random.nextIntBetween,Effect.sleep(Duration.millis(...))). For UUIDs, use theCrypto.Cryptoservice'srandomUUIDv4with a platform Crypto layer. See DOM and Effect Helpers in architecture.md - For HTTP requests, use
HttpClientandHttpClientRequestfromeffect/http, and provide the client withEffect.provide(effect, Http.layer)whereHttpcomes fromfoldkit. Seeexamples/weather/src/main.tsfor the pattern - Let
Update.foldChildInit,Update.foldChildInits,Update.foldChild, orUpdate.foldChildStepre-tag a child Submodel's Commands throughtoParentMessagewhen applicable. UseCommand.mapMessagesdirectly only for lower-level helpers or route-gated initialization
Form Validation
When the app has form inputs that need validation (required fields, format checks, async uniqueness checks), use foldkit/fieldValidation. Do not hand-roll validation state.
import {
Field,
Invalid,
NotValidated,
Rule,
Valid,
Validating,
allValid,
makeRules,
validate,
} from 'foldkit/fieldValidation'
const nameRules = makeRules({
rules: [Rule.minLength(2, 'Name must be at least 2 characters')],
})
const emailRules = makeRules({
required: 'Email is required',
rules: [Rule.email('Please enter a valid email address')],
})
const Model = Schema.Struct({
name: Field(Schema.String),
email: Field(Schema.String),
// ...
})
Field(valueSchema) builds a tagged union: NotValidated | Validating | Valid | Invalid. The value Schema should match what the control actually holds as the user edits, not the type you parse it into: Field(Schema.String) for text inputs, Field(Schema.Array(Schema.String)) for a multi-select. A checkbox's boolean usually stays plain Schema.Boolean in the Model unless it needs the validation lifecycle. Rules stay separate in makeRules. Use validate(rules)(value) in update handlers to transition a field, and gate submission with allValid([[state, rules], ...]), which gates one field value type per call (combine calls with && across types). Omit required from makeRules to make a field optional.
Canonical reference: ${CLAUDE_SKILL_DIR}/../../examples/form/src/main.ts (async email uniqueness check with version-based cancellation) and ${CLAUDE_SKILL_DIR}/../../examples/job-application/src/step/ (validated multi-step forms across submodels).
Dates and File Uploads
For date handling (birthday, deadlines, scheduling):
- Use the
Calendarmodule:Calendar.CalendarDate,Calendar.today.local(Effect returning today's date in the user's timezone),Calendar.make(year, month, day),Calendar.addDays, etc. - Use
DatePicker(input + popover calendar) orCalendar(inline grid) from@foldkit/uifor the UI - Seed the initial date via Flags when needed. See
job-applicationexample, which usesCalendar.today.localin its Flags Effect
For file uploads (resumes, images, attachments):
- Use the
Filemodule for file primitives - Use
FileDropfrom@foldkit/uifor a drag-and-drop + click-to-browse zone with validation FileDrop.ReceivedFilescarriesfiles: NonEmptyArray<File>, so the happy path never has to handle an empty list. A drop that produced no files arrives as the separateRejectedNonFilesOutMessage; handle it to surface a message like "Only files are accepted"- Canonical reference:
${CLAUDE_SKILL_DIR}/../../examples/job-application/src/step/attachments/
View
- Every view receives
h, the typed Html builder, as its last parameter: the runtime passes it to the root view, andSubmodel.defineView<Model, Message>passes the child's own to each Submodel view. Application code never constructs a builder. Reach for elements, attributes, and event handlers offh:h.div,h.Class,h.OnClick. The child dispatches in its own Message type and the parent declares the wrap at the embed site viatoParentMessage. - Extracted view helpers take
h: HtmlBuilder<Message>as their last parameter; callers thread it through. Inside a view, always use the view's ownh. Only where no builder is in scope, typically module scope, useinertHtmlfromfoldkit/html, aliasedih(typedHtmlBuilder<never>, so no handlers can be built with it). - Use
h.Class(...)for Tailwind classes - Use
clsxfrom theclsxpackage for conditional class composition:h.Class(clsx('base-classes', { 'active-class': isActive, 'bg-blue-500': variant === 'Primary' })). Useclsxwhenever classes depend on model state, boolean flags, or discriminated union tags. Never string concatenation, template literals, or&&expressions. - Pattern match on model state through the union:
State.match(model.state, {...}) - Use
Option.matchfor conditional rendering based on Option fields - Never key branches. View functions are the differ's identity boundaries; the vite plugin brands each function's return, so switching branches that render through different view functions replaces the subtree. Extract a same-tag inline ternary into named view functions when switching must reset DOM state
- Delegate complex sections to extracted view functions
- Wire events to Messages:
h.OnClick(Message.ClickedSubmit())(a Message directly, not a callback),h.OnInput(value => Message.UpdatedEmail({ value }))(a callback that maps the value to a Message) - Use Foldkit UI components when the interaction matches (Dialog for modals, Tabs for tabbed content, etc.)
Runtime Wiring
- Use
Runtime.makeApplicationfor apps that own the page. Addrouting: { onUrlRequest, onUrlChange }for apps with URL routing. Theviewreturns aDocument({ title, lang?, dir?, canonical?, ogUrl?, body }). Derivecanonicalfrom the typed route in the Model, never from the address bar. The runtime appliestitle,lang, anddir. ForcanonicalandogUrl, a later omission restores the value recorded before the first client write or removes an element the runtime created. An omittedogUrluses an explicitcanonical - Use
Runtime.makeElementfor a widget embedded on a page it does not own. TheviewreturnsHtmland the runtime never touches the document<head>or the<html>element. Noroutingconfig - See the With and Without URL Routing section in architecture.md for the full pattern
- Include
ClickedLinkandChangedUrlMessages for programs with routing, with properUrlRequest.Internal/UrlRequest.Externalhandling in update - Always end with
Runtime.run(application)for a page-owning app. When a host application controls the program's lifecycle, end withRuntime.embed(element)instead and hand the returned handle to the host; mirrorrepos/foldkit/examples/embedding/src/host.tsfor the host side and itsmain.tsfor the widget side - Name the variable holding a
makeApplicationresultapplication, and the variable holding amakeElementresultelement
Routes (if multi-page)
- Use bidirectional parser:
defineRouteUnion(),string(),int(),literal(),slash(),Route.mapTo(),Route.oneOf() - Declare every route in one
defineRouteUnion({ Home: {}, NewLink: {}, NotFound: { path: Schema.String } })namedAppRoute. Keep each variant on that namespace:AppRoute.Home. Do not destructure variants or repeat the oldHomeRoutesuffix. - When a Model or Schema accepts only part of
AppRoute, useAppRoute.subset(['Home', 'Person']). It includes only the tags named in the call. There is noomit, because an exclusion list would silently accept every Route added later. Exporttype PersonRoute = typeof AppRoute.Person.Typebeside the union when a module needs one variant's type. - Build each route as a Router:
const homeRouter = pipe(Route.root, Route.mapTo(AppRoute.Home)). Routers are callable:homeRouter()returns'/',tagFilterRouter({ tag: 'foo' })returns'/tag/foo'. This is the print side of the bidirectional parser. - Never hand-construct paths with template strings.
Href(homeRouter())notHref('/').pushUrl(newLinkRouter())notpushUrl('/new').Href(tagFilterRouter({ tag: tagName }))notHref(`/tag/${encodeURIComponent(tagName)}`). The router handles encoding and keeps the URL shape in one place so a refactor changes one file, not every call site. - Render each route through its own view function; identity handles the switch, so route branches are never keyed. Key by entity id only when one shared view function renders different entities across route params (a detail page across slugs)
- Use
pushUrlfromfoldkit/navigationin Commands for programmatic navigation. In theClickedLinkhandler'sInternalcase, useurlToString(url)fromfoldkit/url. Never reconstruct the URL fromurl.pathname + search + hashmanually; that path drops the?prefix and hash silently. - In the
ClickedLinkhandler, don't pre-updatemodel.route. The runtime firesChangedUrlafterpushUrlresolves, which updates the route. Pre-updating creates a double-write.
Subscriptions (if real-time)
- Define with
Subscription.make<Model, Message>()(entry => ({ key: entry(fields, callbacks) })). The builder callback receives anentry(fields, callbacks)helper.fieldsis the bare field map (noSchema.Structwrap),callbackscarriesmodelToDependencies,dependenciesToStream, and optionalequivalence modelToDependenciesextracts Subscription parameters from ModeldependenciesToStreambuildsStream<Message>from dependencies- Subscriptions auto-start/stop based on Model state. Never manually managed
- For Subscriptions with no Model dependencies (always active), pass
{}as theentryfields argument and return{}frommodelToDependencies - To embed child Subscriptions, use
Subscription.lift(childRecord)<Parent, Parent>({ read, toParentMessage }). ItsreadreturnsOption<ChildModel>, matchingUpdate.foldChildandManagedResource.lift;Nonestops every child Stream without reading child dependencies. UseOption.somefor always-present children. Every lifted entry wraps its dependencies inGatedDependencies. Addwhenon the parent's lift call to gate on a parent fact the child cannot see (the route a page Submodel sits behind); the parent owns the gate and reads the parent Model, and a closed gate tears the entry's Stream down.when: parentModel => booleangates every entry;when: { entryName: parentModel => boolean }adds a condition only to the entries it names; child absence still stops every entry, so a child never splits its record to suit its parent's gating. To combine multiple records, useSubscription.aggregate(...records), which reads the Model, Message, and any Effect services off the records
Managed Resources (if stateful runtime handles)
- Define with
ManagedResource.make<Model, Message>()(entry => ({ key: entry(requirementsSchema, config) })).requirementsSchemais the positional first argument (usuallySchema.Option(...));configcarries theresourcetag,modelToMaybeRequirements, theacquire/releaseEffects, and theonAcquired/onReleased/onAcquireErrorMessages modelToMaybeRequirementsreturnsOption.some(params)to acquire (or re-acquire when params change) andOption.none()to release. Resources auto-acquire/release on Model state, like Subscriptions- For a resource with no params, use
Schema.Option(Schema.Null)and returnOption.some(null) - Read the service union with
ManagedResource.ServicesOf<typeof managedResources> - To embed a child Submodel's resources, use
ManagedResource.lift(childRecord)<Parent, Parent>({ read, toParentMessage })(itsreadreturnsOption<ChildModel>, so lifted requirements must beSchema.Option-wrapped). Combine records withManagedResource.aggregate(...records), which reads the Model and Message off the records - App-lifetime handles go in
resources, not here; there is nopersistent
Phase 4.5: Self-check before verification
Before running tsc or opening the browser, do a quick mechanical pass over the generated files. The reviewer in Phase 6 catches these, but catching them at write-time is cheaper than catching them after a full review round. Skip this and you inflate round-1 review noise with preventable items.
Run the lint script first, then the "Mechanical scans" block in checklist.md against src/. The scaffold wires @foldkit/oxlint-plugin, whose rules are the structural check: keyed rows, route printing, empty-object tagged calls, Rel on external links, spread inside modifyFields, Got* wrapping, Command naming. Treat every foldkit(...) diagnostic as a blocker; that is how the rules are labelled in the output. The greps then cover ground no rule touches (API drift, @foldkit/ui adoption, Effect idiom, unpaired labels, maybe* on non-Option, span([]) placeholders, redundant Effect.ignore, focus-outline resets) plus the deliberate edges of rules that are narrow: empty-object calls through a namespace, _blank inside a spread attribute array, mapped rows keyed on something other than .id, a spread in the modifyFields updates object itself, and as casts on constructor returns, which only the scaffold's oxlint config rejects. A green lint does not clear those. Each hit is either a fix or a // NOTE: justification.
Then eyeball each file you wrote:
- Every file's imports: do you actually use every symbol? (Lint catches this, but catching it here avoids a lint round later.)
- Every Message in the Union: does update have a case for it? Does the view dispatch it?
- Every state variant: is it ever entered? Does the view render something different when it's active?
- Every Command: is it tested? Does its
Succeeded*orCompleted*Message have a handler in update?
This is ~2 minutes of reading per file. It saves ~15 minutes of review loop per unresolved item.
Phase 5: Verify and Test
Gate: four commands must succeed before declaring Phase 5 complete
Before moving to Phase 6, run ALL FOUR of these and fix everything they surface. Not one, not three. All four:
npm run format # run FIRST: rewrites files
npm run lint
npm run typecheck
npm run test
Use whichever package manager the project was scaffolded with: npm run, pnpm run, yarn, or bun run. If a script is missing, run the project-local binary through that manager's exec (pnpm exec oxfmt, npm exec --no-install oxfmt, yarn exec oxfmt, bun x --no-install oxfmt). Avoid bare npx, which fetches and runs a package from the registry when the binary isn't installed locally.
Run format first because it rewrites files; running it last would leave tsc/test passing against unformatted code that a pre-commit hook would then reformat, creating a diff the user has to clean up. Running it first means lint/typecheck/test verify the exact code that will be committed.
Each catches different classes of issue:
- Format rewrites spacing, indentation, trailing commas, and line wrapping to project style. Not a "check"; a normalizer. Generated code rarely matches Oxfmt's exact formatting by accident; without this step, every
git commitproduces a cascade of formatting-only diffs. - Lint catches unused imports, unused variables, and style-rule violations. Easy to miss because generated code often imports a symbol "for completeness" that turns out not to be referenced (e.g. importing
NotValidated,Invalidfrom fieldValidation when they're only used as string literals insideMatch.tagkeys).tscdoesn't flag these. - Typecheck catches API misuse, wrong parameter shapes, missing required props, and structural type errors. Doesn't catch unused imports.
- Tests catch behavioral regressions. Don't catch either of the above.
If the project doesn't have a format/lint script, check package.json and run the binaries through your package manager's exec (pnpm exec oxfmt / pnpm exec oxlint src, or the npm / yarn / bun equivalent) directly. Don't skip either because "there's no script". The scaffolded create-foldkit-app project always ships both configured.
Fix ALL output from all four before declaring Phase 5 done. "Typecheck clean and tests pass" is insufficient. Unformatted code with unused imports is not at the bar.
Type errors first
Then generate tests using foldkit/test. There are two test styles. Name each test file for its style, beside the code under test: story.test.ts for Story tests (the state machine, driving update) and scene.test.ts for Scene tests (the rendered view). The name describes how the test works, not a source file, so it holds whether update and view live in main.ts or their own files. When a folder holds more than one test of a kind (sibling pages, component variants), prefix with the subject: login.story.test.ts. Scene runs at any level: Submodel.defineView produces a plain (model, h) => Html, so a page's view drops into scene unmodified, and a Submodel declaring ViewInputs takes a second argument the test supplies through withViewInputs(view, defaults), whose returned factory takes per-test overrides for everything except toView. A page-level Scene asserts the OutMessage a Submodel emits with expectOutMessage / expectNoOutMessage, and drives Messages from the non-view lifecycle causes with cause-named steps: Subscription.emit (only when the Message has no DOM affordance; click the actual button when it does), ManagedResource.acquire / release / failAcquire (gated on the entry's modelToMaybeRequirements, so drive the Model transition first), and CustomElement.emit (typed by the spec's event Schemas). An interaction whose handler returns Option.none() lets the event fall through, and Scene requires that be stated: follow it with expectIgnored(), or Scene fails at the next interaction or the end of the scene. Use expectHandled() where the event should have been consumed, which is the assertion behind a key being consumed so the browser default is prevented. Put a scene.test.ts in the page folder for behavior that page owns, and keep a root-level scene.test.ts for flows that cross pages, which covers how the parent folds an OutMessage, a Command the parent lifts, a route change, and view inputs the parent computes.
Import the steps as named imports from foldkit/story or foldkit/scene: import { Command, given, message, model, story } from 'foldkit/story'. A test file needs only one of the two modules, so this keeps call sites short. In the rare case a single file tests both a story and a scene, import the namespaces instead (import { Scene, Story } from 'foldkit') so Story.given and Scene.given stay distinguishable.
Story tests (story.test.ts) test the update function directly. You send Messages and assert on the Model and Commands. Study these exemplars:
${CLAUDE_SKILL_DIR}/../../examples/weather/src/story.test.ts: simple Command resolution (happy path + error path)${CLAUDE_SKILL_DIR}/../../examples/auth/src/page/loggedOut/page/login.story.test.ts: Submodel with OutMessage assertions, field validation${CLAUDE_SKILL_DIR}/../../packages/website/src/search/story.test.ts: multi-step interactions (arrow key cycling, stale result handling)
Write story pipelines covering:
- Happy path: the primary user flow from start to finish
- Error path: every fallible Command resolved with its
Failed*Message - Multi-step interaction: at least one test that chains multiple Messages and Command resolutions
- Edge cases: empty states, boundary conditions, ignored inputs (e.g. stale results, duplicate submissions)
Check an @foldkit/ui component's test namespace before writing resolvers for its Commands. For example, use Toast.test.drainEntry({ entryId }) for a newly shown toast that auto-dismisses.
Scene tests (scene.test.ts) test through the rendered view. You interact with elements by accessible locators (role, label, text) and assert on what the user sees. A scene.test.ts is REQUIRED for Tier 3+ apps. The review loop treats its absence as a BLOCKER, not a QUALITY item. No exceptions. Don't "defer" this. Study these exemplars:
${CLAUDE_SKILL_DIR}/../../examples/weather/src/scene.test.ts: basic Scene flow with form interaction and Command resolution${CLAUDE_SKILL_DIR}/../../examples/auth/src/scene.test.ts: a multi-page app's root-level Scene driving the login flow through the root view${CLAUDE_SKILL_DIR}/../../examples/auth/src/page/loggedOut/page/login.scene.test.ts: a page-scoped Scene in that same app, driving the page's ownupdate/viewrather than the root pair${CLAUDE_SKILL_DIR}/../../examples/kanban/src/scene.test.ts: scoped queries withwithin,toHaveValue, explicit test data
Write scene pipelines covering:
- View rendering: initial view has expected elements (headings, inputs, buttons)
- User interactions: click, type, submit produce visible changes
- Loading states: submitting shows loading indicator
- Error states: failed Commands show error messages in the view
- Scoped queries: use
within(parent, child)to compose a single scoped Locator (good for one-off scoped assertions or reusable named locators). Useinside(parent, ...steps)to scope a whole block of steps to the same parent. Every Locator referenced by the nested steps resolves within the parent's subtree. Reach forinsidewhen two or more steps share a scope; reach forwithinfor single-use scoping. - Prefer accessible locators:
label(...),role(...),text(...)overplaceholder(...)or CSS selectors
Run the project's test script (npm run test, or your package manager's equivalent) to verify tests pass.
Then run through the verification checklist to catch structural gaps. Fix any remaining issues before moving on.
Phase 5.5: Visual and a11y verification
Code review and automated tests don't catch rendering bugs or accessibility gaps. Two things to do before Phase 6:
Visual check
Start the dev server (npm run dev) and open the app in a browser. Click through every route. Interact with every form. Watch for:
- Inputs with missing backgrounds (Tailwind preflight strips the browser-default white;
bg-whitemust be explicit on every rawinputortextarea, meaning every one you don't route throughInputorTextareafrom@foldkit/ui) - Text that's too dim or too small to read
- Overlapping elements, broken spacing, layout shifts
- Cursor/hover states that don't feel right
- Focus rings that are invisible or missing on interactive elements
Many visual bugs are invisible to typecheck, tests, and code review. The only tools that catch them are (1) looking at the rendered output and (2) using @foldkit/ui components that already bake sensible defaults in.
If the app has UI, don't claim Phase 5 complete until you've loaded the app and clicked through it. If you can't run a browser in your environment, say so explicitly in the final report rather than skipping the check silently.
A11y check
Walk the Accessibility and Foldkit UI sections of checklist.md. Both have mechanical grep commands. Run them against src/. Don't re-list them here; the checklist is the canonical reference for these greps, and duplicating them across files invites drift.
A11y items are not "nice-to-have". They're correctness for a non-visual user.
Phase 6: Subagent Review Loop
Self-review is weaker than fresh-eyes review. After Phase 5 passes, spin up subagents to review the generated code against the quality bar, and iterate until they sign off.
Loop mechanics
Run up to three rounds. Each round:
- Spawn a review subagent using the
Agenttool withsubagent_type: general-purpose. - Read the subagent's response.
- If response is
PASS, exit the loop and proceed to Phase 7. - If response contains
BLOCKERSorQUALITYitems, fix each, then loop. NICE-TO-HAVEitems can be deferred to Phase 7's future-work list if the round budget is exhausted.
After round 3, if issues remain, exit the loop and carry the unresolved items into Phase 7 as "known polish areas". Do not silently ship flagged code. Be explicit about what's still open.
Review subagent prompt
Use a prompt of roughly this shape. Tailor only the file list and project path. Keep the rubric, output format, blind-spots checklist, and bar-setting instructions intact.
You are reviewing a freshly generated Foldkit program. The bar is:
this code should be indistinguishable in quality from hand-written
code in `packages/typing-game/client/src/` or `packages/website/src/`.
Not "works." Not "structurally valid." Typing-game quality.
Read FIRST, in this order:
1. The generated source files, project-relative: list every one
(src/main.ts, src/update.ts, ...).
2. ${CLAUDE_SKILL_DIR}/architecture.md
3. ${CLAUDE_SKILL_DIR}/conventions.md
4. ${CLAUDE_SKILL_DIR}/checklist.md
5. ${CLAUDE_SKILL_DIR}/blindSpots.md
6. At least one exemplar file matching the generated app's complexity,
from the foldkit repo (vendored at repos/foldkit/ when the project
has the subtree):
- Tier 1-2: packages/foldkit/src/runtime/runtime.ts (quality calibration)
- Tier 3-4: examples/weather/src/main.ts OR examples/form/src/main.ts
- Tier 5: examples/kanban/src/update.ts AND examples/kanban/src/domain/
- Tier 6: examples/job-application/src/update.ts AND examples/auth/src/page/
- Tier 7: packages/typing-game/client/src/page/room/
Every path above is either project-relative or resolved through
${CLAUDE_SKILL_DIR}, the same way the rest of this skill refers to its
own files. Do not rewrite them as absolute paths. An absolute path is
machine-specific, and hand-pasting one is what made an earlier version
of this prompt unusable anywhere but the machine it was written on.
Then walk the entire checklist.md against the generated code. Every item.
Then walk every entry in blindSpots.md and report one line per entry:
`<slug>: clean | flagged at <file:line>: <issue>`. Silence is not a pass.
Also read at least one of the generated files side-by-side with the
exemplar you chose. Ask: does this look like it was written by the
same hand?
Output format. Exactly this structure:
## BLOCKERS
Items that are structurally wrong, logically buggy, or violate
conventions. Must fix.
Each item: `path/to/file.ts:line: what's wrong; what to fix`.
If none: write `None.`
## QUALITY
Items that work but fall short of the bar: generic naming, inline
handlers that should be extracted, missing domain/ directory,
native methods instead of Effect modules in pipes, views that
should be decomposed, etc. These should be fixed.
Each item: `path/to/file.ts:line: the gap; the idiomatic version`.
Cite the exemplar when possible: "typing-game does this as X at
page/home/update/handleKeyPressed.ts:33-40".
If none: write `None.`
## NICE-TO-HAVE
Polish items that would push quality further but aren't required:
additional tests, slightly better names, minor refactors.
If none: write `None.`
## VERDICT
One of:
- `PASS`: the code is at the bar. Ship it.
- `NEEDS-WORK`: there are BLOCKERS or QUALITY items to address.
Do NOT write code. Review only. Be specific, be brutal, don't grade on
a curve. If you're unsure whether something is at the bar, compare it
to the exemplar. If the exemplar wouldn't write it that way, flag it.
Before finishing, confirm the generator ran all four gates (format,
lint, typecheck, test) and showed the output of each. If it claims
Phase 5 complete but a gate's output wasn't shown, flag it as a
BLOCKER naming the gate: "Run `npm run lint`: unverified." Lint
catches unused imports that tsc does not, and those leak into review
as noise.
After the loop
- If verdict is
PASSon any round → proceed to Phase 7, no caveats. - If verdict is
NEEDS-WORKafter round 3 → proceed to Phase 7 but list the outstandingBLOCKERSandQUALITYitems in the Explain output under "Known polish areas." The user should see them.
Between rounds: actually fix, don't just acknowledge
Between rounds, the generator MUST actually apply fixes for every BLOCKER and every QUALITY item the reviewer flagged. Do not carry forward items with "I'll note this" or "deferring" unless the round budget is exhausted. A QUALITY item the reviewer flagged in round N that's still present in round N+1 is a process failure. It means the generator read the review and then didn't act.
Common failure mode: the reviewer flags .length > 0 checks as QUALITY and notes Array.match/String.isNonEmpty as the fix. The generator moves to other fixes, the round 2 review flags the same thing again, and nothing happens because "round 2 is clean on BLOCKERS so we're good." It isn't good. Untriaged QUALITY items become silently-shipped rot.
Before running round N+1, produce a short written diff between "what round N flagged" and "what I changed." If the lists don't match, go back and fix the gap before running round N+1.
Phase 7: Explain
After generating the program (and passing review), walk the user through what was built:
- Files generated: list each file with a one-line description of what it contains and why it exists as a separate file (or why everything is in one file)
- Architecture decisions: explain key modeling choices, for example: which discriminated unions were used and why, which Foldkit UI components were integrated, why Flags were or weren't needed, any domain extraction decisions, etc.
- Review outcome: state how many review rounds ran and the final verdict. If
PASS, say so. IfNEEDS-WORKafter round 3, list the outstanding items verbatim under "Known polish areas" so the user knows what the reviewer flagged that didn't get fixed. - How to run: remind the user to start the dev server and what they should see
- How to extend: give concrete next steps: "to add bookmark editing, define
ClickedEditBookmarkandUpdatedEditTitleMessages, add anEditingvariant to the Model, and handle both in update" - When to restructure: mention signals that the program has outgrown its current file organization (e.g., "if update exceeds ~20 cases, consider extracting a Submodel")