Skip to content

Commit

Permalink
Replace property 'reporterType' by 'reporter' in README file (#1289)
Browse files Browse the repository at this point in the history
The name of the property in README.md file was not aligned with the definition of the property in DiktatExtension.kt file
  • Loading branch information
maugagneur authored May 4, 2022
1 parent 5120633 commit ca8cd62
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,14 +166,14 @@ diktat {
Also `diktat` extension has different reporters. You can specify `json`, `html`, `sarif`, `plain` (default) or your own custom reporter (it should be added as a dependency into `diktat` configuration):
```kotlin
diktat {
reporterType = "json" // "html", "json", "plain" (default), "sarif"
reporter = "json" // "html", "json", "plain" (default), "sarif"
}
```

You can also specify an output.
```kotlin
diktat {
reporterType = "json"
reporter = "json"
output = "someFile.json"
}
```
Expand Down Expand Up @@ -250,7 +250,7 @@ Diktat can be run via spotless-maven-plugin since version 2.8.0
</details>

## GitHub Native Integration
We suggest everyone to use common ["sarif"](https://docs.oasis-open.org/sarif/sarif/v2.0/sarif-v2.0.html) format as a `reporterType` in CI/CD.
We suggest everyone to use common ["sarif"](https://docs.oasis-open.org/sarif/sarif/v2.0/sarif-v2.0.html) format as a `reporter` in CI/CD.
GitHub has an [integration](https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning)
with SARIF format and provides you a native reporting of diktat issues in Pull Requests.

Expand Down

0 comments on commit ca8cd62

Please sign in to comment.