Agent skill

formax-semantics-parity-workflow

Use when implementing or modifying behavior that must stay consistent across TUI and Web (mode/input/tool/replay/order). Require canonical semantics first, then TUI/Web adapters, then renderer-specific UI.

Stars 138
Forks 7

Install this agent skill to your Project

npx add-skill https://github.com/yusifeng/formax/tree/main/.codex/skills/formax-semantics-parity-workflow

SKILL.md

formax-semantics-parity-workflow

Goal

Use this skill when changing behavior that must stay consistent across TUI, app-server, and Web: mode, input lifecycle, tool sequencing, replay, or ordering.

Read First

  • docs/contracts/semantics-contract.md
  • docs/contracts/app-server-interaction-contract.md
  • docs/frontend/app-server-ui-spec.md
  • docs/contracts/interactive-input-contract.md when input lifecycle changes

These docs are canonical. If stable cross-surface behavior changes, update them before or with code.

Code Map

1) Semantic single source of truth

  • packages/core/src/features/semantics/*
    • canonicalEvents.ts
    • transcriptProjection.ts
    • modeSemantics.ts
    • replModeTransition.ts
    • turnInputBuilder.ts
    • inputStateMachine.ts

2) App-server contract emit / restore

  • packages/core/src/app-server/turnRunner.ts
  • packages/core/src/app-server/server.ts
  • packages/core/src/app-server/threadStore.ts
  • packages/core/src/app-server/store/sessionEventReader.ts
  • packages/core/src/app-server/turn/inputStore.ts

3) TUI adapter (renderer can differ, semantics cannot)

  • packages/core/src/features/repl/controller/send/send.ts
  • packages/core/src/features/repl/controller/streaming/streaming.ts
  • packages/core/src/features/repl/useReplController.ts

4) Web adapter (renderer can differ, semantics cannot)

  • packages/web-reference-react/src/eventAdapters.ts
  • packages/web-reference-react/src/App.tsx
  • packages/web-reference-react/src/store.ts
  • packages/web-reference-react/src/turnEventCursor.ts

5) Canonical docs to keep in sync

  • docs/contracts/semantics-contract.md
  • docs/contracts/app-server-interaction-contract.md
  • docs/frontend/app-server-ui-spec.md
  • docs/contracts/interactive-input-contract.md when input lifecycle changes

High-Signal Patterns

  • Semantic-first implementation order:
    1. define contract / event shape / state transition
    2. update shared semantics
    3. update app-server emit / replay state
    4. update TUI and Web adapters
    5. update renderer-only UI last
  • Ordering discipline:
    • replaySeq is the primary ordering key
    • traceId/seq are diagnostics and turn-local hints, not global order
    • on replay gap, rebuild from semantic baseline; do not keep stitching stale tails
  • Tool semantics discipline:
    • keep toolUseId -> toolName sticky behavior in semantics / adapter path
    • never depend on UI copy to infer tool state
  • Mode/input discipline:
    • mode is a semantic transition, not just a visual toggle
    • input lifecycle remains a finite-state machine, not ad-hoc UI flags

Minimal Workflow

  1. Define the event / state transition in canonical docs and the shared semantics layer first.
  2. Update app-server emit / replay state so the semantics remain recoverable.
  3. Update TUI and Web adapters to consume the shared semantics; update renderer-only UI last.
  4. If packages/core/src/features/repl/** semantic-flow files move, run the REPL semantic gate before review.
  5. Run the minimum regression set below, then review via AGENTS.md.

Minimum Regression

  • bun run type-check
  • bun run test -- packages/core/src/features/semantics
  • bun run test -- packages/core/src/features/semantics/__tests__/projectionParity.test.ts
  • bun run test -- packages/core/src/app-server/turnRunner.test.ts packages/core/src/app-server/server.test.ts packages/core/src/app-server/turn/inputStore.test.ts
  • npm --prefix packages/web-reference-react run type-check
  • npm --prefix packages/web-reference-react run test -- src/App.test.tsx src/store.test.ts src/turnEventCursor.test.ts src/toolEventNormalizer.test.ts
  • bun run test:repl-semantic-gate when packages/core/src/features/repl/** semantic-flow files change

For fixture selection and parity assertions, use references/fixtures-checklist.md.

Guardrails

  • Do not patch one renderer in isolation when the bug belongs to shared semantics.
  • Do not add a second semantic state machine inside TUI or Web.
  • Do not use UI text or copy as semantic-state input.
  • Do not introduce new ordering rules outside the shared semantics layer.
  • Do not call a parity change done until app-server, TUI, and Web consume the same semantic rule.

Expand your agent's capabilities with these related and highly-rated skills.

yusifeng/formax

formax-dev-loop-workflow

Use when working on Formax code changes and you need a disciplined dev loop: keep a single mainline task, avoid scope drift, run only targeted tests (no coverage), avoid partial staging (MM), run mandatory review before commit, include an incremental optimization check, and keep commits small and reviewable.

138 7
Explore
yusifeng/formax

formax-rework-convergence-workflow

Use when code has gone through repeated rework and may contain redundant logic, style drift, or tangled structure. Trigger when user asks for "返工收敛", "cleanup-pass", or requests a focused cleanup pass that reduces churn without changing behavior.

138 7
Explore
yusifeng/formax

formax-tool-ui-blocks-workflow

Implement or refactor Formax tool transcript UI using the Tool UI Blocks (C-lite) pattern (ToolUiBlocks renderer + blocks presenters) to avoid touching many tool presenter files; use when adjusting ⏺/⎿ spacing, indent rules, or migrating additional tools to blocks presenters with targeted Ink/Vitest tests and Codex review before commit.

138 7
Explore
yusifeng/formax

formax-web-css-convergence-workflow

Use when changing web CSS/UI styling so requirements, state ownership, and acceptance checks are locked before edits to prevent rework churn.

138 7
Explore
yusifeng/formax

formax-config-settings-workflow

Use when implementing or extending /config (storage, prompt injection, request params, UI-only toggles) with tests and strict UI parity.

138 7
Explore
yusifeng/formax

formax-rolling-plan-loop-workflow

Use when the user wants a reusable rolling execution pattern (README + TODO-INDEX) like plans/web-reference-react-refactor, and wants to run delivery in small validated loops.

138 7
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results