codemod-rust-workspace

star 1.0k

Use when working on Codemod's Rust workspace, including workflow engine crates, models, state, runners, scheduler, CLI-adjacent Rust crates, schema generation, Cargo features, Rust tests, clippy, rustfmt, or CI parity.

codemod By codemod schedule Updated 5/14/2026

name: codemod-rust-workspace description: Use when working on Codemod's Rust workspace, including workflow engine crates, models, state, runners, scheduler, CLI-adjacent Rust crates, schema generation, Cargo features, Rust tests, clippy, rustfmt, or CI parity.

Codemod Rust Workspace

Start Here

  1. Read the nearest AGENTS.md for the crate you are changing.
  2. Identify the crate role before editing:
    • butterflow-models: workflow schema/data contracts.
    • butterflow-core: execution engine, step execution, reports, git/file operations.
    • butterflow-state: state adapters.
    • butterflow-runners: Docker/Podman/direct runner abstractions.
    • butterflow-scheduler: task scheduling and WASM package logic.
    • codemod: CLI command surface and TUI.
    • codemod-sandbox: JSSG runtime and sandbox.
    • testing-utils: shared test helpers.
  3. Prefer workspace dependencies in root Cargo.toml.

Implementation Rules

  • Keep model contracts in crates/models; avoid duplicate public structs in higher-level crates.
  • Preserve async cancellation and error propagation.
  • Avoid logging-only failures for user-visible workflow behavior.
  • Do not write directly to stdout/stderr from non-CLI crates. Return structured data, errors, events, reports, or log records and let crates/cli choose text, TUI, JSONL, or task-log routing.
  • Keep feature gates meaningful, especially docker, podman, wasm, native, and real-fs.
  • For schema-affecting model changes, run cargo xtask schema and review generated diffs.

Validation

  • Focused crate: cargo test -p <crate>
  • Workspace: cargo test
  • Format: cargo fmt --check
  • Lint: cargo clippy --tests --no-deps -- -D warnings
  • CI parity for terminal dependencies: bash ./scripts/check-single-crossterm.sh
Install via CLI
npx skills add https://github.com/codemod/codemod --skill codemod-rust-workspace
Repository Details
star Stars 1,029
call_split Forks 80
navigation Branch main
article Path SKILL.md
More from Creator