Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/phpmetrics/PhpMetrics

Beautiful and understandable static analysis tool for PHP
https://github.com/phpmetrics/PhpMetrics

ci metrics php quality static-analyzer

Last synced: about 2 months ago
JSON representation

Beautiful and understandable static analysis tool for PHP

Lists

README

        

# PhpMetrics

[![License](https://poser.pugx.org/phpmetrics/phpmetrics/license.svg)](https://packagist.org/packages/phpmetrics/phpmetrics)
[![Latest Stable Version](https://poser.pugx.org/phpmetrics/phpmetrics/v/stable.svg)](https://packagist.org/packages/phpmetrics/phpmetrics)
[![Slack](https://img.shields.io/badge/slack/phpmetrics-yellow.svg?logo=slack)](https://join.slack.com/t/phpmetrics/shared_invite/enQtODU3MjQ4ODAxOTM5LWRhOGFhODMxN2JmMDRmOGVjNGQ0ZjNjNzVlNDIwNzQ2MWQ2YzgxYmRlNmM5NzIzZjlhYTFjZjZhYzAyMjM0YmE)

![Standard report](https://phpmetrics.github.io/website/assets/preview.png)

PhpMetrics

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

[Documentation](https://phpmetrics.github.io/website/) | [Twitter](https://twitter.com/Halleck45) | [Contributing](https://github.com/phpmetrics/PhpMetrics/blob/master/doc/contributing.md)



## Quick start

Follow the [quick start guide](https://phpmetrics.github.io/website/getting-started/) to get started.
```bash
# 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
```

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

> You can use a [configuration file](https://phpmetrics.github.io/website/configuration/) to customize
> the report, add options, configure rules for Continuous Integration, etc.

## Metrics

You'll find detailed list of metrics in [documentation](https://phpmetrics.github.io/website/metrics/), or
running `php ./vendor/bin/phpmetrics --metrics`

## Author

+ Jean-François Lépine <[@Halleck45](https://twitter.com/Halleck45)>

## License

See the [LICENSE](LICENSE) file.

## Contributing

See the [CONTRIBUTING](doc/contributing.md) file.