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 1 month ago
JSON representation

Beautiful and understandable static analysis tool for PHP

• Host: GitHub
• URL: https://github.com/phpmetrics/PhpMetrics
• Owner: phpmetrics
• License: mit
• Created: 2013-12-13T15:31:43.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2024-08-07T07:47:05.000Z (4 months ago)
• Last Synced: 2024-10-29T15:03:07.174Z (about 1 month ago)
• Topics: ci, metrics, php, quality, static-analyzer
• Language: PHP
• Homepage: https://phpmetrics.github.io/website/
• Size: 28.7 MB
• Stars: 2,471
• Watchers: 81
• Forks: 259
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome - phpmetrics/PhpMetrics - Beautiful and understandable static analysis tool for PHP (PHP)
• awesome-php - PHP Metrics - A static metric library. (Table of Contents / Static Analysis)
• awesome-php-cn - PHP Metrics - 一个静态度量库. (目录 / 静态分析 Static Analysis)
• awesome-projects - PHP Metrics - A static metric library. (PHP / Static Analysis)
• php-awesome - PhpMetrics - 可视化静态分析结果 (类库 / 代码检查/静态分析)
• awesome-php - PHP Metrics - A static metric library. (Table of Contents / Static Analysis)

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 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.