AlCheck

A parallel code quality checker for Elixir projects. Runs format, compile, credo, dialyzer, and tests concurrently with smart test partitioning.

Features

• Parallel Execution - all checks run concurrently to maximize CPU utilization
• Test Partitioning - splits test suite across multiple partitions
• Coverage Merging - combines partition coverage into a single report with caching
• Modified Tests - run only tests changed on your branch (granular line-level or whole modules)
• Failed Test Rerun - re-run only previously failed tests
• Auto-fix - configurable fix commands for format and credo issues
• Real-time Progress - animated status lines with test counts and spinner
• Configurable - .check.json for all settings, builtin: checks for Elixir-powered logic

Installation

Add al_check to your list of dependencies in mix.exs:

def deps do
  [
    {:al_check, "~> 0.1.0"}
  ]
end

Then install globally:

mix deps.get
mix check.install
# if you use asdf
asdf reshim

Usage

check                                # Run default checks
check -v                             # Show version
check --init                         # Create .check.json with defaults
check --help                         # Show help
check --fast                         # Run only fast checks (format, compile, credo)
check --only format,test             # Run specific checks
check --only modified_tests          # Run only modified/new tests vs base branch
check --only modified_test_modules   # Run whole test files modified on branch
check --partitions 4                 # Run tests with 4 partitions
check --dir test/foo,test/bar        # Run tests from specific directories
check --failed                       # Re-run only failed tests from previous run
check --fix                          # Apply auto-fixes
check --watch                        # Monitor test partition files in real-time
check --coverage                     # Show coverage report (cached if unchanged)
check --verbose                      # Print test output directly
check --test-args '--exclude slow'   # Pass custom args to mix test (quoted string)
check --repeat 10                    # Run tests with --repeat-until-failure

Available Checks

Workflows

Failed Test Workflow

check --only test     # Run tests, failures saved automatically
check --failed        # Re-run only the failed tests

Auto-fix Workflow

check --only format,credo  # Run checks and store output
check --fix                # Apply fixes from stored output

Modified Tests Workflow

check --only modified_tests           # Run only changed test lines
check --only modified_test_modules    # Run whole changed test files
check --only modified_tests --repeat 5  # Repeat modified tests

modified_tests detects:

• Setup/describe changed -> runs the whole file
• Test body changed -> runs only that specific test line
• Module-level change -> runs the whole file

Coverage Workflow

check --coverage    # Show coverage report (cached if cover/ unchanged)

Configuration

Create a .check.json in your project root (check --init generates one with defaults):

{
  "run": ["format", "compile", "compile_test", "dialyzer", "credo", "credo_strict", "test"],
  "fast": ["format", "compile", "compile_test", "credo", "credo_strict"],
  "partitions": 3,
  "max_concurrency": 10,
  "test_args": "--warnings-as-errors",
  "default_repeat": 100,
  "base_branch": "main",
  "coverage": {
    "mod": "native",
    "limit": 80,
    "html": false,
    "baseline_cmd": "git show origin/main:coverage.txt"
  },
  "fix": [
    {"run": "mix format"},
    {"run": "mix recode", "files": ".check/credo*.txt"}
  ],
  "checks": {
    "format": {"name": "Formatting", "run": "mix format --check-formatted"},
    "compile": {"name": "Compile", "run": "mix compile --warnings-as-errors"},
    "credo": {"name": "Credo", "run": "mix credo --all"},
    "modified_tests": {"name": "Modified Tests", "run": "builtin:modified_tests"},
    "modified_test_modules": {"name": "Modified Test Modules", "run": "builtin:modified_test_modules"}
  }
}

All fields are optional. CLI flags override config values.

Key config options

Custom checks

Each check has a run string (shell command) and optional name:

"sobelow": {"name": "Security", "run": "mix sobelow --config"}

Use builtin: prefix for Elixir-powered checks:

"modified_tests": {"run": "builtin:modified_tests"}

Use {base_branch} placeholder in shell commands — replaced at runtime:

"my_check": {"run": "git diff {base_branch}... --stat"}

Coverage

"coverage": {
  "mod": "native",
  "limit": 80,
  "html": false,
  "baseline_cmd": "git show origin/main:coverage.txt"
}

Fix commands

"fix": [
  {"run": "mix format"},
  {"run": "mix recode", "files": ".check/credo*.txt"}
]

files is a glob pointing to output files from previous checks. File paths are extracted from their contents and passed as arguments to the command. Supports globs like .check/credo*.txt to match multiple files.

Output Files

AlCheck creates a .check/ directory:

Requirements

• Elixir ~> 1.18
• Mix build tool

Documentation

Full documentation is available at https://hexdocs.pm/al_check.

License

This project is licensed under the MIT License - see the LICENSE file for details.