Merge branch 'main' into removeUnusedImports_jdk17StringBlock

Author: nedtwigg

.editorconfig

@@ -25,3 +25,13 @@ indent_style = space
 [*.{yml,yaml}]
 indent_style = space
 indent_size = 2
+
+# Prevent unexpected automatic indentation when crafting test-cases
+[/testlib/src/main/resources/**]
+charset = unset
+end_of_line = unset
+insert_final_newline = unset
+trim_trailing_whitespace = unset
+indent_style = unset
+indent_size = unset
+ij_formatter_enabled = false

CHANGES.md

@@ -12,6 +12,8 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ## [Unreleased]
 ### Added
 * Support configuration of mirrors for P2 repositories in `EquoBasedStepBuilder` ([#1629](https://github.com/diffplug/spotless/issues/1629)).
+* The `style` option in Palantir Java Format ([#1654](https://github.com/diffplug/spotless/pull/1654)).
+* Added formatter for Gherkin feature files ([#1649](https://github.com/diffplug/spotless/issues/1649)).
 ### Changes
 * **POTENTIALLY BREAKING** Converted `googleJavaFormat` to a compile-only dependency and drop support for versions < `1.8`. ([#1630](https://github.com/diffplug/spotless/pull/1630))
 * Bump default `googleJavaFormat` version `1.15.0` -> `1.16.0`. ([#1630](https://github.com/diffplug/spotless/pull/1630))

README.md

@@ -77,6 +77,7 @@ lib('generic.TrimTrailingWhitespaceStep')        +'{{yes}}       | {{yes}}
 lib('antlr4.Antlr4FormatterStep')                +'{{yes}}       | {{yes}}      | {{no}}       | {{no}}  |',
 lib('cpp.ClangFormatStep')                       +'{{yes}}       | {{no}}       | {{no}}       | {{no}}  |',
 extra('cpp.EclipseFormatterStep')                +'{{yes}}       | {{yes}}      | {{yes}}      | {{no}}  |',
+lib('gherkin.GherkinUtilsStep')                  +'{{yes}}       | {{yes}}      | {{no}}       | {{no}}  |',
 extra('groovy.GrEclipseFormatterStep')           +'{{yes}}       | {{yes}}      | {{yes}}      | {{no}}  |',
 lib('java.GoogleJavaFormatStep')                 +'{{yes}}       | {{yes}}      | {{yes}}      | {{no}}  |',
 lib('java.ImportOrderStep')                      +'{{yes}}       | {{yes}}      | {{yes}}      | {{no}}  |',
@@ -125,6 +126,7 @@ lib('yaml.JacksonYamlStep')                      +'{{yes}}       | {{yes}}
 | [`antlr4.Antlr4FormatterStep`](lib/src/main/java/com/diffplug/spotless/antlr4/Antlr4FormatterStep.java) | :+1:       | :+1:      | :white_large_square:       | :white_large_square:  |
 | [`cpp.ClangFormatStep`](lib/src/main/java/com/diffplug/spotless/cpp/ClangFormatStep.java) | :+1:       | :white_large_square:       | :white_large_square:       | :white_large_square:  |
 | [`cpp.EclipseFormatterStep`](lib-extra/src/main/java/com/diffplug/spotless/extra/cpp/EclipseFormatterStep.java) | :+1:       | :+1:      | :+1:      | :white_large_square:  |
+| [`gherkin.GherkinUtilsStep`](lib/src/main/java/com/diffplug/spotless/gherkin/GherkinUtilsStep.java) | :+1:       | :+1:      | :white_large_square:       | :white_large_square:  |
 | [`groovy.GrEclipseFormatterStep`](lib-extra/src/main/java/com/diffplug/spotless/extra/groovy/GrEclipseFormatterStep.java) | :+1:       | :+1:      | :+1:      | :white_large_square:  |
 | [`java.GoogleJavaFormatStep`](lib/src/main/java/com/diffplug/spotless/java/GoogleJavaFormatStep.java) | :+1:       | :+1:      | :+1:      | :white_large_square:  |
 | [`java.ImportOrderStep`](lib/src/main/java/com/diffplug/spotless/java/ImportOrderStep.java) | :+1:       | :+1:      | :+1:      | :white_large_square:  |

SECURITY.md

@@ -0,0 +1 @@
+For security disclosures, please send an email to spotless-security@diffplug.com

lib/build.gradle

@@ -18,7 +18,8 @@ def NEEDS_GLUE = [
 	'scalafmt',
 	'jackson',
 	'gson',
-	'cleanthat'
+	'cleanthat',
+	'gherkin'
 ]
 for (glue in NEEDS_GLUE) {
 	sourceSets.register(glue) {
@@ -71,7 +72,7 @@ dependencies {
 
 	palantirJavaFormatCompileOnly 'com.palantir.javaformat:palantir-java-format:1.1.0' 	// this version needs to stay compilable against Java 8 for CI Job testNpm
 
-	googleJavaFormatCompileOnly 'com.google.googlejavaformat:google-java-format:1.8' // minimum required version due to api changes before then
+	googleJavaFormatCompileOnly 'com.google.googlejavaformat:google-java-format:1.16.0' // minimum required version due to api changes before then
 
 	// used jackson-based formatters
 	jacksonCompileOnly 'com.fasterxml.jackson.core:jackson-databind:2.14.2'
@@ -116,6 +117,9 @@ dependencies {
 	String VER_CLEANTHAT="2.8"
 	cleanthatCompileOnly "io.github.solven-eu.cleanthat:java:$VER_CLEANTHAT"
 	compatCleanthat2Dot1CompileAndTestOnly "io.github.solven-eu.cleanthat:java:$VER_CLEANTHAT"
+
+	gherkinCompileOnly 'io.cucumber:gherkin-utils:8.0.2'
+	gherkinCompileOnly 'org.slf4j:slf4j-api:2.0.0'
 }
 
 // we'll hold the core lib to a high standard

lib/src/gherkin/java/com/diffplug/spotless/glue/gherkin/GherkinUtilsFormatterFunc.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright 2023 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.diffplug.spotless.glue.gherkin;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.diffplug.spotless.FormatterFunc;
+import com.diffplug.spotless.gherkin.GherkinUtilsConfig;
+
+import io.cucumber.gherkin.GherkinParser;
+import io.cucumber.gherkin.utils.pretty.Pretty;
+import io.cucumber.gherkin.utils.pretty.Syntax;
+import io.cucumber.messages.types.Envelope;
+import io.cucumber.messages.types.GherkinDocument;
+import io.cucumber.messages.types.Source;
+import io.cucumber.messages.types.SourceMediaType;
+
+public class GherkinUtilsFormatterFunc implements FormatterFunc {
+	private static final Logger LOGGER = LoggerFactory.getLogger(GherkinUtilsFormatterFunc.class);
+
+	private final GherkinUtilsConfig gherkinSimpleConfig;
+
+	public GherkinUtilsFormatterFunc(GherkinUtilsConfig gherkinSimpleConfig) {
+		this.gherkinSimpleConfig = gherkinSimpleConfig;
+	}
+
+	// Follows https://github.com/cucumber/gherkin-utils/blob/main/java/src/test/java/io/cucumber/gherkin/utils/pretty/PrettyTest.java
+	private GherkinDocument parse(String gherkin) {
+		GherkinParser parser = GherkinParser
+				.builder()
+				.includeSource(false)
+				.build();
+		return parser.parse(Envelope.of(new Source("test.feature", gherkin, SourceMediaType.TEXT_X_CUCUMBER_GHERKIN_PLAIN)))
+				.findFirst()
+				.orElseThrow(() -> new IllegalArgumentException("No envelope"))
+				.getGherkinDocument()
+				.orElseThrow(() -> new IllegalArgumentException("No gherkin document"));
+	}
+
+	@Override
+	public String apply(String inputString) {
+		GherkinDocument gherkinDocument = parse(inputString);
+
+		return Pretty.prettyPrint(gherkinDocument, Syntax.gherkin);
+	}
+}

lib/src/main/java/com/diffplug/spotless/gherkin/GherkinUtilsConfig.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2023 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.diffplug.spotless.gherkin;
+
+import java.io.Serializable;
+
+public class GherkinUtilsConfig implements Serializable {
+	private static final long serialVersionUID = 1L;
+
+	public static int defaultIndentSpaces() {
+		// https://cucumber.io/docs/gherkin/reference/
+		// Recommended indentation is 2 spaces
+		return 2;
+	}
+
+	final int indentSpaces;
+
+	public GherkinUtilsConfig(int indentSpaces) {
+		this.indentSpaces = indentSpaces;
+	}
+
+	public int getIndentSpaces() {
+		return indentSpaces;
+	}
+}

lib/src/main/java/com/diffplug/spotless/gherkin/GherkinUtilsStep.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2021-2023 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.diffplug.spotless.gherkin;
+
+import java.io.IOException;
+import java.io.Serializable;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
+import java.util.Objects;
+
+import com.diffplug.spotless.FormatterFunc;
+import com.diffplug.spotless.FormatterStep;
+import com.diffplug.spotless.JarState;
+import com.diffplug.spotless.Provisioner;
+
+public class GherkinUtilsStep {
+	private static final String MAVEN_COORDINATE = "io.cucumber:gherkin-utils:";
+	private static final String DEFAULT_VERSION = "8.0.2";
+
+	public static String defaultVersion() {
+		return DEFAULT_VERSION;
+	}
+
+	public static FormatterStep create(GherkinUtilsConfig gherkinSimpleConfig,
+			String formatterVersion, Provisioner provisioner) {
+		Objects.requireNonNull(provisioner, "provisioner cannot be null");
+		return FormatterStep.createLazy("gherkin", () -> new GherkinUtilsStep.State(gherkinSimpleConfig, formatterVersion, provisioner), GherkinUtilsStep.State::toFormatter);
+	}
+
+	private static final class State implements Serializable {
+		private static final long serialVersionUID = 1L;
+
+		private final GherkinUtilsConfig gherkinSimpleConfig;
+		private final JarState jarState;
+
+		private State(GherkinUtilsConfig gherkinSimpleConfig, String formatterVersion, Provisioner provisioner) throws IOException {
+			this.gherkinSimpleConfig = gherkinSimpleConfig;
+			this.jarState = JarState.from(MAVEN_COORDINATE + formatterVersion, provisioner);
+		}
+
+		FormatterFunc toFormatter() throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException,
+				InstantiationException, IllegalAccessException {
+			Class<?> formatterFunc = jarState.getClassLoader().loadClass("com.diffplug.spotless.glue.gherkin.GherkinUtilsFormatterFunc");
+			Constructor<?> constructor = formatterFunc.getConstructor(GherkinUtilsConfig.class);
+			return (FormatterFunc) constructor.newInstance(gherkinSimpleConfig);
+		}
+	}
+
+	private GherkinUtilsStep() {
+		// cannot be directly instantiated
+	}
+}

lib/src/main/java/com/diffplug/spotless/java/PalantirJavaFormatStep.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2022 DiffPlug
+ * Copyright 2016-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,6 +27,7 @@ public class PalantirJavaFormatStep {
 	// prevent direct instantiation
 	private PalantirJavaFormatStep() {}
 
+	private static final String DEFAULT_STYLE = "PALANTIR";
 	private static final String NAME = "palantir-java-format";
 	private static final String MAVEN_COORDINATE = "com.palantir.javaformat:palantir-java-format:";
 	private static final Jvm.Support<String> JVM_SUPPORT = Jvm.<String> support(NAME).add(8, "1.1.0").add(11, "2.28.0");
@@ -38,11 +39,17 @@ public static FormatterStep create(Provisioner provisioner) {
 
 	/** Creates a step which formats everything - code, import order, and unused imports. */
 	public static FormatterStep create(String version, Provisioner provisioner) {
+		return create(version, defaultStyle(), provisioner);
+	}
+
+	/** Creates a step which formats everything - code, import order, and unused imports. And with the style input. */
+	public static FormatterStep create(String version, String style, Provisioner provisioner) {
 		Objects.requireNonNull(version, "version");
+		Objects.requireNonNull(style, "style");
 		Objects.requireNonNull(provisioner, "provisioner");
 
 		return FormatterStep.createLazy(NAME,
-				() -> new State(JarState.from(MAVEN_COORDINATE + version, provisioner), version),
+				() -> new State(JarState.from(MAVEN_COORDINATE + version, provisioner), version, style),
 				State::createFormat);
 	}
 
@@ -51,25 +58,36 @@ public static String defaultVersion() {
 		return JVM_SUPPORT.getRecommendedFormatterVersion();
 	}
 
+	/** Get default style */
+	public static String defaultStyle() {
+		return DEFAULT_STYLE;
+	}
+
 	private static final class State implements Serializable {
 		private static final long serialVersionUID = 1L;
 
 		/** The jar that contains the formatter. */
 		private final JarState jarState;
 		/** Version of the formatter jar. */
 		private final String formatterVersion;
+		private final String style;
 
 		State(JarState jarState, String formatterVersion) {
+			this(jarState, formatterVersion, DEFAULT_STYLE);
+		}
+
+		State(JarState jarState, String formatterVersion, String style) {
 			ModuleHelper.doOpenInternalPackagesIfRequired();
 			this.jarState = jarState;
 			this.formatterVersion = formatterVersion;
+			this.style = style;
 		}
 
 		FormatterFunc createFormat() throws Exception {
 			final ClassLoader classLoader = jarState.getClassLoader();
 			final Class<?> formatterFunc = classLoader.loadClass("com.diffplug.spotless.glue.pjf.PalantirJavaFormatFormatterFunc");
-			final Constructor<?> constructor = formatterFunc.getConstructor();
-			return JVM_SUPPORT.suggestLaterVersionOnError(formatterVersion, (FormatterFunc) constructor.newInstance());
+			final Constructor<?> constructor = formatterFunc.getConstructor(String.class); // style
+			return JVM_SUPPORT.suggestLaterVersionOnError(formatterVersion, (FormatterFunc) constructor.newInstance(style));
 		}
 	}
 }

lib/src/palantirJavaFormat/java/com/diffplug/spotless/glue/pjf/PalantirJavaFormatFormatterFunc.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 DiffPlug
+ * Copyright 2022-2023 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,16 +26,19 @@ public class PalantirJavaFormatFormatterFunc implements FormatterFunc {
 
 	private final Formatter formatter;
 
-	public PalantirJavaFormatFormatterFunc() {
+	private final JavaFormatterOptions.Style formatterStyle;
+
+	public PalantirJavaFormatFormatterFunc(String style) {
+		this.formatterStyle = JavaFormatterOptions.Style.valueOf(style);
 		formatter = Formatter.createFormatter(JavaFormatterOptions.builder()
-				.style(JavaFormatterOptions.Style.PALANTIR)
+				.style(formatterStyle)
 				.build());
 	}
 
 	@Override
 	public String apply(String input) throws Exception {
 		String source = input;
-		source = ImportOrderer.reorderImports(source, JavaFormatterOptions.Style.PALANTIR);
+		source = ImportOrderer.reorderImports(source, formatterStyle);
 		source = RemoveUnusedImports.removeUnusedImports(source);
 		return formatter.formatSource(source);
 	}

plugin-gradle/CHANGES.md

@@ -17,9 +17,13 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
   ```
   Mirrors are selected by prefix match, for example `https://download.eclipse.org/eclipse/updates/4.26/` will be redirected to `https://some.internal.mirror/eclipse/eclipse/updates/4.26/`.
   The same configuration exists for `greclipse` and `eclipseCdt`.
+* The `style` option in Palantir Java Format ([#1654](https://github.com/diffplug/spotless/pull/1654)).
+* Added support for Gherkin feature files ([#1649](https://github.com/diffplug/spotless/issues/1649)).
 ### Changes
 * **POTENTIALLY BREAKING** Drop support for `googleJavaFormat` versions < `1.8`. ([#1630](https://github.com/diffplug/spotless/pull/1630))
 * Bump default `googleJavaFormat` version `1.15.0` -> `1.16.0`. ([#1630](https://github.com/diffplug/spotless/pull/1630))
+### Fixed
+* Stop using deprecated conventions when used in Gradle >= `7.1`. ([#1618](https://github.com/diffplug/spotless/pull/1618))
 
 ## [6.17.0] - 2023-03-13
 ### Added