Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 1.73 KB

File metadata and controls

26 lines (17 loc) · 1.73 KB

@marko/run Monorepo

@marko/run is the Marko application framework: file-based routing (src/routes/** with +page.marko, +layout.marko, +handler, +middleware), a Vite plugin, and deployment adapters. pnpm workspaces; primary development happens in packages/run, adapters live in packages/adapters/*.

Commands

pnpm test                 # mocha suite (tsx loader)
pnpm run test:update      # regenerate test expectations (review the diff!)
pnpm run build            # all packages -> dist/
pnpm run lint             # eslint + prettier
pnpm run format           # eslint --fix + prettier --write
pnpm run change           # add a changeset (required for user-facing changes)

Conventions

Organize files top-down (progressive disclosure): public API/exports first, then orchestration, helpers, and low-level detail last — use function-declaration hoisting.

One changeset per PR — merge additions into the existing document instead of adding another. Keep the description to 1–2 succinct lines describing the purpose of the change, not the implementation.

Comments are a last resort and never exceed two lines: prefer self-describing code, and when one is needed it captures intent — never what the code was or what was removed. Comments use direct succinct wording and avoid jargon or cute phrasing. JSDoc is always fine, as are comments describing properties within objects, types, and interfaces.

Agent feedback

Anything actionable but out of scope for the current task — a suspected bug, cleanup, a perf/size win, tooling friction, or code that was confusing — must be recorded in agent-feedback/ before finishing. Don't silently drop it, and don't fix it inside an unrelated diff.