activate unused rewrite checks failOnDryRunResults

Author: Vincent Potucek

CONTRIBUTING.md

@@ -76,18 +76,47 @@ Whenever an acronym is included as part of a field name or parameter name:
 
 #### Code
 
-Code formatting is enforced using the [Spotless](https://github.com/diffplug/spotless)
-Gradle plugin. You can use `gradle spotlessApply` to format new code and add missing
-license headers to source files. Formatter and import order settings for Eclipse are
-available in the repository under
-[junit-eclipse-formatter-settings.xml](gradle/config/eclipse/junit-eclipse-formatter-settings.xml)
-and [junit-eclipse.importorder](gradle/config/eclipse/junit-eclipse.importorder),
-respectively. For IntelliJ IDEA there's a
-[plugin](https://plugins.jetbrains.com/plugin/6546) you can use in conjunction with the
-Eclipse settings.
-
-It is forbidden to use _wildcard imports_ (e.g., `import static org.junit.jupiter.api.Assertions.*;`)
-in Java code.
+Code formatting is automatically enforced using the [Spotless](https://github.com/diffplug/spotless) Gradle plugin during the build process. The build will:
+
+- Automatically format all code
+- Add missing license headers
+- Correct import order
+- Fix other style issues
+
+You can run the plugin goal `gradle spotlessApply` to apply formation.
+Nevertheless, that´s not required, as the build handles everything automatically.
+
+IDE configuration is available for consistency:
+- **Eclipse**: Use our predefined settings:
+  - [Formatter config](gradle/config/eclipse/junit-eclipse-formatter-settings.xml)
+  - [Import order](gradle/config/eclipse/junit-eclipse.importorder)
+- **IntelliJ**: Install the [Eclipse Code Formatter plugin](https://plugins.jetbrains.com/plugin/6546) with our settings
+
+**Important**: Wildcard imports (e.g., `import static org.junit.jupiter.api.Assertions.*;`) remain strictly forbidden.
+
+**Usage requirements:**
+1. Both `CI` and `rewriteRun` environment variables must be set:
+- `CI=false` to enable execution
+- `spotlessApply=true` to auto-apply suggestions
+2. Dry runs execute by default for change preview
+3. Changes are blocked in CI environments (when `CI=true`)
+4. Always review changes before applying
+
+just add this to your shell config:  ~/.zshrc
+export spotlessApply=true
+export rewriteRun=true
+
+#### Rewriting
+
+The build supports automated code refactoring through [Moderne](https://moderne.io/) rewrite rules. These transformations are controlled exclusively through environment variables - there is no local variable configuration option to apply automatic fixes out of the box.
+
+**Usage requirements:**
+1. Both `CI` and `rewriteRun` environment variables must be set:
+  - `CI=false` to enable execution
+  - `rewriteRun=true` to auto-apply suggestions
+2. Dry runs execute by default for change preview
+3. Changes are blocked in CI environments (when `CI=true`)
+4. Always review changes before applying
 
 #### Documentation
 

gradle/plugins/common/src/main/kotlin/junitbuild.java-library-conventions.gradle.kts

@@ -4,6 +4,8 @@ import org.gradle.plugins.ide.eclipse.model.Classpath
 import org.gradle.plugins.ide.eclipse.model.Library
 import org.gradle.plugins.ide.eclipse.model.ProjectDependency
 import org.gradle.plugins.ide.eclipse.model.SourceFolder
+import java.lang.Boolean.valueOf
+import java.lang.System.getenv
 
 plugins {
 	`java-library`
@@ -18,11 +20,15 @@ plugins {
 
 rewrite {
 	activeRecipe("org.openrewrite.java.migrate.UpgradeToJava17")
+	activeRecipe("org.openrewrite.staticanalysis.RemoveUnusedPrivateMethods")
+	activeRecipe("org.openrewrite.staticanalysis.MissingOverrideAnnotation")
+	failOnDryRunResults = true
 }
 
 dependencies {
 	rewrite(platform("org.openrewrite.recipe:rewrite-recipe-bom:latest.release"))
 	rewrite("org.openrewrite.recipe:rewrite-migrate-java")
+	rewrite("org.openrewrite.recipe:rewrite-static-analysis")
 }
 
 val mavenizedProjects: List<Project> by rootProject.extra
@@ -280,6 +286,12 @@ tasks {
 	checkstyleTest {
 		config = resources.text.fromFile(checkstyle.configDirectory.file("checkstyleTest.xml"))
 	}
+	assemble {
+		if (valueOf(getenv("rewriteRun")) && getenv("CI") == null) {
+			dependsOn("rewriteRun")
+		}
+		dependsOn("rewriteDryRun")
+	}
 }
 
 pluginManager.withPlugin("java-test-fixtures") {

gradle/plugins/common/src/main/kotlin/junitbuild.spotless-conventions.gradle.kts

@@ -1,4 +1,6 @@
 import junitbuild.extensions.requiredVersionFromLibs
+import java.lang.Boolean.valueOf
+import java.lang.System.getenv
 
 plugins {
 	id("com.diffplug.spotless")
@@ -86,4 +88,9 @@ tasks {
 	named("spotlessMisc") {
 		outputs.doNotCacheIf("negative avoidance savings") { true }
 	}
+	if (valueOf(getenv("spotlessApply")) && getenv("CI") == null) {
+		assemble {
+			dependsOn("spotlessApply")
+		}
+	}
 }