Imported from VDuchauffour/rust-template (AGENTS.md). Install upstream with npx skills add VDuchauffour/rust-template. Copyright stays with the author.

AGENTS.md

Guidance for OpenCode sessions working in this repository.

What this repo is

A Copier template for scaffolding Rust projects. It is not itself a Rust application — there is no Cargo.toml or src/ at the root. Do not run cargo build, cargo test, or cargo clippy at the repo root; they will fail.

All renderable project files live under template/ as Jinja templates (suffix .jinja). The template is defined by copier.yml at the root, which sets _subdirectory: template.

Two-tier layout — do not conflate

The same split applies to .pre-commit-config.yaml, .yamlfix.toml, .vscode/, .devcontainer/ — all live in template/ and are rendered into generated projects, not used by the template repo itself.

Testing template changes locally

# Render the template into a temp dir. All three flags are mandatory:
#   --with jinja2-time  → copier.yml uses jinja2_time.TimeExtension
#   --vcs-ref=HEAD      → test the working tree, not the latest git tag
#   --trust             → _tasks run shell commands (rm -f ...)
uvx --with jinja2-time copier copy . /tmp/render \
	--defaults --vcs-ref=HEAD --trust

# Then verify the rendered project compiles:
cd /tmp/render && cargo check && cargo +nightly fmt --check && cargo clippy -- -D warnings

To test a specific variant (e.g. no license, or with crates.io publish):

uvx --with jinja2-time copier copy . /tmp/render \
	--defaults --vcs-ref=HEAD --trust \
	--data license=None --data copyright_holder= \
	--data publish_to_crate=true --data build_binaries=true

Copier _tasks (post-render conditional deletion)

copier.yml defines three tasks that run after rendering:

• publish_to_crate=false → removes .github/workflows/publish.yml
• build_binaries=false → removes .github/workflows/build-binaries.yml
• license=='None' → removes LICENSE

These are shell commands, which is why --trust is required when copying.

Toolchain quirks

• rustfmt requires nightly: cargo +nightly fmt. The rustfmt.toml sets group_imports = "StdExternalCrate", which is a nightly-only option. The CI and justfile both pin +nightly for formatting.
• pre-commit requires uv: just pre-commit-install runs uvx pre-commit install. uv must be on PATH.
• No Cargo.lock committed — gitignored (library convention) at both root and template levels.

just recipes (in template/justfile)

Available in rendered projects (or in the template repo if you copy a justfile out). Key shortcuts:

PR conventions

Enforced by .github/workflows/pr-enhancement.yml at the repo root:

• PR titles must follow conventional commits (e.g. feat:, fix:, chore:).
• Subject line must not start with an uppercase letter.
• PRs labeled dependencies bypass title validation (for Renovate).