Merge remote-tracking branch 'origin/upstream'

# Conflicts:
#	testlib/src/main/java/com/diffplug/spotless/StepHarnessBase.java

Author: Goooler

.github/workflows/ci.yml

@@ -57,6 +57,10 @@ jobs:
           - kind: npm
             jre: 11
             os: ubuntu-latest
+          - kind: shfmt
+            jre: 11
+            os: ubuntu-latest
+            shfmt-version: 3.7.0
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
@@ -79,6 +83,14 @@ jobs:
       - name: test npm
         if: matrix.kind == 'npm'
         run: ./gradlew testNpm
+      - name: Install shfmt
+        if: matrix.kind == 'shfmt'
+        run: |
+          curl -sSfL "https://github.com/mvdan/sh/releases/download/v${{ matrix.shfmt-version }}/shfmt_v${{ matrix.shfmt-version }}_linux_amd64" -o /usr/local/bin/shfmt
+          chmod +x /usr/local/bin/shfmt
+      - name: Test shfmt
+        if: matrix.kind == 'shfmt'
+        run: ./gradlew testShfmt
       - name: junit result
         uses: mikepenz/action-junit-report@v4
         if: always() # always run even if the previous step fails

CHANGES.md

@@ -12,6 +12,8 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ## [Unreleased]
 ### Added
 * `FileSignature.Promised` and `JarState.Promised` to facilitate round-trip serialization for the Gradle configuration cache. ([#1945](https://github.com/diffplug/spotless/pull/1945)) 
+* Respect `.editorconfig` settings for formatting shell via `shfmt` ([#2031](https://github.com/diffplug/spotless/pull/2031))
+
 ### Removed
 * **BREAKING** Remove `JarState.getMavenCoordinate(String prefix)`. ([#1945](https://github.com/diffplug/spotless/pull/1945))
 * **BREAKING** Replace `PipeStepPair` with `FenceStep`. ([#1954](https://github.com/diffplug/spotless/pull/1954))

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 DiffPlug
+ * Copyright 2020-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@
 package com.diffplug.spotless;
 
 import java.io.IOException;
+import java.io.Serializable;
 import java.nio.charset.Charset;
 import java.util.Objects;
 import java.util.regex.Matcher;
@@ -31,7 +32,8 @@
  * Usage: {@code ForeignExe.nameAndVersion("grep", "2.5.7").confirmVersionAndGetAbsolutePath()}
  * will find grep, confirm that it is version 2.5.7, and then return.
  */
-public class ForeignExe {
+public class ForeignExe implements Serializable {
+	private static final long serialVersionUID = 1L;
 	private @Nullable String pathToExe;
 	private String versionFlag = "--version";
 	private Pattern versionRegex = Pattern.compile("version (\\S*)");

lib/src/main/java/com/diffplug/spotless/cpp/ClangFormatStep.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2022 DiffPlug
+ * Copyright 2020-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -64,10 +64,10 @@ public ClangFormatStep withPathToExe(String pathToExe) {
 	}
 
 	public FormatterStep create() {
-		return FormatterStep.createLazy(name(), this::createState, State::toFunc);
+		return FormatterStep.createLazy(name(), this::createState, RoundtripState::state, State::toFunc);
 	}
 
-	private State createState() throws IOException, InterruptedException {
+	private RoundtripState createState() throws IOException, InterruptedException {
 		String howToInstall = "" +
 				"You can download clang-format from https://releases.llvm.org and " +
 				"then point Spotless to it with {@code pathToExe('/path/to/clang-format')} " +
@@ -82,7 +82,25 @@ private State createState() throws IOException, InterruptedException {
 				.fixWrongVersion(
 						"You can tell Spotless to use the version you already have with {@code clangFormat('{versionFound}')}" +
 								"or you can download the currently specified version, {version}.\n" + howToInstall);
-		return new State(this, exe);
+		return new RoundtripState(this, exe);
+	}
+
+	static class RoundtripState implements Serializable {
+		private static final long serialVersionUID = 1L;
+
+		final String version;
+		final @Nullable String style;
+		final ForeignExe exe;
+
+		RoundtripState(ClangFormatStep step, ForeignExe exe) {
+			this.version = step.version;
+			this.style = step.style;
+			this.exe = exe;
+		}
+
+		private State state() {
+			return new State(version, style, exe);
+		}
 	}
 
 	@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
@@ -95,9 +113,9 @@ static class State implements Serializable {
 		// used for executing
 		private transient @Nullable List<String> args;
 
-		State(ClangFormatStep step, ForeignExe pathToExe) {
-			this.version = step.version;
-			this.style = step.style;
+		State(String version, @Nullable String style, ForeignExe pathToExe) {
+			this.version = version;
+			this.style = style;
 			this.exe = Objects.requireNonNull(pathToExe);
 		}
 

lib/src/main/java/com/diffplug/spotless/protobuf/BufStep.java

@@ -58,16 +58,32 @@ public BufStep withPathToExe(String pathToExe) {
 	}
 
 	public FormatterStep create() {
-		return FormatterStep.createLazy(name(), this::createState, State::toFunc);
+		return FormatterStep.createLazy(name(), this::createRoundtrip, RoundtripState::state, State::toFunc);
 	}
 
-	private State createState() {
+	private RoundtripState createRoundtrip() {
 		String instructions = "https://docs.buf.build/installation";
 		ForeignExe exe = ForeignExe.nameAndVersion("buf", version)
 				.pathToExe(pathToExe)
 				.versionRegex(Pattern.compile("(\\S*)"))
 				.fixCantFind("Try following the instructions at " + instructions + ", or else tell Spotless where it is with {@code buf().pathToExe('path/to/executable')}");
-		return new State(this, exe);
+		return new RoundtripState(version, exe);
+	}
+
+	private static class RoundtripState implements Serializable {
+		private static final long serialVersionUID = 1L;
+
+		final String version;
+		final ForeignExe exe;
+
+		RoundtripState(String version, ForeignExe exe) {
+			this.version = version;
+			this.exe = exe;
+		}
+
+		private State state() {
+			return new State(version, exe);
+		}
 	}
 
 	@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
@@ -80,9 +96,9 @@ static class State implements Serializable {
 		private final transient ForeignExe exe;
 		private transient String exeAbsPath;
 
-		State(BufStep step, ForeignExe exe) {
-			this.version = step.version;
-			this.exe = Objects.requireNonNull(exe);
+		State(String version, ForeignExe exeAbsPath) {
+			this.version = version;
+			this.exe = Objects.requireNonNull(exeAbsPath);
 		}
 
 		String format(ProcessRunner runner, String input, File file) throws IOException, InterruptedException {

lib/src/main/java/com/diffplug/spotless/python/BlackStep.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2022 DiffPlug
+ * Copyright 2020-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -56,17 +56,33 @@ public BlackStep withPathToExe(String pathToExe) {
 	}
 
 	public FormatterStep create() {
-		return FormatterStep.createLazy(name(), this::createState, State::toFunc);
+		return FormatterStep.createLazy(name(), this::createState, RoundtripState::state, State::toFunc);
 	}
 
-	private State createState() throws IOException, InterruptedException {
+	private RoundtripState createState() {
 		String trackingIssue = "\n  github issue to handle this better: https://github.com/diffplug/spotless/issues/674";
 		ForeignExe exeAbsPath = ForeignExe.nameAndVersion("black", version)
 				.pathToExe(pathToExe)
 				.versionRegex(Pattern.compile("(?:black, version|black,|version) (\\S*)"))
 				.fixCantFind("Try running {@code pip install black=={version}}, or else tell Spotless where it is with {@code black().pathToExe('path/to/executable')}" + trackingIssue)
 				.fixWrongVersion("Try running {@code pip install --force-reinstall black=={version}}, or else specify {@code black('{versionFound}')} to Spotless" + trackingIssue);
-		return new State(this, exeAbsPath);
+		return new RoundtripState(version, exeAbsPath);
+	}
+
+	static class RoundtripState implements Serializable {
+		private static final long serialVersionUID = 1L;
+
+		final String version;
+		final ForeignExe exe;
+
+		RoundtripState(String version, ForeignExe exe) {
+			this.version = version;
+			this.exe = exe;
+		}
+
+		private State state() {
+			return new State(version, exe);
+		}
 	}
 
 	@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
@@ -78,8 +94,8 @@ static class State implements Serializable {
 		// used for executing
 		private transient @Nullable String[] args;
 
-		State(BlackStep step, ForeignExe exeAbsPath) {
-			this.version = step.version;
+		State(String version, ForeignExe exeAbsPath) {
+			this.version = version;
 			this.exe = Objects.requireNonNull(exeAbsPath);
 		}
 

lib/src/main/java/com/diffplug/spotless/shell/ShfmtStep.java

@@ -22,6 +22,8 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 import javax.annotation.Nullable;
 
@@ -72,7 +74,7 @@ private State createState() throws IOException, InterruptedException {
 				"\n    github issue to handle this better: https://github.com/diffplug/spotless/issues/673";
 		final ForeignExe exe = ForeignExe.nameAndVersion("shfmt", version)
 				.pathToExe(pathToExe)
-				.versionRegex(Pattern.compile("(\\S*)"))
+				.versionRegex(Pattern.compile("([\\d.]+)"))
 				.fixCantFind(howToInstall)
 				.fixWrongVersion(
 						"You can tell Spotless to use the version you already have with {@code shfmt('{versionFound}')}" +
@@ -83,9 +85,11 @@ private State createState() throws IOException, InterruptedException {
 	@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
 	static class State implements Serializable {
 		private static final long serialVersionUID = -1825662356883926318L;
+
 		// used for up-to-date checks and caching
 		final String version;
 		final transient ForeignExe exe;
+
 		// used for executing
 		private transient @Nullable List<String> args;
 
@@ -96,10 +100,16 @@ static class State implements Serializable {
 
 		String format(ProcessRunner runner, String input, File file) throws IOException, InterruptedException {
 			if (args == null) {
-				args = List.of(exe.confirmVersionAndGetAbsolutePath(), "-i", "2", "-ci");
+				// args will be reused during a single Spotless task execution,
+				// so this "prefix" is being "cached" for each Spotless format with shfmt.
+				args = List.of(exe.confirmVersionAndGetAbsolutePath(), "--filename");
 			}
 
-			return runner.exec(input.getBytes(StandardCharsets.UTF_8), args).assertExitZero(StandardCharsets.UTF_8);
+			// This will ensure that the next file name is retrieved on every format
+			final List<String> finalArgs = Stream.concat(args.stream(), Stream.of(file.getAbsolutePath()))
+					.collect(Collectors.toList());
+
+			return runner.exec(input.getBytes(StandardCharsets.UTF_8), finalArgs).assertExitZero(StandardCharsets.UTF_8);
 		}
 
 		FormatterFunc.Closeable toFunc() {

plugin-gradle/CHANGES.md

@@ -6,6 +6,9 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ### Fixed
 * Ignore system git config when running tests ([#1990](https://github.com/diffplug/spotless/issues/1990))
 
+### Added
+* Respect `.editorconfig` settings for formatting shell via `shfmt` ([#2031](https://github.com/diffplug/spotless/pull/2031))
+
 ## [6.25.0] - 2024-01-23
 ### Added
 * Maven / Gradle - Support for formatting Java Docs for the Palantir formatter ([#2009](https://github.com/diffplug/spotless/pull/2009))

plugin-gradle/README.md

@@ -992,7 +992,7 @@ spotless {
 ```gradle
 spotless {
   shell {
-    target 'scripts/**/*.sh' // default: '*.sh'
+    target 'scripts/**/*.sh' // default: '**/*.sh'
 
     shfmt()  // has its own section below
   }
@@ -1003,11 +1003,15 @@ spotless {
 
 [homepage](https://github.com/mvdan/sh). [changelog](https://github.com/mvdan/sh/blob/master/CHANGELOG.md).
 
+When formatting shell scripts via `shfmt`, configure `shfmt` settings via `.editorconfig`. 
+Refer to the `shfmt` [man page](https://github.com/mvdan/sh/blob/master/cmd/shfmt/shfmt.1.scd) for `.editorconfig` settings. 
+
 ```gradle
 shfmt('3.7.0') // version is optional
 
 // if shfmt is not on your path, you must specify its location manually
 shfmt().pathToExe('/opt/homebrew/bin/shfmt')
+
 // Spotless always checks the version of the shfmt it is using
 // and will fail with an error if it does not match the expected version
 // (whether manually specified or default). If there is a problem, Spotless

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/ShellExtension.java

@@ -23,7 +23,7 @@
 import com.diffplug.spotless.shell.ShfmtStep;
 
 public class ShellExtension extends FormatExtension {
-	private static final String SHELL_FILE_EXTENSION = "*.sh";
+	private static final String SHELL_FILE_EXTENSION = "**/*.sh";
 
 	static final String NAME = "shell";