From a13a2b814b3361e5515ff959029a2e0f6b653601 Mon Sep 17 00:00:00 2001
From: "Erik C. Thauvin" <erik@thauvin.net>
Date: Sat, 25 Nov 2023 16:26:43 -0800
Subject: [PATCH] Added detekt-main & detekt-test examples

---
 .idea/misc.xml                                |  3 +++
 README.md                                     |  7 +++--
 examples/.idea/misc.xml                       |  4 +++
 examples/README.md                            |  7 +++--
 .../bld/java/com/example/ExampleBuild.java    | 27 ++++++++++++-------
 .../src/main/kotlin/com/example/Example.kt    |  5 ----
 .../bld/extension/DetektOperationBuild.java   | 12 ++++-----
 .../rife/bld/extension/DetektOperation.java   |  9 +++++++
 8 files changed, 49 insertions(+), 25 deletions(-)

diff --git a/.idea/misc.xml b/.idea/misc.xml
index 542659b..03e18e6 100644
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
+  <component name="EntryPointsManager">
+    <pattern value="rife.bld.extension.DetektOperationBuild" method="pmd" />
+  </component>
   <component name="PDMPlugin">
     <option name="skipTestSources" value="false" />
   </component>
diff --git a/README.md b/README.md
index 13388d9..298c2c0 100755
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@ To install, please refer to the [extensions documentation](https://github.com/ri
 To check all Kotlin source code located `src/main/kotlin` and `src/test/kotlin`, add the following to your build file
 
 ```java
-@BuildCommand(summary = "Check source with Detekt")
+@BuildCommand(summary = "Checks source with Detekt")
 public void detekt() throws ExitStatusException, IOException, InterruptedException {
     new DetektOperation()
         .fromProject(this)
@@ -25,10 +25,12 @@ public void detekt() throws ExitStatusException, IOException, InterruptedExcepti
 ./bld compile detekt
 ```
 
+- [View Examples Project](https://github.com/rife2/bld-detekt/tree/main/examples)
+
 To generate a Detekt baseline, add the following to your build file:
 
 ```java
-@BuildCommand(value = "detekt-baseline", summary = "Creates a Detekt baseline")
+@BuildCommand(value = "detekt-baseline", summary = "Creates the Detekt baseline")
 public void detektBaseline() throws ExitStatusException, IOException, InterruptedException {
     new DetektOperation()
         .fromProject(this)
@@ -41,5 +43,6 @@ public void detektBaseline() throws ExitStatusException, IOException, Interrupte
 ```console
 ./bld compile detekt-baseline
 ```
+- [View Examples Project](https://github.com/rife2/bld-detekt/tree/main/examples)
 
 Please check the [DetektOperation documentation](https://rife2.github.io/bld-detekt/rife/bld/extension/DetektOperation.html#method-summary) for all available configuration options.
diff --git a/examples/.idea/misc.xml b/examples/.idea/misc.xml
index eb5c27d..09af397 100644
--- a/examples/.idea/misc.xml
+++ b/examples/.idea/misc.xml
@@ -6,6 +6,10 @@
     <pattern value="com.example.ExampleBuild" method="dokkaHtml" />
     <pattern value="com.example.ExampleBuild" method="dokkaGfm" />
     <pattern value="com.example.ExampleBuild" method="dokkaJekyll" />
+    <pattern value="com.example.ExampleBuild" method="detekt" />
+    <pattern value="com.example.ExampleBuild" method="detektBaseline" />
+    <pattern value="com.example.ExampleBuild" method="detektMain" />
+    <pattern value="com.example.ExampleBuild" method="detektTest" />
   </component>
   <component name="PDMPlugin">
     <option name="customRuleSets">
diff --git a/examples/README.md b/examples/README.md
index b1926d9..8fbcbdd 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -1,4 +1,4 @@
-j## Compile the Kotlin Example
+## Compile the Kotlin Example
 
 ```console
 ./bld compile
@@ -8,6 +8,9 @@ j## Compile the Kotlin Example
 
 ```console
 ./bld detekt
+
+./bld detekt-main
+./bld detekt-test
 ```
 
 ## Generate Detekt baseline
@@ -16,4 +19,4 @@ j## Compile the Kotlin Example
 ./bld detekt-baseline
 ```
 
-The `detekt-baseline.xml` will be created in the project's root directory.
+The `detekt-baseline.xml` file will be created in the project's root directory.
diff --git a/examples/src/bld/java/com/example/ExampleBuild.java b/examples/src/bld/java/com/example/ExampleBuild.java
index 7988e55..514c6a0 100644
--- a/examples/src/bld/java/com/example/ExampleBuild.java
+++ b/examples/src/bld/java/com/example/ExampleBuild.java
@@ -4,14 +4,10 @@ import rife.bld.BuildCommand;
 import rife.bld.Project;
 import rife.bld.extension.CompileKotlinOperation;
 import rife.bld.extension.DetektOperation;
-import rife.bld.extension.dokka.DokkaOperation;
-import rife.bld.extension.dokka.LoggingLevel;
-import rife.bld.extension.dokka.OutputFormat;
 import rife.bld.operations.exceptions.ExitStatusException;
 
 import java.io.File;
 import java.io.IOException;
-import java.nio.file.Path;
 import java.util.List;
 import java.util.logging.ConsoleHandler;
 import java.util.logging.Level;
@@ -49,7 +45,7 @@ public class ExampleBuild extends Project {
         var logger = Logger.getLogger("rife.bld.extension");
         var consoleHandler = new ConsoleHandler();
 
-        // Enable detailed logging for the Kotlin extension
+        // Enable detailed logging
         consoleHandler.setLevel(level);
         logger.addHandler(consoleHandler);
         logger.setLevel(level);
@@ -58,23 +54,22 @@ public class ExampleBuild extends Project {
         new ExampleBuild().start(args);
     }
 
-    @BuildCommand(summary = "Compile the Kotlin project")
+    @BuildCommand(summary = "Compiles the Kotlin project")
     @Override
     public void compile() throws IOException {
-        // The source code located in src/main/kotlin and src/test/kotlin will be compiled
         new CompileKotlinOperation()
                 .fromProject(this)
                 .execute();
     }
 
-    @BuildCommand(summary = "Check source with Detekt")
+    @BuildCommand(summary = "Checks source with Detekt")
     public void detekt() throws ExitStatusException, IOException, InterruptedException {
         new DetektOperation()
                 .fromProject(this)
                 .execute();
     }
 
-    @BuildCommand(value = "detekt-baseline", summary = "Creates a Detekt baseline")
+    @BuildCommand(value = "detekt-baseline", summary = "Creates the Detekt baseline")
     public void detektBaseline() throws ExitStatusException, IOException, InterruptedException {
         new DetektOperation()
                 .fromProject(this)
@@ -82,4 +77,18 @@ public class ExampleBuild extends Project {
                 .createBaseline(true)
                 .execute();
     }
+
+    @BuildCommand(value = "detekt-main", summary = "Checks main source with Detekt")
+    public void detektMain() throws ExitStatusException, IOException, InterruptedException {
+        var op = new DetektOperation().fromProject(this);
+        op.input().clear();
+        op.input("src/main/kotlin").execute();
+    }
+
+    @BuildCommand(value = "detekt-test", summary = "Checks test source with Detekt")
+    public void detektTest() throws ExitStatusException, IOException, InterruptedException {
+        var op = new DetektOperation().fromProject(this);
+        op.input().clear();
+        op.input("src/test/kotlin").execute();
+    }
 }
\ No newline at end of file
diff --git a/examples/src/main/kotlin/com/example/Example.kt b/examples/src/main/kotlin/com/example/Example.kt
index 9af9aa8..34182e6 100644
--- a/examples/src/main/kotlin/com/example/Example.kt
+++ b/examples/src/main/kotlin/com/example/Example.kt
@@ -1,10 +1,5 @@
 package com.example
 
-import java.io.IOException
-
-/**
- * Example class.
- */
 class Example {
     val message: String
         get() = "Hello World!"
diff --git a/src/bld/java/rife/bld/extension/DetektOperationBuild.java b/src/bld/java/rife/bld/extension/DetektOperationBuild.java
index 957b95b..2d1d4b7 100644
--- a/src/bld/java/rife/bld/extension/DetektOperationBuild.java
+++ b/src/bld/java/rife/bld/extension/DetektOperationBuild.java
@@ -41,13 +41,11 @@ public class DetektOperationBuild extends Project {
         autoDownloadPurge = true;
         repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES);
 
+        var detekt =  version(1, 23, 3);
         scope(compile)
                 .include(dependency("com.uwyn.rife2", "bld", version(1, 7, 5)))
-                .include(dependency("io.gitlab.arturbosch.detekt", "detekt-cli", version(1, 23, 3)))
-//                .include(dependency("io.gitlab.arturbosch.detekt", "detekt-core", version(1, 23, 3)))
-//                .include(dependency("io.gitlab.arturbosch.detekt", "detekt-rules", version(1, 23, 3)))
-//                .include(dependency("io.gitlab.arturbosch.detekt", "detekt-utils", version(1, 23, 3)))
-                .include(dependency("io.gitlab.arturbosch.detekt", "detekt-tooling", version(1, 23, 3)))
+                .include(dependency("io.gitlab.arturbosch.detekt", "detekt-cli", detekt))
+                .include(dependency("io.gitlab.arturbosch.detekt", "detekt-tooling", detekt))
                 .include(dependency("com.beust", "jcommander", "1.82"))
                 .include(dependency("com.fasterxml:aalto-xml:1.3.2"));
         scope(test)
@@ -96,10 +94,10 @@ public class DetektOperationBuild extends Project {
     }
 
     @BuildCommand(summary = "Check source code with PMD")
-    public void pmd() throws Exception {
+    public void pmd() {
         new PmdOperation()
                 .fromProject(this)
-                .addRuleSet("config/pmd.xml")
+                .ruleSets("config/pmd.xml")
                 .execute();
     }
 
diff --git a/src/main/java/rife/bld/extension/DetektOperation.java b/src/main/java/rife/bld/extension/DetektOperation.java
index 41630f9..3bdc877 100644
--- a/src/main/java/rife/bld/extension/DetektOperation.java
+++ b/src/main/java/rife/bld/extension/DetektOperation.java
@@ -448,6 +448,15 @@ public class DetektOperation extends AbstractProcessOperation<DetektOperation> {
         return this;
     }
 
+    /**
+     * Returns the input paths to analyze.
+     *
+     * @return the input paths
+     */
+    public Collection<String> input() {
+        return input_;
+    }
+
     /**
      * EXPERIMENTAL: Use a custom JDK home directory to include into the
      * classpath.