From 539d024ff3d7fdd3dd016f1e3cc69684cc01ad5d Mon Sep 17 00:00:00 2001 From: Maurin Augagneur Date: Wed, 4 May 2022 09:49:33 +0200 Subject: [PATCH] Replace property 'reporterType' by 'reporter' in README file The name of the property in README.md file was not aligned with the definition of the property in DiktatExtension.kt file --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 21ddec5921..99546bde39 100644 --- a/README.md +++ b/README.md @@ -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" } ``` @@ -250,7 +250,7 @@ Diktat can be run via spotless-maven-plugin since version 2.8.0 ## 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.