Merge ../spotless into type-annotation-on-class-test

Author: mernst

build.gradle

@@ -1,13 +1,13 @@
+repositories {
+	mavenCentral()
+}
 apply from: rootProject.file('gradle/java-publish.gradle')
 apply from: rootProject.file('gradle/changelog.gradle')
 allprojects {
 	apply from: rootProject.file('gradle/spotless.gradle')
 }
 apply from: rootProject.file('gradle/spotless-freshmark.gradle')
 
-repositories {
-	mavenCentral()
-}
 spotless {
 	groovyGradle {
 		target '*.gradle', 'gradle/*.gradle'

gradle.properties

@@ -17,7 +17,7 @@ artifactIdGradle=spotless-plugin-gradle
 
 # Build requirements
 VER_JAVA=1.8
-VER_SPOTBUGS=4.5.0
+VER_SPOTBUGS=4.7.2
 VER_JSR_305=3.0.2
 
 # Dependencies provided by Spotless plugin
@@ -26,12 +26,12 @@ VER_SLF4J=[1.6,2.0[
 # Used in multiple places
 VER_DURIAN=1.2.0
 VER_JGIT=5.13.1.202206130422-r
-VER_JUNIT=5.9.0
+VER_JUNIT=5.9.1
 VER_ASSERTJ=3.23.1
-VER_MOCKITO=3.12.4
+VER_MOCKITO=4.8.0
 
 # Used for Maven Plugin
 VER_MAVEN_API=3.0
-VER_ECLIPSE_AETHER=0.9.1.v20140329
+VER_ECLIPSE_AETHER=1.1.0
 VER_MUSTACHE=0.9.10
 VER_PLEXUS_RESOURCES=1.2.0

plugin-gradle/build.gradle

@@ -1,10 +1,10 @@
 apply from: rootProject.file('gradle/changelog.gradle')
 ext.artifactId = project.artifactIdGradle
 version = spotlessChangelog.versionNext
+apply plugin: 'java-library'
 apply from: rootProject.file('gradle/java-setup.gradle')
 apply from: rootProject.file('gradle/spotless-freshmark.gradle')
 
-apply plugin: 'java-library'
 apply plugin: 'com.gradle.plugin-publish'
 apply plugin: 'java-gradle-plugin'
 

plugin-maven/CHANGES.md

@@ -4,6 +4,18 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 
 ## [Unreleased]
 
+## [2.27.2] - 2022-10-10
+### Fixed
+* `replace` and `replaceRegex` steps now allow you to replace something with an empty string, previously this would generate a null pointer exception. (fixes [#1359](https://github.com/diffplug/spotless/issues/1359))
+
+## [2.27.1] - 2022-09-28
+### Fixed
+* `skip` config key should work again now. ([#1353](https://github.com/diffplug/spotless/pull/1353) fixes [#1227](https://github.com/diffplug/spotless/issues/1227) and [#491](https://github.com/diffplug/spotless/issues/491))
+
+## [2.27.0] - 2022-09-19
+### Added
+* Support for `editorConfigOverride` in `ktlint`, `plugin-maven`. ([#1335](https://github.com/diffplug/spotless/pull/1335) fixes [#1334](https://github.com/diffplug/spotless/issues/1334))
+
 ## [2.26.0] - 2022-09-14
 ### Added
 * `formatAnnotations` step to correct formatting of Java type annotations.  It puts type annotations on the same line as the type that they qualify.  Run it after a Java formatting step, such as `googleJavaFormat`. ([#1275](https://github.com/diffplug/spotless/pull/1275))

plugin-maven/README.md

@@ -12,8 +12,8 @@ output = [
   ].join('\n');
 -->
 [![Maven central](https://img.shields.io/badge/mavencentral-com.diffplug.spotless%3Aspotless--maven--plugin-blue.svg)](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.diffplug.spotless%22%20AND%20a%3A%22spotless-maven-plugin%22)
-[![Javadoc](https://img.shields.io/badge/javadoc-yes-blue.svg)](https://javadoc.io/doc/com.diffplug.spotless/spotless-maven-plugin/2.26.0/index.html)
-[![Changelog](https://img.shields.io/badge/changelog-2.26.0-brightgreen.svg)](CHANGES.md)
+[![Javadoc](https://img.shields.io/badge/javadoc-yes-blue.svg)](https://javadoc.io/doc/com.diffplug.spotless/spotless-maven-plugin/2.27.2/index.html)
+[![Changelog](https://img.shields.io/badge/changelog-2.27.2-brightgreen.svg)](CHANGES.md)
 
 [![Circle CI](https://circleci.com/gh/diffplug/spotless/tree/main.svg?style=shield)](https://circleci.com/gh/diffplug/spotless/tree/main)
 [![Live chat](https://img.shields.io/badge/gitter-chat-brightgreen.svg)](https://gitter.im/diffplug/spotless)
@@ -359,6 +359,10 @@ Groovy-Eclipse formatting errors/warnings lead per default to a build failure. T
 ```xml
 <ktlint>
   <version>0.43.2</version> <!-- optional -->
+  <editorConfigOverride> <!-- optional -->
+    <ij_kotlin_allow_trailing_comma>true</ij_kotlin_allow_trailing_comma>
+    <ij_kotlin_allow_trailing_comma_on_call_site>true</ij_kotlin_allow_trailing_comma_on_call_site>
+  </editorConfigOverride>
 </ktlint>
 ```
 

plugin-maven/build.gradle

@@ -5,6 +5,7 @@ buildscript {
 plugins {
 	id 'cz.malohlava.visteg' version '1.0.5' // https://github.com/mmalohlava/gradle-visteg
 }
+repositories { mavenCentral() }
 apply from: rootProject.file('gradle/changelog.gradle')
 apply from: rootProject.file('gradle/spotless-freshmark.gradle')
 

plugin-maven/src/main/java/com/diffplug/spotless/maven/AbstractSpotlessMojo.java

@@ -91,6 +91,9 @@ public abstract class AbstractSpotlessMojo extends AbstractMojo {
 	@Parameter(defaultValue = "${mojoExecution.goal}", required = true, readonly = true)
 	private String goal;
 
+	@Parameter(defaultValue = "false")
+	private boolean skip;
+
 	@Parameter(property = "spotless.apply.skip", defaultValue = "false")
 	private boolean applySkip;
 
@@ -200,6 +203,10 @@ public final void execute() throws MojoExecutionException {
 	}
 
 	private boolean shouldSkip() {
+		if (skip) {
+			return true;
+		}
+
 		switch (goal) {
 		case GOAL_CHECK:
 			return checkSkip;
@@ -208,6 +215,7 @@ private boolean shouldSkip() {
 		default:
 			break;
 		}
+
 		return false;
 	}
 

plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/Replace.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 DiffPlug
+ * Copyright 2016-2022 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,10 +35,12 @@ public class Replace implements FormatterStepFactory {
 
 	@Override
 	public FormatterStep newFormatterStep(FormatterStepConfig config) {
-		if (name == null || search == null || replacement == null) {
-			throw new IllegalArgumentException("Must specify 'name', 'search' and 'replacement'.");
+		if (name == null || search == null) {
+			throw new IllegalArgumentException("Must specify 'name' and 'search'.");
 		}
-
-		return ReplaceStep.create(name, search, replacement);
+		// Use empty string if replacement is not provided. In pom.xml there is no way to specify
+		// an empty string as a property value as maven will always trim the value and if it is
+		// empty, maven will consider the property as not provided.
+		return ReplaceStep.create(name, search, replacement != null ? replacement : "");
 	}
 }

plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/ReplaceRegex.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 DiffPlug
+ * Copyright 2016-2022 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,10 +35,12 @@ public class ReplaceRegex implements FormatterStepFactory {
 
 	@Override
 	public FormatterStep newFormatterStep(FormatterStepConfig config) {
-		if (name == null || searchRegex == null || replacement == null) {
-			throw new IllegalArgumentException("Must specify 'name', 'searchRegex' and 'replacement'.");
+		if (name == null || searchRegex == null) {
+			throw new IllegalArgumentException("Must specify 'name' and 'searchRegex'.");
 		}
-
-		return ReplaceRegexStep.create(name, searchRegex, replacement);
+		// Use empty string if replacement is not provided. In pom.xml there is no way to specify
+		// an empty string as a property value as maven will always trim the value and if it is
+		// empty, maven will consider the property as not provided.
+		return ReplaceRegexStep.create(name, searchRegex, replacement != null ? replacement : "");
 	}
 }

plugin-maven/src/main/java/com/diffplug/spotless/maven/kotlin/Ktlint.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 DiffPlug
+ * Copyright 2016-2022 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,6 +15,10 @@
  */
 package com.diffplug.spotless.maven.kotlin;
 
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
 import org.apache.maven.plugins.annotations.Parameter;
 
 import com.diffplug.spotless.FormatterStep;
@@ -27,9 +31,17 @@ public class Ktlint implements FormatterStepFactory {
 	@Parameter
 	private String version;
 
+	@Parameter
+	private Map<String, Object> editorConfigOverride;
+
 	@Override
 	public FormatterStep newFormatterStep(FormatterStepConfig config) {
 		String ktlintVersion = version != null ? version : KtLintStep.defaultVersion();
-		return KtLintStep.create(ktlintVersion, config.getProvisioner());
+
+		if (editorConfigOverride == null) {
+			editorConfigOverride = new HashMap<>();
+		}
+
+		return KtLintStep.create(ktlintVersion, config.getProvisioner(), false, Collections.emptyMap(), editorConfigOverride);
 	}
 }

plugin-maven/src/test/java/com/diffplug/spotless/maven/kotlin/KtlintTest.java

@@ -29,4 +29,14 @@ void testKtlint() throws Exception {
 		mavenRunner().withArguments("spotless:apply").runNoError();
 		assertFile(path).sameAsResource("kotlin/ktlint/basic.clean");
 	}
+
+	@Test
+	void testKtlintEditorConfigOverride() throws Exception {
+		writePomWithKotlinSteps("<ktlint><editorConfigOverride><ij_kotlin_allow_trailing_comma>true</ij_kotlin_allow_trailing_comma><ij_kotlin_allow_trailing_comma_on_call_site>true</ij_kotlin_allow_trailing_comma_on_call_site></editorConfigOverride></ktlint>");
+
+		String path = "src/main/kotlin/Main.kt";
+		setFile(path).toResource("kotlin/ktlint/experimentalEditorConfigOverride.dirty");
+		mavenRunner().withArguments("spotless:apply").runNoError();
+		assertFile(path).sameAsResource("kotlin/ktlint/experimentalEditorConfigOverride.clean");
+	}
 }

settings.gradle

@@ -1,14 +1,14 @@
 pluginManagement {
 	plugins {
-		id 'com.diffplug.spotless'                 version '6.5.0'
+		id 'com.diffplug.spotless'                 version '6.11.0'
 		// https://plugins.gradle.org/plugin/com.gradle.plugin-publish
 		id 'com.gradle.plugin-publish'             version '1.0.0'
 		// https://github.com/gradle-nexus/publish-plugin/releases
 		id 'io.github.gradle-nexus.publish-plugin' version '1.1.0'
 		// https://github.com/spotbugs/spotbugs-gradle-plugin/releases
 		id 'com.github.spotbugs'                   version '5.0.12'
 		// https://github.com/diffplug/spotless-changelog
-		id 'com.diffplug.spotless-changelog'       version '2.3.2'
+		id 'com.diffplug.spotless-changelog'       version '2.4.0'
 		// https://github.com/diffplug/goomph/blob/main/CHANGES.md
 		id 'com.diffplug.p2.asmaven'               version '3.27.0' // DO NOT UPDATE, see https://github.com/diffplug/spotless/pull/874
 		// https://github.com/gradle/test-retry-gradle-plugin/releases