qualimetrix/qualimetrix

CLI tool for static analysis of PHP code - detects architectural mess and complexity issues

Maintainers

Package info

github.com/qualimetrix/qualimetrix

pkg:composer/qualimetrix/qualimetrix

Statistics

Installs: 1

Dependents: 0

Suggesters: 0

Stars: 1

Open Issues: 0

v0.16.0 2026-05-01 06:34 UTC

README

Static analysis tool for PHP code quality metrics.

Documentation | Quick Start | llms.txt

Features

  • Complexity Metrics: Cyclomatic (CCN), Cognitive, NPATH
  • Maintainability: Halstead metrics, Maintainability Index
  • Coupling: RFC, Instability, Abstractness, Distance from Main Sequence
  • Cohesion: TCC/LCC, LCOM4, WMC
  • Size: LOC, Class/Method/Property Count
  • Structure: DIT, NOC
  • Architecture: Circular Dependency Detection

Quick Start

# Install
composer require --dev qualimetrix/qualimetrix

# Analyze
bin/qmx check src/

# With specific format
bin/qmx check src/ --format=json

# Pre-commit hook
bin/qmx hook:install

Output Formats

Format Use Case
text CLI, human-readable
json CI/CD integration
checkstyle Jenkins, SonarQube
sarif GitHub Security, VS Code
gitlab GitLab Code Quality

Configuration

Create qmx.yaml (full format):

rules:
  complexity.cyclomatic:
    method:
      warning: 15
      error: 25

Or use CLI options:

bin/qmx check src/ --cyclomatic-warning=15 --cyclomatic-error=25

Git Integration

# Show violations in staged files only
bin/qmx check src/ --report=git:staged

# Show violations in changed files
bin/qmx check src/ --report=git:main..HEAD

Baseline Support

# Generate baseline for existing violations
bin/qmx check src/ --generate-baseline=baseline.json

# Use baseline
bin/qmx check src/ --baseline=baseline.json

Documentation

Requirements

  • PHP 8.4+
  • Composer

Development

composer install
composer test      # Run tests
composer phpstan   # Static analysis
composer check     # Full validation

License

MIT