tomevault-io Codegen Sync Skill
This project uses code generation to keep TypeScript SDK types in sync with Elixir protocol definitions. When Elixir types change, the TypeScript side must be regenerated.
When to act
- After modifying any Elixir structs, message types, or RPC definitions in
lib/opal/. - After adding or changing tool schemas in
lib/opal/tool/. - When CI fails with a codegen drift error.
- When the user asks to sync or regenerate types.
Commands
# Run codegen (Elixir -> TypeScript)
mix run scripts/codegen_ts.exs
# Verify codegen is up to date (what CI runs)
mix run scripts/codegen_ts.exs --check
Workflow
- After modifying Elixir protocol types, run
mix run scripts/codegen_ts.exs. - Review the generated diff in
cli/src/sdk/to verify correctness. - Include the regenerated files in the same commit as the Elixir changes.
Rules
- Never hand-edit generated files. Always regenerate from the Elixir source.
- If codegen output looks wrong, fix the Elixir definitions or the codegen script (
scripts/codegen_ts.exs), not the output. - Always commit codegen output alongside the source changes — never in a separate commit.
Converted and distributed by TomeVault — claim your Tome and manage your conversions.