halleck45/phpmetrics

This package is abandoned and no longer maintained. The author suggests using the phpmetrics/phpmetrics package instead.

Static analyzer tool for PHP : Coupling, Cyclomatic complexity, Maintainability Index, Halstead's metrics... and more !

v3.0.0rc6 2024-02-08 11:24 UTC

Requires

• php: >=8.1
• ext-tokenizer: *
• nikic/php-parser: ^5.0

Requires (Dev)

• phake/phake: ^4.4.0
• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3
• phpstan/phpstan-strict-rules: ^1.5
• phpunit/phpunit: ^10.5
• roave/security-advisories: dev-latest
• sebastian/comparator: >=5.0.0
• squizlabs/php_codesniffer: ^3.8
• symfony/dom-crawler: ^6.4

Suggests

• ext-dom: To allow XML parsing and report results.
• ext-yaml: To allow yaml parsing of configuration files.

Replaces

• halleck45/php-metrics: *
• halleck45/phpmetrics: *

MIT

• Jean-François Lépine

• testing
• quality
• analysis
• qa

README

PhpMetrics provides metrics about PHP project and classes, with beautiful and readable HTML report.

Documentation | Twitter | Contributing

Quick start

Follow the quick start guide to get started.

# install the package as a dev dependency
composer require phpmetrics/phpmetrics --dev

# run PHPMetrics to analyze a folder and generate a report
php ./vendor/bin/phpmetrics --report-html=myreport <folder-to-analyze>

Then open the generated ./myreport/index.html file in your browser.

You can use a configuration file to customize the report, add options, configure rules for Continuous Integration, etc.

Metrics

You'll find detailed list of metrics in documentation, or running php ./vendor/bin/phpmetrics --metrics

Author

• Jean-François Lépine <@Halleck45>

License

See the LICENSE file.

Contributing

See the CONTRIBUTING file.