菜单
Regenerate the @parity/truapi TypeScript client and playground metadata from the truapi crate's rustdoc JSON. Use whenever the Rust trait surface changes.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Build and smoke-test the @parity/truapi TypeScript package (tsc + bun test). Use after regenerating the client or after touching js/packages/truapi/.
Boot the local TrUAPI dev stack (dotli host + playground) in a tmux `servers` window so the playground can be tested in a real browser. Auto-trigger on "run the playground locally", "test locally", "let me try it", "open the playground locally", "boot the stack", or any equivalent phrasing in this repo.
Write an RFC document based on user-provided notes and context. Use when the user wants to create, draft, or write an RFC.
The full local end-to-end checklist before declaring a TrUAPI change done. Chains the layered skills in order. Invoke when the user says "is this ready", "definition of done", or asks to verify a Rust→codegen→TS→playground change end-to-end.
Run the playground end-to-end inside the dotli host iframe, either via the automated Playwright suite or by driving it manually in a browser. Use to verify the wire protocol after Rust/codegen/transport changes.
Static verification of the playground (Next.js build + ESLint). Use after changing playground/ sources or after refreshing the @parity/truapi snapshot.
| name | regen-codegen |
| description | Regenerate the @parity/truapi TypeScript client and playground metadata from the truapi crate's rustdoc JSON. Use whenever the Rust trait surface changes. |
Mirrors step 2 of docs/local-e2e-testing.md. Skip if your change is
purely Rust-internal (e.g. versioned wrapper conversion logic that does
not change rustdoc output) or purely TS-side.
./scripts/codegen.sh
Expected output: Generated client at js/packages/truapi/src/generated/,
Generated playground metadata ....
The script is cargo +nightly rustdoc --output-format json →
truapi-codegen → prettier --write → npm run build in
js/packages/truapi.
git status js/packages/truapi/src/generated \
js/packages/truapi/src/playground
git diff js/packages/truapi/src/generated/
The diff shape should match the Rust diff — new methods produce new client stubs and wire-table entries. Commit the regenerated files alongside the Rust changes.
rustup toolchain install nightly.unresolved link to ... warnings from rustdoc break codegen quietly:
truapi-codegen will still emit, but you may miss an item in the
generated TS. Fix by turning the link into a fully-qualified path
(super::T, crate::vXY::T) or dropping the link, then rerun.truapi-codegen panics on an unsupported rustdoc shape → the trait
added a Rust feature codegen does not know how to project. Extend
truapi-codegen rather than working around it in the trait.scripts/codegen.sh rebuilds dist/ for @parity/truapi but does NOT
refresh playground/node_modules/@parity/truapi. Run the
refresh-playground-snapshot skill next.