Provide cli information for baseline.xml (#6959)

* Provide cli information * Add create baseline documentation for CLI * Update baseline.md * Update baseline.md * Update baseline.md * Update baseline.md * Update baseline.md * Use h4 for cli correct filename and path to match rest of page * Update website/docs/introduction/baseline.md * Update website/versioned_docs/version-1.23.5/introduction/baseline.md --------- Co-authored-by: Nicola Corti <corti.nico@gmail.com>
detekt · Mar 23, 2024 · 8a3eac5 · 8a3eac5
1 parent beb9e9e
commit 8a3eac5
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/website/docs/introduction/baseline.md b/website/docs/introduction/baseline.md
@@ -29,6 +29,17 @@ the `--report txt:path/to/report` cli flag.
 </SmellBaseline>
 ```
 
+#### CLI
+To generate yourself a `baseline.xml` you need to provide the same config as the the rules you are going to scan your project.
+
+```diff
+java -jar detekt-cli-all.jar \
+  --plugins detekt-formatting.jar \
+  --build-upon-default-config \
+  --config path/to/config/detekt/detekt.yml \
++ --baseline path/to/new/config/detekt/baseline.xml \
++ --create-baseline
+
 #### Gradle
 
 If you are using the gradle-plugin run the `detektBaseline` task to generate yourself a `baseline.xml`.

diff --git a/website/versioned_docs/version-1.23.5/introduction/baseline.md b/website/versioned_docs/version-1.23.5/introduction/baseline.md
@@ -29,6 +29,17 @@ the `--report txt:path/to/report` cli flag.
 </SmellBaseline>
 ```
 
+#### CLI
+To generate yourself a `baseline.xml` you need to provide the same config as the the rules you are going to scan your project.
+
+```diff
+java -jar detekt-cli-all.jar \
+  --plugins detekt-formatting.jar \
+  --build-upon-default-config \
+  --config path/to/config/detekt/detekt.yml \
++ --baseline path/to/new/config/detekt/baseline.xml \
++ --create-baseline
+
 #### Gradle
 
 If you are using the gradle-plugin run the `detektBaseline` task to generate yourself a `baseline.xml`.