Skip to content

Commit e826a47

Browse files
documents --format option (#473)
1 parent cbdbce8 commit e826a47

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,12 @@ phparkitect check --ignore-baseline-linenumbers
102102

103103
*Warning*: When ignoring line numbers, phparkitect can no longer discover if a rule is violated additional times in the same file.
104104

105+
## Output format
106+
107+
Output format can be controlled using the parameter `format=[FORMAT]`. There are two available output formats
108+
* `text`: the default one
109+
* `json`: this follows Gitlab's [code quality format](https://docs.gitlab.com/ci/testing/code_quality/#code-quality-report-format). Note that this will suppress any output apart from the violation reporting.
110+
105111
## Configuration
106112

107113
Example of configuration file `phparkitect.php`

0 commit comments

Comments
 (0)