Skip to content

Commit 9623c62

Browse files
committed
Reporting: add section about progress reporting
1 parent 609abed commit 9623c62

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

wiki/Reporting.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
## Table of contents
2+
* [Progress reporting](#progress-reporting)
23
* [Printing Full and Summary Reports](#printing-full-and-summary-reports)
34
* Other Report Types
45
* [Checkstyle](#printing-a-checkstyle-report)
@@ -23,6 +24,27 @@
2324

2425
***
2526

27+
## Progress reporting
28+
29+
To see progress reporting while scanning a code base, use the `-p` command line argument.
30+
31+
Legend for the progress indicators:
32+
33+
| When scanning with | Indicator | Means: |
34+
| ------------------ | ------------ | --------------------------------------------------------- |
35+
| `phpcs`/`phpcbf` | `S` | Skipped file |
36+
| `phpcs` | `E` (red) | Non-fixable errors found in the file |
37+
| | `E` (green) | Fixable errors found in the file |
38+
| | `W` (yellow) | Non-fixable warnings found in the file |
39+
| | `W` (green) | Fixable warnings found in the file |
40+
| | `.` | No errors or warnings found in the file |
41+
| `phpcbf` | `F` (green) | Fixed errors or warnings in the file |
42+
| | `E` (red) | Unfixable errors or warnings in the file (fixer conflict) |
43+
| | `.` | No errors or warnings found in the file |
44+
45+
<p align="right"><a href="#table-of-contents">back to top</a></p>
46+
47+
2648
## Printing Full and Summary Reports
2749
When running a scan, by default, the full report is displayed.
2850

0 commit comments

Comments
 (0)