feat: poc of cli (step 2)

simschla · simschla · commit 6bf8840f0fc4 · 2025-02-07T20:59:03.000+01:00
diff --git a/cli/src/main/java/com/diffplug/spotless/cli/SpotlessCLI.java b/cli/src/main/java/com/diffplug/spotless/cli/SpotlessCLI.java
@@ -34,9 +34,10 @@ public class SpotlessCLI implements SpotlessCommand {
 
 	public static void main(String... args) {
 		//		args = new String[]{"--version"};
-		args = new String[]{"apply", "license-header", "--header-file", "abc.txt", "license-header", "--header", "abc"};
+		args = new String[]{"apply", "license-header", "--header-file", "CHANGES.md", "--delimiter-for", "java", "license-header", "--header", "abc"};
 		int exitCode = new CommandLine(new SpotlessCLI())
 				.setExecutionStrategy(new SpotlessExecutionStrategy())
+				.setCaseInsensitiveEnumValuesAllowed(true)
 				.execute(args);
 		System.exit(exitCode);
 	}
diff --git a/cli/src/main/java/com/diffplug/spotless/cli/execution/SpotlessExecutionStrategy.java b/cli/src/main/java/com/diffplug/spotless/cli/execution/SpotlessExecutionStrategy.java
@@ -17,11 +17,12 @@
 
 import static picocli.CommandLine.executeHelpRequest;
 
-import java.util.function.Function;
+import java.util.List;
+import java.util.stream.Collectors;
 
-import com.diffplug.spotless.cli.SpotlessCommand;
+import com.diffplug.spotless.FormatterStep;
 import com.diffplug.spotless.cli.subcommands.SpotlessActionCommand;
-import com.diffplug.spotless.cli.subcommands.steps.SpotlessCLIStep;
+import com.diffplug.spotless.cli.subcommands.steps.SpotlessCLIFormatterStep;
 
 import picocli.CommandLine;
 
@@ -37,42 +38,28 @@ public int execute(CommandLine.ParseResult parseResult) throws CommandLine.Execu
 
 	private Integer runSpotlessActions(CommandLine.ParseResult parseResult) {
 		// 1. run setup (for combining steps handled as subcommands)
+		List<FormatterStep> steps = prepareFormatterSteps(parseResult);
 
-		// TODO: maybe collect a list of steps and pass them to the spotless action in step 2?
-		Integer prepareResult = runSpotlessRecursive(parseResult, this::prepareStep);
-		if (prepareResult != null) {
-			return prepareResult;
-		}
 		// 2. run spotless steps
-		return runSpotlessRecursive(parseResult, this::executeSpotlessAction);
+		return executeSpotlessAction(parseResult, steps);
 	}
 
-	private Integer runSpotlessRecursive(CommandLine.ParseResult parseResult, Function<SpotlessCommand, Integer> action) {
-		SpotlessCommand spotlessCommand = parseResult.commandSpec().commandLine().getCommand();
-		Integer result = action.apply(spotlessCommand);
-		if (result != null) {
-			return result;
-		}
-		for (CommandLine.ParseResult subCommand : parseResult.subcommands()) {
-			Integer subResult = runSpotlessRecursive(subCommand, action);
-			if (subResult != null) {
-				return subResult;
-			}
-		}
-		return null;
+	private List<FormatterStep> prepareFormatterSteps(CommandLine.ParseResult parseResult) {
+		return parseResult.asCommandLineList().stream()
+				.map(CommandLine::getCommand)
+				.filter(command -> command instanceof SpotlessCLIFormatterStep)
+				.map(SpotlessCLIFormatterStep.class::cast)
+				.flatMap(step -> step.prepareFormatterSteps().stream())
+				.collect(Collectors.toList());
 	}
 
-	private Integer prepareStep(SpotlessCommand spotlessCommand) {
-		if (spotlessCommand instanceof SpotlessCLIStep) {
-			((SpotlessCLIStep) spotlessCommand).prepare();
-		}
-		return null;
-	}
-
-	private Integer executeSpotlessAction(SpotlessCommand spotlessCommand) {
-		if (spotlessCommand instanceof SpotlessActionCommand) {
-			return ((SpotlessActionCommand) spotlessCommand).executeSpotlessAction();
-		}
-		return null;
+	private Integer executeSpotlessAction(CommandLine.ParseResult parseResult, List<FormatterStep> steps) {
+		return parseResult.asCommandLineList().stream()
+				.map(CommandLine::getCommand)
+				.filter(command -> command instanceof SpotlessActionCommand)
+				.map(SpotlessActionCommand.class::cast)
+				.findFirst()
+				.map(spotlessActionCommand -> spotlessActionCommand.executeSpotlessAction(steps))
+				.orElse(-1);
 	}
 }
diff --git a/cli/src/main/java/com/diffplug/spotless/cli/subcommands/SpotlessActionCommand.java b/cli/src/main/java/com/diffplug/spotless/cli/subcommands/SpotlessActionCommand.java
@@ -15,8 +15,13 @@
  */
 package com.diffplug.spotless.cli.subcommands;
 
+import java.util.List;
+
+import javax.annotation.Nonnull;
+
+import com.diffplug.spotless.FormatterStep;
 import com.diffplug.spotless.cli.SpotlessCommand;
 
 public interface SpotlessActionCommand extends SpotlessCommand {
-	Integer executeSpotlessAction();
+	Integer executeSpotlessAction(@Nonnull List<FormatterStep> formatterSteps);
 }
diff --git a/cli/src/main/java/com/diffplug/spotless/cli/subcommands/SpotlessActionSubCommand.java b/cli/src/main/java/com/diffplug/spotless/cli/subcommands/SpotlessActionSubCommand.java
@@ -15,6 +15,11 @@
  */
 package com.diffplug.spotless.cli.subcommands;
 
+import java.util.List;
+
+import javax.annotation.Nonnull;
+
+import com.diffplug.spotless.FormatterStep;
 import com.diffplug.spotless.cli.subcommands.steps.generic.LicenseHeader;
 import com.diffplug.spotless.cli.subcommands.steps.generic.RemoveMeLaterSubCommand;
 
@@ -31,8 +36,9 @@
 public abstract class SpotlessActionSubCommand implements SpotlessActionCommand {
 
 	@Override
-	public Integer executeSpotlessAction() {
+	public Integer executeSpotlessAction(@Nonnull List<FormatterStep> formatterSteps) {
 		System.out.println("Hello " + getClass().getSimpleName() + ", abc!");
+		formatterSteps.forEach(step -> System.out.println("Step: " + step));
 		return 0;
 	}
 }
diff --git a/cli/src/main/java/com/diffplug/spotless/cli/subcommands/steps/SpotlessCLIFormatterStep.java b/cli/src/main/java/com/diffplug/spotless/cli/subcommands/steps/SpotlessCLIFormatterStep.java
@@ -15,8 +15,14 @@
  */
 package com.diffplug.spotless.cli.subcommands.steps;
 
+import java.util.List;
+
+import javax.annotation.Nonnull;
+
+import com.diffplug.spotless.FormatterStep;
 import com.diffplug.spotless.cli.SpotlessCommand;
 
-public interface SpotlessCLIStep extends SpotlessCommand {
-	void prepare();
+public interface SpotlessCLIFormatterStep extends SpotlessCommand {
+	@Nonnull
+	List<FormatterStep> prepareFormatterSteps();
 }
diff --git a/cli/src/main/java/com/diffplug/spotless/cli/subcommands/steps/generic/LicenseHeader.java b/cli/src/main/java/com/diffplug/spotless/cli/subcommands/steps/generic/LicenseHeader.java
@@ -16,25 +16,81 @@
 package com.diffplug.spotless.cli.subcommands.steps.generic;
 
 import java.io.File;
+import java.nio.file.Files;
+import java.util.List;
+
+import javax.annotation.Nonnull;
+
+import com.diffplug.spotless.FormatterStep;
+import com.diffplug.spotless.ThrowingEx;
+import com.diffplug.spotless.antlr4.Antlr4Defaults;
+import com.diffplug.spotless.cpp.CppDefaults;
+import com.diffplug.spotless.generic.LicenseHeaderStep;
+import com.diffplug.spotless.kotlin.KotlinConstants;
+import com.diffplug.spotless.protobuf.ProtobufConstants;
 
 import picocli.CommandLine;
 
 @CommandLine.Command(name = "license-header", description = "Runs license header")
-public class LicenseHeader extends SpotlessStepSubCommand {
+public class LicenseHeader extends SpotlessFormatterStepSubCommand {
 
 	@CommandLine.ArgGroup(exclusive = true, multiplicity = "1")
-	LicenseHeaderOption licenseHeaderOption;
+	LicenseHeaderSourceOption licenseHeaderSourceOption;
 
-	static class LicenseHeaderOption {
+	@CommandLine.ArgGroup(exclusive = true, multiplicity = "0..1")
+	LicenseHeaderDelimiterOption licenseHeaderDelimiterOption;
+
+	static class LicenseHeaderSourceOption {
 		@CommandLine.Option(names = {"--header", "-H"}, required = true)
 		String header;
 		@CommandLine.Option(names = {"--header-file", "-f"}, required = true)
 		File headerFile;
 	}
 
+	static class LicenseHeaderDelimiterOption {
+
+		@CommandLine.Option(names = {"--delimiter", "-d"}, required = true)
+		String delimiter;
+
+		@CommandLine.Option(names = {"--delimiter-for", "-D"}, required = true)
+		DefaultDelimiterType defaultDelimiterType;
+	}
+
+	enum DefaultDelimiterType {
+		JAVA(LicenseHeaderStep.DEFAULT_JAVA_HEADER_DELIMITER), CPP(CppDefaults.DELIMITER_EXPR), ANTLR4(Antlr4Defaults.licenseHeaderDelimiter()), GROOVY(LicenseHeaderStep.DEFAULT_JAVA_HEADER_DELIMITER), PROTOBUF(ProtobufConstants.LICENSE_HEADER_DELIMITER), KOTLIN(KotlinConstants.LICENSE_HEADER_DELIMITER);
+
+		private final String delimiterExpression;
+
+		DefaultDelimiterType(String delimiterExpression) {
+			this.delimiterExpression = delimiterExpression;
+		}
+	}
+
+	@Nonnull
 	@Override
-	public void prepare() {
-		super.prepare();
-		System.out.println(licenseHeaderOption.header != null ? "Header: " + licenseHeaderOption.header : "HeaderFile:" + licenseHeaderOption.headerFile);
+	public List<FormatterStep> prepareFormatterSteps() {
+		FormatterStep licenseHeaderStep = LicenseHeaderStep.headerDelimiter(headerSource(), delimiter())
+				// TODO add more config options
+				.build();
+		return List.of(licenseHeaderStep);
+	}
+
+	private ThrowingEx.Supplier<String> headerSource() {
+		if (licenseHeaderSourceOption.header != null) {
+			return () -> licenseHeaderSourceOption.header;
+		} else {
+			return () -> ThrowingEx.get(() -> Files.readString(licenseHeaderSourceOption.headerFile.toPath()));
+		}
+	}
+
+	private String delimiter() {
+		if (licenseHeaderDelimiterOption == null) {
+			return DefaultDelimiterType.JAVA.delimiterExpression;
+		}
+		if (licenseHeaderDelimiterOption.delimiter != null) {
+			return licenseHeaderDelimiterOption.delimiter;
+		} else {
+			return licenseHeaderDelimiterOption.defaultDelimiterType.delimiterExpression;
+		}
 	}
 }
diff --git a/cli/src/main/java/com/diffplug/spotless/cli/subcommands/steps/generic/RemoveMeLaterSubCommand.java b/cli/src/main/java/com/diffplug/spotless/cli/subcommands/steps/generic/RemoveMeLaterSubCommand.java
@@ -16,11 +16,16 @@
 package com.diffplug.spotless.cli.subcommands.steps.generic;
 
 import java.io.File;
+import java.util.List;
+
+import javax.annotation.Nonnull;
+
+import com.diffplug.spotless.FormatterStep;
 
 import picocli.CommandLine;
 
 @CommandLine.Command(name = "ignoreme")
-public class RemoveMeLaterSubCommand extends SpotlessStepSubCommand {
+public class RemoveMeLaterSubCommand extends SpotlessFormatterStepSubCommand {
 
 	@CommandLine.ArgGroup(exclusive = true, multiplicity = "1")
 	LicenseHeaderOption licenseHeaderOption;
@@ -31,4 +36,10 @@ static class LicenseHeaderOption {
 		@CommandLine.Option(names = {"--header-file", "-f"}, required = true)
 		File headerFile;
 	}
+
+	@Nonnull
+	@Override
+	public List<FormatterStep> prepareFormatterSteps() {
+		return List.of();
+	}
 }
diff --git a/cli/src/main/java/com/diffplug/spotless/cli/subcommands/steps/generic/SpotlessFormatterStepSubCommand.java b/cli/src/main/java/com/diffplug/spotless/cli/subcommands/steps/generic/SpotlessFormatterStepSubCommand.java
@@ -15,15 +15,9 @@
  */
 package com.diffplug.spotless.cli.subcommands.steps.generic;
 
-import com.diffplug.spotless.cli.subcommands.steps.SpotlessCLIStep;
+import com.diffplug.spotless.cli.subcommands.steps.SpotlessCLIFormatterStep;
 
 import picocli.CommandLine;
 
 @CommandLine.Command(mixinStandardHelpOptions = true)
-public abstract class SpotlessStepSubCommand implements SpotlessCLIStep {
-
-	@Override
-	public void prepare() {
-		System.out.println("Prepare SpotlessStepSubCommand " + getClass().getSimpleName() + ", abc!");
-	}
-}
+public abstract class SpotlessFormatterStepSubCommand implements SpotlessCLIFormatterStep {}
