omen: Instructions file for Claude Code

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Build and Development Commands

# Setup git hooks (run once after clone)
lefthook install

# Format code
cargo fmt

# Run linter
cargo clippy --all-targets --all-features -- -D warnings

# Run all tests
cargo test

# Run tests with coverage
cargo llvm-cov --all-features --ignore-filename-regex 'main\.rs$'

# Build release binary
cargo build --release

# Run a single test
cargo test test_complexity_simple

# Run tests for a specific module
cargo test analyzers::complexity

Architecture

Omen is a multi-language code analysis CLI built in Rust. It uses tree-sitter for parsing source code across 13 languages.

Module Structure

src/
  cli/           - CLI entry point using clap
  config/        - Configuration loading and schema
  core/          - Core types and traits
  analyzers/     - Analysis implementations
    complexity.rs - Cyclomatic and cognitive complexity
    satd.rs       - Self-admitted technical debt
    deadcode.rs   - Unused code detection
    churn.rs      - Git history file churn
    duplicates.rs - Code clone detection (MinHash+LSH)
    defect.rs     - Defect probability (PMAT)
    changes.rs    - JIT commit-level risk
    tdg.rs        - Technical Debt Gradient
    graph.rs      - Dependency graph (Mermaid)
    hotspot.rs    - High churn + complexity
    temporal.rs   - Temporal coupling
    ownership.rs  - Code ownership and bus factor
    cohesion.rs   - CK metrics (WMC, CBO, RFC, LCOM4, DIT, NOC)
    repomap.rs    - PageRank-ranked symbols
    outline.rs    - File and symbol outlines
    impact.rs     - Symbol blast-radius analysis
    smells.rs     - Architectural smells (Tarjan SCC)
    flags.rs      - Feature flag detection
    mutation/    - Mutation testing (21 operators, parallel execution)
  benchmark/     - Paired quality benchmark comparing two omen binaries
  eval/          - Fail-closed scoring of paired coding-agent outcome records
  semantic/      - TF-IDF indexing, search, cache, and multi-repo support
  context.rs     - Agent-oriented repository context
  symbol.rs      - Symbol lookup and relationship reports
  git/           - Git operations (log, blame, diff)
  parser/        - Tree-sitter wrapper
  mcp/           - MCP server for LLM integration
  output/        - Output formatting (JSON/Markdown/text)
  report/        - minijinja report rendering and embedded HTML template
  score/         - Repository health scoring