go-crap

go-crap

CRAP score calculator for Go projects. Calculates the CRAP score (cyclomatic complexity × coverage) for every function in a Go module. Inspired by cargo-crap for Rust.

Installation

go install github.com/padiazg/go-crap@latest

Or build from source:

git clone https://github.com/padiazg/go-crap.git
cd go-crap
go build -o go-crap .

Or use Brew:

brew tap padiazg/go-crap 
brew install go-crap

Usage

go-crap scan [path] [flags]

Scans the Go module at the given path (defaults to .) and outputs a ranked table of functions by CRAP score.

Example

# Scan current module
go-crap scan

# Scan a specific directory
go-crap scan ./internal/score

# Show only the 10 worst offenders
go-crap scan --top 10

# Fail CI if any function exceeds threshold
go-crap scan --fail-above --threshold 30

# Exclude test files and protobuf
go-crap scan --exclude '.*_test\.go' --exclude 'pb/.*\.go'

Flags

Output Formats

Coverage Unavailable Warning

When a Go module fails to build or run tests, its coverage data is unavailable. go-crap detects this and reports it in all output formats:

• table — coverage column shows N/A ‼ with a footer listing unavailable modules
• json — coverage is null and coverage_warning contains the error message
• github — ::warning annotation with the module error
• sarif — result with RuleID: "go-crap/coverage-unavailable"
• pr-comment — separate "Coverage Unavailable" section

Example: SARIF output

go-crap scan --format sarif > crap.sarif

Example: PR comment output

go-crap scan --format pr-comment > pr-comment.md

Example: Mutation report validation

go-crap scan --mutation-report gremlins-report.json

When a function has lived mutants (mutations that survived because tests didn't catch them), go-crap marks the coverage as unreliable (⚠) and recalculates the CRAP score assuming 0% coverage. This catches functions that appear well-tested but have blind spots.

Example: Detailed mutation output

go-crap scan --mutation-report gremlins-report.json --format json --detailed

The --detailed flag includes full mutation failure details in the output: type, line, original_code, and replacement_code for each survived mutant. In json format, these appear as a mutation_details array per entry. In sarif and pr-comment formats, survived mutations with code snippets are appended to the warning messages.

What is CRAP?

CRAP = Cyclomatic Readability And Predictability. It measures how expensive a function is to test.

$CRAP(CC, coverage) = CC^2 × \left(1 - \frac{coverage}{100}\right)^3 + CC$

A function with high cyclomatic complexity and low coverage scores the worst. A simple, fully tested function scores the best.

How It Works

go-crap scan
  │
  ├── scan.Scan()           — unified pipeline, discovers modules, filters, and ranks
  │   ├── coverage.Scan()   — discover Go modules, run go test -cover
  │   ├── complexity.Analyze() — walk AST, compute cyclomatic complexity
  │   ├── merge.Merge()     — join by (filepath, funcname), propagate coverage warnings
  │   ├── score.Score()     — apply CRAP formula + missing policy
  │   ├── mutation.Annotate() — validate coverage with mutation testing (optional)
  │   └── report.Format()   — table / json / github / sarif / pr-comment
  │
  └── pkg/utils/            — regex helpers for --exclude patterns

• internal/scan — unified pipeline orchestrating the full scan flow (coverage → complexity → merge → score → filter → output)
• internal/complexity — AST walking to compute cyclomatic complexity (adapted from gocyclo, BSD-3-Clause)
• internal/coverage — module discovery + go test -cover profiling (adapted from test-finder, MIT)
• internal/merge — double-index join of coverage and complexity data, propagates coverage-unavailable warnings from errored modules
• internal/score — CRAP formula + missing coverage policy + EntryList wrapper
• internal/mutation — parses gremlins JSON mutation reports and annotates CRAP entries with coverage reliability
• internal/report — output formatters (table, JSON, GitHub, SARIF, PR comment)
• pkg/logger — Logger interface and configuration types
• pkg/slogger — slog-backed Logger implementation
• pkg/utils — regex helper functions for exclude patterns

CI Integration

# .github/workflows/crap.yml
- run: go-crap scan --fail-above --threshold 30 --format github

• --fail-above exits with code 1 when any function exceeds the threshold
• --format github emits ::warning annotations that render as PR comments
• --format sarif outputs SARIF 2.1.0 for integration with code scanning tools
• --format pr-comment generates a markdown table for pull request comments
• --output -o writes results to a file instead of stdout
• --mutation-report validates coverage reliability against mutation testing results
• --detailed includes mutation failure details (code, line, type) in report output
• Coverage-unavailable warnings are emitted for modules where go test fails

Prior art and references

• Savoia, A. & Evans, B. (2007). The CRAP Metric.
• Crap4j — the original Java implementation.
• cargo-crap — Inspiration for this project

License

This project is licensed under the MIT License.

Full Documentation

For a complete guide covering all flags, examples, and the CRAP formula in detail, see the documentation site.