Files
pplus-web/AGENTS.md
T
2026-10-05 03:03:38 +00:00

7.7 KiB

AGENTS.md

Instructions for coding agents (and people) changing Programming+. Read this first, then the README for what the app is and where things are. When this file and a task's instructions disagree, the task wins; say so in your summary.

Build, test, and the gate

pixi run test     # build, then every test (node --test against dist/, the corpus pipeline's Python tests included)
pixi run ci       # the gate: every test, and no Mojo program of ours failing

Without pixi (a sandbox with only Node and Python):

tsc -p tsconfig.json && node --test tests/*.test.mjs
python3 scripts/mojo/corpus.py status --strict

Finish every change with the gate green. The baseline passes completely; there is no known failure to work around. If a test fails, fix the cause or stop and report it. Do not skip, loosen, or delete a test to get green.

The full suite takes about two minutes. While iterating, build and run one file: tsc -p tsconfig.json && node --test tests/state.test.mjs.

Hard rules

  1. Do not edit generated files by hand. src/mojo/generated/* and quarto/_extensions/pplus/syntax/mojo.xml come from the corpus pipeline (pixi run mojo-emit, mojo-status, play). quarto/_extensions/pplus/pplus-views.css comes from styles.css, and pplus-hw.css and course/*.css beside it from styles/course/ (pixi run quarto-css; a test fails while they are out of date, so run it after changing a rule the views use). mojo/corpus/ comes from mojo-harvest. mojo/golden/ holds godbolt's answers and comes only from mojo-verify.
  2. Do not edit a .mojo file's text unless the task needs it. A stored godbolt answer is keyed by the whole source, header comments included, so any edit (even to a comment) makes the program unverified until it is asked again on the network. If you add or change one, say in your summary that it needs pixi run mojo-verify-item '<corpus>/<name>'.
  3. Never claim Mojo compiles, runs, or prints something without the real compiler's answer. Mojo is pinned to 1.1.0. The checker may never report an error on a program the compiler accepts, and the interpreter must print exactly what godbolt printed or decline; tests/mojo-check.test.mjs and tests/mojo-run.test.mjs hold them to that. Every Mojo construct you write into the app must pass checkMojo, and every standard-library name must exist in src/mojo/generated/stdlib.ts or types.ts.
  4. No new dependencies. TypeScript is the only npm package. There is no bundler, no framework, and no runtime dependency; the corpus pipeline is Python's standard library only. CodeMirror is vendored as one built module (src/vendor/), rebuilt only by scripts/vendor/codemirror.sh.
  5. You have no network in most sandboxes. Godbolt (mojo-verify, Compile & run) and GitHub (mojo-harvest, mojo-fetch) need one. Never fake their results; leave those steps to the owner and list them.
  6. Keep the workspace working while you change it. Code panes are always the CodeMirror editor (Editor in src/ui/editor.ts, over the vendored src/vendor/codemirror.js), never a <textarea>; tests/editor.test.mjs checks it. Keep the workspace's parts as they are unless the task changes them: the pane tabs over one editor, the stepper docked under the editor, the side column (the inspect panel, whose first tab is the Run view), and the dock; in the Hardware area, the code on the left and the arrangeable board on the right. Restyle or rearrange them only when asked, and after any UI change open the app (pixi run dev) and check that the editor has line numbers and highlighting, the stepper steps, and the styles loaded.

Conventions

  • Commands are pixi tasks. Name them as pixi run <task> in docs, comments, and messages. A new command is a task in pixi.toml with a description and a row in the README's Commands table; tests/tasks.test.mjs fails otherwise, and also fails on any pixi run <name> that names no task. package.json keeps only build, watch, check, dev, test (what CI uses).
  • Docs. The README is the front door: keep it short. Put behavior in docs/app.md, exercises in docs/exercises.md, Mojo of our own and the pipeline in docs/mojo-corpus.md, the engines in docs/engines.md, deployment in docs/deploy.md, and the Quarto extension in quarto/README.md. Update the document a change belongs in, in the same commit.
  • Tests run against dist/ with no DOM. Put logic in DOM-free modules (src/core/, src/services/, src/mojo/, src/quarto/) and test it there. The views in src/ui/views/ also run outside a browser, under the small document of src/quarto/dom.ts, when the Quarto extension renders them: a view may use the selectors that document knows (compound selectors and the descendant combinator) and must not need layout to produce its markup. When a test needs localStorage, install a fake on globalThis and remove it in finally, as tests/state.test.mjs does. For a UI change, write a short manual check list in the commit message.
  • TypeScript. Strict mode, ES modules, imports with the .js suffix (from './state.js'). Indent like the file you are editing (some files use two spaces, some four).
  • Stable ids. Diagnostic ids (matho-refused, reserved-name, ...) and reference section ids are asserted by tests and linked from guides. Change one only on purpose, and update every test and link that names it.
  • Saved state. PlayState in src/core/state.ts is what share links, localStorage, and .pplus.json files hold, and normalize() reads it. A new field goes into normalize(); a field the student edits goes into EDITS (it drives editedFrom() and editsFingerprint()).
  • Writing. User-facing copy is US English (color, behavior, optimized, labeled). Plain sentences; say what a thing does, not how good it is.

Adding things

To add Do
A catalog problem pixi run new-exercise <id> for one built around a Mojo program, or copy src/exercises/_template.ts (docs/exercises.md)
A question about the compiler pixi run new-probe <name> "<question>"
Realistic Mojo for the interpreter pixi run new-stress <name> "<what it exercises>", with the output you predict in # expect-stdout: lines
A pseudo regression program a file in tests/corpus/ whose // EXPECT: lines are the output it must print
A command a task in pixi.toml and a row in the README's Commands table
A language a LanguageService (src/core/types.ts) in src/services/, registered in src/services/index.ts
A Quarto shortcode a function in the table quarto/_extensions/pplus/pplus.lua returns, a row in SHORTCODES (src/quarto/shortcodes.ts) and in scripts/check-pages.mjs, a sample in the gallery (src/ui/quarto.ts) and a use in quarto/example/; a rendered view is a case of renderStatic (src/quarto/render.ts); a view of the machine is a name in HW_NAMES (src/quarto/machine.ts), HW_VIEWS in pplus.lua and HW_VIEWS in scripts/check-pages.mjs

Delivering work

  • One logical change per commit, with a message that says what changed and why: the problem first, then what each part of the change does.
  • When the owner asks for patches, export them with git format-patch -o patches/ <base> (the patches/ folder is ignored by git) and do not paste whole files into chat. If the tree you were given has no .git, run git init and commit it unchanged first, so the patches have a base.
  • End with a summary: what you changed, the gate's result, anything you could not verify (network steps, manual UI checks), and anything you noticed but left alone.