testing

name	testing
description	Run tests, linting, and formatting checks for cargo-version-info

Testing Skill

Use this skill when running tests, checking code quality, or verifying the codebase compiles and passes all checks.

Running Tests

Tests must run single-threaded due to shared state:

# Run all tests
cargo test -- --test-threads=1

# Run a specific test
cargo test test_name -- --test-threads=1

# Run tests with output
cargo test -- --test-threads=1 --nocapture

Formatting

Formatting requires the nightly toolchain:

# Check formatting (CI mode)
cargo +nightly fmt --all -- --check

# Apply formatting fixes
cargo +nightly fmt --all

Linting with Clippy

Clippy also requires nightly with strict settings:

cargo +nightly clippy --all-targets --all-features -- -D warnings -W missing-docs

This enforces:

• All warnings as errors (-D warnings)
• Documentation on all public items (-W missing-docs)
• Max 120 lines per function
• Max nesting depth of 5

Full Check Workflow

Run all checks in sequence:

cargo +nightly fmt --all -- --check && \
cargo +nightly clippy --all-targets --all-features -- -D warnings -W missing-docs && \
cargo test -- --test-threads=1

Building

# Debug build
cargo build

# Release build
cargo build --release

# Check only (faster, no codegen)
cargo check

Git Hooks (Automatic Checks)

Git hooks in .githooks/ run automatically on commit via Rhusky:

• pre-commit: Runs fmt and clippy on Rust files
• commit-msg: Validates conventional commit format with scope
• post-commit: Verifies commit signature

If hooks aren't active, run cargo build to trigger Rhusky installation. Hooks are skipped in CI environments.

Common Issues

Nightly toolchain not installed

rustup install nightly

Test failures with threading

Always use --test-threads=1. Tests share git repository state and will fail with race conditions otherwise.

Missing docs warning

All public items need documentation. Add doc comments:

/// Brief description of the function.
pub fn my_function() {}