feat: Introduce "spotlessIdeHook" argument for maven plugin

Author: Dimitrii Lipiridi

plugin-maven/CHANGES.md

@@ -6,6 +6,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
 ### Added
 * Add a `jsonPatch` step to `json` formatter configurations. This allows patching of JSON documents using [JSON Patches](https://jsonpatch.com). ([#1753](https://github.com/diffplug/spotless/pull/1753))
 * Support GJF own import order. ([#1780](https://github.com/diffplug/spotless/pull/1780))
+* `-DspotlessIdeHook` provides the ability to apply Spotless exclusively to a specified file. It accepts the absolute path of the file.
 ### Fixed
 * Add support for `prettier` version `3.0.0` and newer. ([#1760]https://github.com/diffplug/spotless/pull/1760), [#1751](https://github.com/diffplug/spotless/issues/1751))
 * Fix npm install calls when npm cache is not up-to-date. ([#1760]https://github.com/diffplug/spotless/pull/1760), [#1750](https://github.com/diffplug/spotless/issues/1750))

plugin-maven/README.md

@@ -1601,14 +1601,23 @@ By default, `spotless:check` is bound to the `verify` phase.  You might want to
 
 ## Can I apply Spotless to specific files?
 
-You can target specific files by setting the `spotlessFiles` project property to a comma-separated list of file patterns:
+There are two options:
 
+### Pattern
+You can target specific files by setting the `spotlessFiles` project property to a comma-separated list of file patterns:
 ```
-cmd> mvn spotless:apply -DspotlessFiles=my/file/pattern.java,more/generic/.*-pattern.java
+cmd> mvn spotless:apply -DspotlessFiles="my/file/pattern\.java, more/generic/.*-pattern\.java"
 ```
-
 The patterns are matched using `String#matches(String)` against the absolute file path.
 
+### IDE Hook
+You can specify a single file by providing the `spotlessIdeHook` argument, which accepts the absolute path of the file.
+```
+cmd> mvn spotless:apply -DspotlessIdeHook="C:\my-project\src\main\java\com\example\Application.java"
+
+```
+This option ignores the ratchetFrom property.
+
 <a name="examples"></a>
 
 ## Example configurations (from real-world projects)

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

@@ -187,6 +187,9 @@ public abstract class AbstractSpotlessMojo extends AbstractMojo {
 	@Parameter(property = "spotlessFiles")
 	private String filePatterns;
 
+	@Parameter(property = "spotlessIdeHook")
+	private String spotlessIdeHook;
+
 	@Parameter(property = LicenseHeaderStep.spotlessSetLicenseHeaderYearsFromGitHistory)
 	private String setLicenseHeaderYearsFromGitHistory;
 
@@ -251,6 +254,10 @@ private boolean shouldSkip() {
 	}
 
 	private List<File> collectFiles(FormatterFactory formatterFactory, FormatterConfig config) {
+		if (!(spotlessIdeHook == null || spotlessIdeHook.isEmpty())) {
+			return fetchFileFromIdeHook();
+		}
+
 		Optional<String> ratchetFrom = formatterFactory.ratchetFrom(config);
 		try {
 			final List<File> files;
@@ -279,6 +286,15 @@ private List<File> collectFiles(FormatterFactory formatterFactory, FormatterConf
 		}
 	}
 
+	private List<File> fetchFileFromIdeHook() {
+		File file = new File(spotlessIdeHook);
+		if (!file.isAbsolute()) {
+			throw new PluginException("Argument passed to spotlessIdeHook must be an absolute path");
+		}
+
+		return List.of(file);
+	}
+
 	private List<File> collectFilesFromGit(FormatterFactory formatterFactory, String ratchetFrom) {
 		MatchPatterns includePatterns = MatchPatterns.from(
 				withNormalizedFileSeparators(getIncludes(formatterFactory)));