Skip to content

CODEX.md

Latest commit

 

History

History
58 lines (43 loc) · 2.04 KB

CODEX.md

File metadata and controls

58 lines (43 loc) · 2.04 KB
Raw

CODEX.md

Codex working notes for this repo. Start with CLAUDE.md for the full project guide.

Mandatory command rules

  • Always run Rust tooling through a globally-installed soldr.
  • Never run bare cargo, rustc, rustfmt, clippy-driver, python, or pip.
  • Never run uv run soldr ... — soldr is no longer installed into the repo-local uv environment (see issue #251). Install soldr globally (e.g. uv tool install soldr or the install script at https://github.com/zackees/soldr) and call it directly.
  • Approved Rust forms in this repo are:
    • soldr cargo ...
    • soldr rustc ...
    • soldr rustfmt ...

Why

  • Repo hooks enforce this.
  • soldr resolves each tool via rustup which so the rustup-managed toolchain is always used instead of a stale system or Chocolatey install.
  • The normal Cargo path is soldr cargo ..., so repo Rust builds use soldr's managed zccache path by default; do not add repo-specific RUSTC_WRAPPER wiring for standard builds.
  • If you bypass them, you can hit wrong-toolchain errors.

Use these

soldr cargo check --workspace --all-targets
soldr cargo test -p fbuild-build -- --ignored
soldr cargo clippy --workspace --all-targets -- -D warnings
soldr cargo fmt --all
soldr rustfmt --check crates/fbuild-build/src/compiler.rs

uv run test
uv run test --full
uv run test -p fbuild-build -- some_test_name

Optional wrapper-mode

uv run python ci/zccache_setup.py

This configures rustc-wrapper = "zccache" for local wrapper-mode experiments. Standard builds should use soldr above.

If soldr is missing

If a command fails

  • First check whether you used one of the approved wrapper forms above.
  • If not, rerun it the required way before debugging anything else.
  • If the pinned toolchain is missing, run ./install via uv run --script install. Read CLAUDE.md for repo instructions.