https://github.com/andrey-tech/pdepend-summary-formatter-php
Tool to show software code quality metrics, measured by PHP Depend, in console and CI/CD
https://github.com/andrey-tech/pdepend-summary-formatter-php
clean-code console-application cyclomatic-complexity dev halstead-complexity maintainability-index metrics metrics-visualization pdepend php quality
Last synced: 2 months ago
JSON representation
Tool to show software code quality metrics, measured by PHP Depend, in console and CI/CD
- Host: GitHub
- URL: https://github.com/andrey-tech/pdepend-summary-formatter-php
- Owner: andrey-tech
- License: mit
- Created: 2023-10-05T09:37:50.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-09T15:48:39.000Z (4 months ago)
- Last Synced: 2025-03-30T05:31:42.754Z (3 months ago)
- Topics: clean-code, console-application, cyclomatic-complexity, dev, halstead-complexity, maintainability-index, metrics, metrics-visualization, pdepend, php, quality
- Language: PHP
- Homepage: https://github.com/andrey-tech/pdepend-summary-formatter-php
- Size: 200 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pdepend Summary Formatter
[](https://packagist.org/packages/andrey-tech/pdepend-summary-formatter-php)
[](//packagist.org/packages/andrey-tech/pdepend-summary-formatter-php)
[](https://packagist.org/packages/andrey-tech/pdepend-summary-formatter-php)
[](https://packagist.org/packages/andrey-tech/pdepend-summary-formatter-php)
Pdepend Summary Formatter is a tool to show software code quality metrics, measured by
[PHP Depend](https://github.com/pdepend/pdepend) (pdepend),
in console for development and in CI/CD pipeline.
## Table of contents
- [Installation](#installation)
- [Command line options](#command-line-options)
- [Software metrics](#software-metrics)
- [Configuration YAML file](#configuration-yaml-file)
- [Exit codes](#exit-codes)
- [Authors and Maintainers](#authors-and-maintainers)
- [License](#license)
Pdepend Summary Formatter tool requires **PHP >= 7.4**,
latest version of [PHP Depend](https://github.com/pdepend/pdepend)
and [Composer](https://getcomposer.org/).
```shell
composer require --dev pdepend/pdepend:"^2.15"
composer require --dev andrey-tech/pdepend-summary-formatter-php
```
Generate a default config file `pdepend-summary-formatter.yml.dist` in current working directory:
```shell
./vendor/bin/pdepend-summary-formatter --init
```
Then run `PHP Depend` to scan your source PHP-code in directory `src` and generate an XML report in file `summary.xml`:
```shell
./vendor/bin/pdepend --summary-xml=summary.xml --suffix=php src
```
Then run Pdepend Summary Formatter tool to show code quality metrics,
measured by PHP Depend, in console and to write results to specified text file `summary.txt`:
```shell
./vendor/bin/pdepend-summary-formatter summary.xml --output-file=summary.txt
```
```shell
./vendor/bin/pdepend-summary-formatter
```
The Pdepend Summary Formatter tool command line interface also accepts the following optional arguments:
- `--init` — Will generate a default config file `pdepend-summary-formatter.yml.dist` in current working directory.
- `--output-file=` — Write results also to the specified text file.
- `--config-file=` — The filepath to a custom config YAML file.
- `--ignore-red-metrics-on-exit` — Will exit with a zero code, even "red" metrics exist.
- `--ignore-yellow-metrics-on-exit` — Will exit with a zero code, even "yellow" metrics exist.
- `--no-colors` — Disable colors in console.
An example command line of Pdepend Summary Formatter tool and PHP Depend tool:
```shell
./vendor/bin/pdepend --summary-xml=./var/summary.xml --suffix=php src,tests
./vendor/bin/pdepend-summary-formatter ./var/summary.xml --config-file=./pdepend-summary-formatter.yml --output-file=./var/summary.txt
```
An example of output text file `summary.txt`:
```text
FILE: src/AndreyTech/Pdepend/Summary/Formatter/Colorizer.php
+---------------------------+-----+-----+-----+-----+-----+-----+------+-----+------+
| CLASS | wmc | cbo | loc | cis | nom | npm | vars | dit | nocc |
+---------------------------+-----+-----+-----+-----+-----+-----+------+-----+------+
| Colorizer | 15 | 0 | 117 | 4 | 8 | 4 | 3 | 0 | 0 |
+---------------------------+-----+-----+-----+-----+-----+-----+------+-----+------+
+---------------------------+----+-----+------+-------+-------+-----+------+----+-----+------+-----+----+-----+-----+-----+
| METHOD | mi | ccn | ccn2 | crap0 | npath | loc | hb | hd | hv | he | ht | hi | hl | hnd | hnt |
+---------------------------+----+-----+------+-------+-------+-----+------+----+-----+------+-----+----+-----+-----+-----+
| __construct | 81 | 1 | 1 | 2 | 1 | 4 | 0.01 | 4 | 16 | 62 | 3 | 4 | 0.3 | 6 | 6 |
| getFgTagStats | 82 | 1 | 1 | 2 | 1 | 4 | 0.01 | 8 | 12 | 93 | 5 | 1 | 0.1 | 5 | 5 |
| colorizeClassMetric | 79 | 1 | 1 | 2 | 1 | 4 | 0.01 | 5 | 37 | 192 | 11 | 7 | 0.2 | 10 | 11 |
| colorizeMethodMetric | 79 | 1 | 1 | 2 | 1 | 4 | 0.01 | 5 | 37 | 192 | 11 | 7 | 0.2 | 10 | 11 |
| colorize | 57 | 4 | 5 | 30 | 8 | 19 | 0.14 | 27 | 315 | 8517 | 473 | 12 | 0 | 32 | 63 |
| renderTemplate | 59 | 3 | 3 | 12 | 4 | 17 | 0.09 | 14 | 320 | 4379 | 243 | 23 | 0.1 | 25 | 69 |
| updateFgTagStats | 70 | 2 | 2 | 6 | 2 | 8 | 0.05 | 23 | 78 | 1813 | 101 | 3 | 0 | 13 | 21 |
| parseConfig | 73 | 1 | 1 | 2 | 1 | 16 | 0.03 | 7 | 96 | 660 | 37 | 14 | 0.1 | 13 | 26 |
+---------------------------+----+-----+------+-------+-------+-----+------+----+-----+------+-----+----+-----+-----+-----+
+---------------------+--------+--------+--------+--------+-----+-----+-----+-----+-----+------+------+-------+
| PROJECT | min mi | avg mi | max mi | std mi | noc | nom | noi | nof | nop | loc | lloc | ncloc |
+---------------------+--------+--------+--------+--------+-----+-----+-----+-----+-----+------+------+-------+
| 2023-10-04T17:15:14 | 57 | 72 | 82 | 9 | 11 | 74 | 0 | 0 | 2 | 1376 | 501 | 1250 |
+---------------------+--------+--------+--------+--------+-----+-----+-----+-----+-----+------+------+-------+
```
[PHP Depend](https://pdepend.org/) (pdepend) tool can generate a large set of [software metrics](https://pdepend.org/documentation/software-metrics/index.html)
from a given code base. These values can be used to measure the quality of a software project
and they help to identify that parts of an application where a refactoring should be applied.
Pdepend Summary Formatter tool shows only the part of software metrics, measured by PHP Depend,
and shows them in `green`, `yellow` and `red` colors in the console,
according to boundaries for values, defined in configuration YAML file.
This table shows a list of the software metrics by Pdepend Summary Formatter tool
for entire project, classes, traits, methods. The table also shows
the default values for "red" boundaries of software metrics,
based on [PHP Mess Detector](https://phpmd.org/) (PHPMD) tool.
| Metric | Description | Project | Class | Trait | Method |
|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-------|-------|--------|
| avg mi | Average [Maintainability Index](https://learn.microsoft.com/en-us/visualstudio/code-quality/code-metrics-maintainability-index-range-and-meaning?view=vs-2022) | 50 | | | |
| cbo | [Coupling Between Objects](https://phpmd.org/rules/design.html#couplingbetweenobjects) | | 13 | 13 | |
| ccn | [Cyclomatic Complexity Number](https://phpmd.org/rules/codesize.html#cyclomaticcomplexity) | | | | 10 |
| ccn2 | [Extended Cyclomatic Complexity Number](https://stackoverflow.com/questions/27954015/cyclomatic-complexity-and-variants) | | | | 10 |
| cis | [Class Interface Size](https://phpmd.org/rules/codesize.html#excessivepubliccount) | | 45 | 45 | |
| crap0 | [Change Risk Analysis and Predictions Index](https://www.artima.com/weblogs/viewpost.jsp?thread=210575) for 0% coverage | | | | 29 |
| dit | [Depth of Inheritance Tree](https://phpmd.org/rules/design.html#depthofinheritance) | | 6 | | |
| hb | [Halstead Bugs](https://en.wikipedia.org/wiki/Halstead_complexity_measures) | | | | ✓ |
| hd | [Halstead Difficulty](https://en.wikipedia.org/wiki/Halstead_complexity_measures) | | | | ✓ |
| he | [Halstead Effort](https://en.wikipedia.org/wiki/Halstead_complexity_measures) | | | | ✓ |
| hi | [Halstead Intelligence Content](https://en.wikipedia.org/wiki/Halstead_complexity_measures) | | | | ✓ |
| hl | [Halstead Level](https://en.wikipedia.org/wiki/Halstead_complexity_measures) | | | | ✓ |
| hnd | [Halstead Vocabulary](https://en.wikipedia.org/wiki/Halstead_complexity_measures) | | | | ✓ |
| hnt | [Halstead Length](https://en.wikipedia.org/wiki/Halstead_complexity_measures) | | | | ✓ |
| ht | [Halstead Programming Time](https://en.wikipedia.org/wiki/Halstead_complexity_measures) | | | | ✓ |
| hv | [Halstead Volume](https://en.wikipedia.org/wiki/Halstead_complexity_measures) | | | | ✓ |
| lloc | Logical Lines Of Code | ✓ | | | |
| loc | [Lines Of Code](https://phpmd.org/rules/codesize.html#excessivemethodlength) | | 1000 | | 100 |
| max mi | Maximum of [Maintainability Index](https://learn.microsoft.com/en-us/visualstudio/code-quality/code-metrics-maintainability-index-range-and-meaning?view=vs-2022) | 50 | | | |
| mi | [Maintainability Index](https://learn.microsoft.com/en-us/visualstudio/code-quality/code-metrics-maintainability-index-range-and-meaning?view=vs-2022) | | | | 50 |
| min mi | Minimum of [Maintainability Index](https://learn.microsoft.com/en-us/visualstudio/code-quality/code-metrics-maintainability-index-range-and-meaning?view=vs-2022) | 50 | | | |
| nocc | [Number Of Child Classes](https://phpmd.org/rules/design.html#numberofchildren) | | 15 | | |
| ncloc | Non Comment Lines Of Code | ✓ | | | |
| noc | Number Of Classes | ✓ | | | |
| nof | Number Of Functions | ✓ | | | |
| noi | Number Of Interfaces | ✓ | | | |
| nom | [Number Of Methods](https://phpmd.org/rules/codesize.html#toomanymethods) | | 25 | | |
| npm | [Number of Public Methods](https://phpmd.org/rules/codesize.html#toomanypublicmethods) | | 20 | 20 | |
| npath | [NPath Complexity](https://phpmd.org/rules/codesize.html#npathcomplexity) | | | | 200 |
| nop | Number of Packages (namespaces) | ✓ | | | |
| std mi | [Standard deviation](https://en.wikipedia.org/wiki/Standard_deviation) of [Maintainability Index](https://learn.microsoft.com/en-us/visualstudio/code-quality/code-metrics-maintainability-index-range-and-meaning?view=vs-2022) | ✓ | | | |
| vars | [Number of Properties](https://phpmd.org/rules/codesize.html#toomanyfields) | | 15 | 15 | |
| wmc | [Weighted Method Count](https://phpmd.org/rules/codesize.html#excessiveclasscomplexity) | | 50 | 50 | |
Note: ✓ — means there are no defined "red" color boundaries for this metric.
By default Pdepend Summary Formatter tool is looking for following configuration YAML files is current working directory:
- `pdepend-summary-formatter.yml`,
- `pdepend-summary-formatter.yml.dist`.
Configuration YAML file allows to set color boundaries for values of software metrics.
Pdepend Summary Formatter tool currently defines three color boundaries:
| Color | Description |
|----------|-------------|
| `green` | Ok |
| `yellow` | Warning |
| `red` | Error |
A white value means there are no defined color boundaries for this metric.
> You can also add/set custom colors and styles.
> See [How to Color and Style the Console Output](https://symfony.com/doc/current/console/coloring.html) in Symfony console.
Fragment of default configuration file:
```yaml
metrics:
# Metrics of class
class:
# https://learn.microsoft.com/en-us/visualstudio/code-quality/code-metrics-class-coupling?view=vs-2022
# https://phpmd.org/rules/design.html#couplingbetweenobjects
# https://pdepend.org/documentation/software-metrics/coupling-between-objects.html
cbo:
green: [ 0, 13 ],
red+bold: [ 14, null ]
# Metrics of method
method:
# https://learn.microsoft.com/en-us/visualstudio/code-quality/code-metrics-cyclomatic-complexity?view=vs-2022
# https://phpmd.org/rules/codesize.html#cyclomaticcomplexity
ccn:
green: [ 1, 7 ]
yellow+bold: [ 8, 10 ]
red+bold: [ 11, null ]
```
Pdepend Summary Formatter tool currently defines four different exit codes:
| Code | Description |
|------|-----------------------------------------------------------------------------------------------------------------------------------|
| 0 | This exit code indicates that everything worked as expected without "red" or "yellow" metrics. |
| 1 | This exit code indicates that an error/exception occurred which has interrupted tool during execution. |
| 2 | This exit code means that tool has processed the summary file without the occurrence of an error/exception with "red" metrics. |
| 3 | This exit code means that tool has processed the summary file without the occurrence of an error/exception with "yellow" metrics. |
The author and maintainer of Pdepend Summary Formatter tool is [andrey-tech](https://github.com/andrey-tech).
This tool is licensed under the [MIT license](./LICENSE).