@@ -48,7 +48,7 @@ Then run `PHP Depend` to scan your source PHP-code in directory `src` and genera
4848```
4949
5050Then run Pdepend Summary Formatter tool to show code quality metrics,
51- measured by PHP Depend, in console and write results to specified text file ` summary.txt ` :
51+ measured by PHP Depend, in console and to write results to specified text file ` summary.txt ` :
5252
5353``` shell
5454./vendor/bin/pdepend-summary-formatter summary.xml --output-file=summary.txt
@@ -61,7 +61,7 @@ measured by PHP Depend, in console and write results to specified text file `sum
6161./vendor/bin/pdepend-summary-formatter < path to pdepend file summary.xml>
6262```
6363
64- The command line interface also accepts the following optional arguments:
64+ The Pdepend Summary Formatter tool command line interface also accepts the following optional arguments:
6565
6666- ` --init ` - Will generate a default config file ` pdepend-summary-formatter.yml.dist ` in current working directory.
6767- ` --output-file= ` - Write results also to the specified text file.
@@ -108,17 +108,16 @@ FILE: src/AndreyTech/Pdepend/Summary/Formatter/Colorizer.php
108108## Software metrics
109109
110110[ PHP Depend] ( https://pdepend.org/ ) (pdepend) tool can generate a large set of [ software metrics] ( https://pdepend.org/documentation/software-metrics/index.html )
111- from a given code base, these values can be used to measure the quality of a software project
111+ from a given code base. These values can be used to measure the quality of a software project
112112and they help to identify that parts of an application where a refactoring should be applied.
113113
114- Pdepend Summary Formatter tool shows only part of software metrics, measured by PHP Depend,
115- and colors them
116- (<span style =" color : green " >green</span >, <span style =" color : yellow " >yellow</span >, <span style =" color : red " >red</span >)
117- in the console according to boundaries for values, defined in configuration YAML file.
114+ Pdepend Summary Formatter tool shows only the part of software metrics, measured by PHP Depend,
115+ and shows them in ` green ` , ` yellow ` and ` red ` colors in the console,
116+ according to boundaries for values, defined in configuration YAML file.
118117
119- This table give a list of the software metrics, shows by Pdepend Summary Formatter tool
120- for entire project, classes, traits, methods,
121- and default values for < span style = " color : red " >red</ span > boundaries of software metrics,
118+ This table shows a list of the software metrics by Pdepend Summary Formatter tool
119+ for entire project, classes, traits, methods. The table also shows
120+ the default values for " red" boundaries of software metrics,
122121based on [ PHP Mess Detector] ( https://phpmd.org/ ) (PHPMD) tool.
123122
124123| Metric | Description | Project | Class | Trait | Method |
@@ -162,19 +161,19 @@ Note: ✓ - means there are no defined color boundaries for this metric.
162161<a id =" configuration-yaml-file " ></a >
163162## Configuration YAML file
164163
165- By default Pdepend Summary Formatter search following configuration YAML files is current working directory:
164+ By default Pdepend Summary Formatter tool is looking for following configuration YAML files is current working directory:
166165- ` pdepend-summary-formatter.yml ` ,
167166- ` pdepend-summary-formatter.yml.dist ` .
168167
169- Configuration YAML file allow to set color boundaries for values of software metrics.
168+ Configuration YAML file allows to set color boundaries for values of software metrics.
170169
171170Pdepend Summary Formatter tool currently defines three color boundaries:
172171
173- | Color | Description |
174- | ------------------------------------------- | -------------|
175- | < span style = " color : green " >green</ span > | Ok |
176- | < span style = " color : yellow " >yellow</ span > | Warning |
177- | < span style = " color : red " >red</ span > | Error |
172+ | Color | Description |
173+ | ----------| -------------|
174+ | ` green ` | Ok |
175+ | ` yellow ` | Warning |
176+ | ` red ` | Error |
178177
179178A white value means there are no defined color boundaries for this metric.
180179
@@ -211,12 +210,12 @@ Fragment of default configuration file:
211210
212211Pdepend Summary Formatter tool currently defines four different exit codes:
213212
214- | Code | Description |
215- |------|----------------------------------------------------------------------------------------------------------------------------------------- |
216- | 0 | This exit code indicates that everything worked as expected, no "red" or "yellow" metrics exist. |
217- | 1 | This exit code indicates that an exception occurred which has interrupted tool during execution. |
218- | 2 | This exit code means that tool has processed the summary file without the occurrence of an error/exception, but "red" metrics exist . |
219- | 3 | This exit code means that tool has processed the summary file without the occurrence of an error/exception, but "yellow" metrics exist . |
213+ | Code | Description |
214+ |------|-----------------------------------------------------------------------------------------------------------------------------------|
215+ | 0 | This exit code indicates that everything worked as expected without "red" or "yellow" metrics. |
216+ | 1 | This exit code indicates that an error/ exception occurred which has interrupted tool during execution. |
217+ | 2 | This exit code means that tool has processed the summary file without the occurrence of an error/exception with "red" metrics. |
218+ | 3 | This exit code means that tool has processed the summary file without the occurrence of an error/exception with "yellow" metrics. |
220219
221220<a id="authors-and-maintainers"></a>
222221## Authors and Maintainers
0 commit comments