ScalaFmt takes filepath into consideration. (#1854)

nedtwigg · web-flow · commit df26a831ee90 · 2024-05-23T10:07:24.000-07:00
diff --git a/CHANGES.md b/CHANGES.md
@@ -13,6 +13,11 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ### 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))
+### Fixed
+* Ignore system git config when running tests ([#1990](https://github.com/diffplug/spotless/issues/1990))
+* Correctly provide EditorConfig property types for Ktlint ([#2052](https://github.com/diffplug/spotless/issues/2052))
+* Made ShadowCopy (`npmInstallCache`) more robust by re-creating the cache dir if it goes missing ([#1984](https://github.com/diffplug/spotless/issues/1984),[2096](https://github.com/diffplug/spotless/pull/2096))
+* scalafmt.conf fileOverride section now works correctly ([#1854](https://github.com/diffplug/spotless/pull/1854))
 ### Changes
 * Bump default `ktfmt` version to latest `0.46` -> `0.47`. ([#2045](https://github.com/diffplug/spotless/pull/2045))
 * Bump default `sortpom` version to latest `3.2.1` -> `3.4.0`. ([#2049](https://github.com/diffplug/spotless/pull/2049))
@@ -23,10 +28,6 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ### 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))
-### Fixed
-* Ignore system git config when running tests ([#1990](https://github.com/diffplug/spotless/issues/1990))
-* Correctly provide EditorConfig property types for Ktlint ([#2052](https://github.com/diffplug/spotless/issues/2052))
-* Made ShadowCopy (`npmInstallCache`) more robust by re-creating the cache dir if it goes missing ([#1984](https://github.com/diffplug/spotless/issues/1984),[2096](https://github.com/diffplug/spotless/pull/2096))
 
 ## [2.45.0] - 2024-01-23
 ### Added
diff --git a/lib/src/scalafmt/java/com/diffplug/spotless/glue/scalafmt/ScalafmtFormatterFunc.java b/lib/src/scalafmt/java/com/diffplug/spotless/glue/scalafmt/ScalafmtFormatterFunc.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 DiffPlug
+ * Copyright 2022-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,7 +29,7 @@
 
 import scala.collection.immutable.Set$;
 
-public class ScalafmtFormatterFunc implements FormatterFunc {
+public class ScalafmtFormatterFunc implements FormatterFunc.NeedsFile {
 	private final ScalafmtConfig config;
 
 	public ScalafmtFormatterFunc(FileSignature configSignature) throws Exception {
@@ -48,7 +48,7 @@ public ScalafmtFormatterFunc(FileSignature configSignature) throws Exception {
 	}
 
 	@Override
-	public String apply(String input) {
-		return Scalafmt.format(input, config, Set$.MODULE$.empty()).get();
+	public String applyWithFile(String unix, File file) throws Exception {
+		return Scalafmt.format(unix, config, Set$.MODULE$.empty(), file.getAbsolutePath()).get();
 	}
 }
diff --git a/plugin-gradle/CHANGES.md b/plugin-gradle/CHANGES.md
@@ -3,22 +3,23 @@
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `3.27.0`).
 
 ## [Unreleased]
+### Added
+* Respect `.editorconfig` settings for formatting shell via `shfmt` ([#2031](https://github.com/diffplug/spotless/pull/2031))
+* Add support for formatting and sorting Maven POMs ([#2082](https://github.com/diffplug/spotless/issues/2082))
 ### Fixed
 * Full no-asterisk support for configuration cache ([#2088](https://github.com/diffplug/spotless/pull/2088) closes [#1274](https://github.com/diffplug/spotless/issues/1274) and [#987](https://github.com/diffplug/spotless/issues/987)).
 * Ignore system git config when running tests ([#1990](https://github.com/diffplug/spotless/issues/1990))
 * Correctly provide EditorConfig property types for Ktlint ([#2052](https://github.com/diffplug/spotless/issues/2052))
 * Fixed memory leak introduced in 6.21.0 ([#2067](https://github.com/diffplug/spotless/issues/2067))
 * Made ShadowCopy (`npmInstallCache`) more robust by re-creating the cache dir if it goes missing ([#1984](https://github.com/diffplug/spotless/issues/1984),[2096](https://github.com/diffplug/spotless/pull/2096))
+* scalafmt.conf fileOverride section now works correctly ([#1854](https://github.com/diffplug/spotless/pull/1854))
 ### Changes
 * Bump default `ktfmt` version to latest `0.46` -> `0.47`. ([#2045](https://github.com/diffplug/spotless/pull/2045))
 * Bump default `sortpom` version to latest `3.2.1` -> `3.4.0`. ([#2049](https://github.com/diffplug/spotless/pull/2049))
 * Bump default `shfmt` version to latest `3.7.0` -> `3.8.0`. ([#2050](https://github.com/diffplug/spotless/pull/2050))
 * Bump default `ktlint` version to latest `1.1.1` -> `1.2.1`. ([#2057](https://github.com/diffplug/spotless/pull/2057))
 * Bump default `sortpom` version to latest `3.4.0` -> `3.4.1`. ([#2078](https://github.com/diffplug/spotless/pull/2078))
 * Bump default `sortpom` version to latest `3.4.1` -> `4.0.0` and support versions back to `3.2.1`. ([#2115](https://github.com/diffplug/spotless/pull/2115))
-### Added
-* Respect `.editorconfig` settings for formatting shell via `shfmt` ([#2031](https://github.com/diffplug/spotless/pull/2031))
-* Add support for formatting and sorting Maven POMs ([#2082](https://github.com/diffplug/spotless/issues/2082))
 
 ## [6.25.0] - 2024-01-23
 ### Added
diff --git a/plugin-maven/CHANGES.md b/plugin-maven/CHANGES.md
@@ -3,20 +3,21 @@
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`).
 
 ## [Unreleased]
+### Added
+* Respect `.editorconfig` settings for formatting shell via `shfmt` ([#2031](https://github.com/diffplug/spotless/pull/2031))
+* Skip execution in M2E (incremental) builds by default ([#1814](https://github.com/diffplug/spotless/issues/1814), [#2037](https://github.com/diffplug/spotless/issues/2037))
 ### Fixed
 * Ignore system git config when running tests ([#1990](https://github.com/diffplug/spotless/issues/1990))
 * Correctly provide EditorConfig property types for Ktlint ([#2052](https://github.com/diffplug/spotless/issues/2052))
 * Made ShadowCopy (`npmInstallCache`) more robust by re-creating the cache dir if it goes missing ([#1984](https://github.com/diffplug/spotless/issues/1984),[2096](https://github.com/diffplug/spotless/pull/2096))
+* scalafmt.conf fileOverride section now works correctly ([#1854](https://github.com/diffplug/spotless/pull/1854))
 ### Changes
 * Bump default `ktfmt` version to latest `0.46` -> `0.47`. ([#2045](https://github.com/diffplug/spotless/pull/2045))
 * Bump default `sortpom` version to latest `3.2.1` -> `3.4.0`. ([#2049](https://github.com/diffplug/spotless/pull/2049))
 * Bump default `shfmt` version to latest `3.7.0` -> `3.8.0`. ([#2050](https://github.com/diffplug/spotless/pull/2050))
 * Bump default `ktlint` version to latest `1.1.1` -> `1.2.1`. ([#2057](https://github.com/diffplug/spotless/pull/2057))
 * Bump default `sortpom` version to latest `3.4.0` -> `3.4.1`. ([#2078](https://github.com/diffplug/spotless/pull/2078))
 * Bump default `sortpom` version to latest `3.4.1` -> `4.0.0` and support versions back to `3.2.1`. ([#2115](https://github.com/diffplug/spotless/pull/2115))
-### Added
-* Respect `.editorconfig` settings for formatting shell via `shfmt` ([#2031](https://github.com/diffplug/spotless/pull/2031))
-* Skip execution in M2E (incremental) builds by default ([#1814](https://github.com/diffplug/spotless/issues/1814), [#2037](https://github.com/diffplug/spotless/issues/2037)) 
 
 ## [2.43.0] - 2024-01-23
 ### Added
diff --git a/testlib/src/main/java/com/diffplug/spotless/StepHarness.java b/testlib/src/main/java/com/diffplug/spotless/StepHarness.java
@@ -80,7 +80,11 @@ public StepHarness testUnaffected(String idempotentElement) {
 	public StepHarness testResource(String resourceBefore, String resourceAfter) {
 		String before = ResourceHarness.getTestResource(resourceBefore);
 		String after = ResourceHarness.getTestResource(resourceAfter);
-		return test(before, after);
+		String actual = formatter().compute(LineEnding.toUnix(before), new File(resourceBefore));
+		assertEquals(after, actual, "Step application failed");
+		actual = formatter().compute(LineEnding.toUnix(after), new File(resourceAfter));
+		assertEquals(after, actual, "Step is not idempotent");
+		return this;
 	}
 
 	/** Asserts that the given elements in the resources directory are transformed as expected. */
diff --git a/testlib/src/main/resources/scala/scalafmt/basic.dirty b/testlib/src/main/resources/scala/scalafmt/basic.dirty
@@ -1,4 +1,4 @@
-@ foobar("annot", {
+@foobar ("annot", {
   val x = 2
   val y = 2 // y=2
   x + y
diff --git a/testlib/src/main/resources/scala/scalafmt/scalafmt.fileoverride.conf b/testlib/src/main/resources/scala/scalafmt/scalafmt.fileoverride.conf
@@ -0,0 +1,9 @@
+version = 3.7.3
+runner.dialect = scala213
+style = defaultWithAlign # For pretty alignment.
+maxColumn = 200          # For my mega-wide display
+fileOverride {
+  "glob:**/scala/scalafmt/**" {
+    maxColumn = 20           # For my teensy narrow display
+  }
+}
diff --git a/testlib/src/test/java/com/diffplug/spotless/scala/ScalaFmtStepTest.java b/testlib/src/test/java/com/diffplug/spotless/scala/ScalaFmtStepTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2023 DiffPlug
+ * Copyright 2016-2024 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -40,6 +40,13 @@ void behaviorCustomConfig() {
 				.testResource("scala/scalafmt/basic.dirty", "scala/scalafmt/basic.cleanWithCustomConf_3.0.0");
 	}
 
+	@Test
+	void behaviorFileOverride() {
+		FormatterStep step = ScalaFmtStep.create(ScalaFmtStep.DEFAULT_VERSION, TestProvisioner.mavenCentral(), createTestFile("scala/scalafmt/scalafmt.fileoverride.conf"));
+		StepHarness.forStep(step)
+				.testResource("scala/scalafmt/basic.dirty", "scala/scalafmt/basic.cleanWithCustomConf_3.0.0");
+	}
+
 	@Test
 	void behaviorDefaultConfigVersion_3_0_0() {
 		FormatterStep step = ScalaFmtStep.create("3.0.0", TestProvisioner.mavenCentral(), null);

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2022 DiffPlug`
	`2`	`+ * Copyright 2022-2024 DiffPlug`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -29,7 +29,7 @@`
`29`	`29`
`30`	`30`	`import scala.collection.immutable.Set$;`
`31`	`31`
`32`		`-public class ScalafmtFormatterFunc implements FormatterFunc {`
	`32`	`+public class ScalafmtFormatterFunc implements FormatterFunc.NeedsFile {`
`33`	`33`	`private final ScalafmtConfig config;`
`34`	`34`
`35`	`35`	`public ScalafmtFormatterFunc(FileSignature configSignature) throws Exception {`
`@@ -48,7 +48,7 @@ public ScalafmtFormatterFunc(FileSignature configSignature) throws Exception {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`@Override`
`51`		`- public String apply(String input) {`
`52`		`- return Scalafmt.format(input, config, Set$.MODULE$.empty()).get();`
	`51`	`+ public String applyWithFile(String unix, File file) throws Exception {`
	`52`	`+ return Scalafmt.format(unix, config, Set$.MODULE$.empty(), file.getAbsolutePath()).get();`
`53`	`53`	`}`
`54`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-@ foobar("annot", {`
	`1`	`+@foobar ("annot", {`
`2`	`2`	`val x = 2`
`3`	`3`	`val y = 2 // y=2`
`4`	`4`	`x + y`