feat: poc of cli (step 1)

Author: simschla

cli/CHANGES.md

@@ -0,0 +1,62 @@
+plugins {
+	id 'org.graalvm.buildtools.native'
+}
+apply from: rootProject.file('gradle/changelog.gradle')
+ext.artifactId = project.artifactIdGradle
+version = spotlessChangelog.versionNext
+apply plugin: 'java-library'
+apply plugin: 'application'
+apply from: rootProject.file('gradle/java-setup.gradle')
+apply from: rootProject.file('gradle/spotless-freshmark.gradle')
+
+dependencies {
+	// todo, unify with plugin-gradle/build.gradle -- BEGIN
+	if (version.endsWith('-SNAPSHOT') || (rootProject.spotlessChangelog.versionNext == rootProject.spotlessChangelog.versionLast)) {
+		api projects.lib
+		api projects.libExtra
+	} else {
+		api "com.diffplug.spotless:spotless-lib:${rootProject.spotlessChangelog.versionLast}"
+		api "com.diffplug.spotless:spotless-lib-extra:${rootProject.spotlessChangelog.versionLast}"
+	}
+	implementation "com.diffplug.durian:durian-core:${VER_DURIAN}"
+	implementation "com.diffplug.durian:durian-io:${VER_DURIAN}"
+	implementation "com.diffplug.durian:durian-collect:${VER_DURIAN}"
+	implementation "org.eclipse.jgit:org.eclipse.jgit:${VER_JGIT}"
+
+	testImplementation projects.testlib
+	testImplementation "org.junit.jupiter:junit-jupiter:${VER_JUNIT}"
+	testImplementation "org.assertj:assertj-core:${VER_ASSERTJ}"
+	testImplementation "com.diffplug.durian:durian-testlib:${VER_DURIAN}"
+	testImplementation 'org.owasp.encoder:encoder:1.3.1'
+	testRuntimeOnly "org.junit.platform:junit-platform-launcher"
+	// todo, unify with plugin-gradle/build.gradle -- END
+
+	implementation "info.picocli:picocli:${VER_PICOCLI}"
+	annotationProcessor "info.picocli:picocli-codegen:${VER_PICOCLI}"
+}
+
+compileJava {
+	options.compilerArgs += [
+		"-Aproject=${project.group}/${project.name}"
+	]
+}
+
+tasks.withType(org.graalvm.buildtools.gradle.tasks.GenerateResourcesConfigFile).configureEach {
+	notCompatibleWithConfigurationCache('https://github.com/britter/maven-plugin-development/issues/8')
+}
+tasks.withType(org.graalvm.buildtools.gradle.tasks.BuildNativeImageTask).configureEach {
+	notCompatibleWithConfigurationCache('https://github.com/britter/maven-plugin-development/issues/8')
+}
+
+// use tasks 'nativeCompile' and 'nativeRun' to compile and run the native image
+graalvmNative {
+	binaries {
+		main {
+			imageName = 'spotless'
+			mainClass = 'com.diffplug.spotless.cli.SpotlessCLI'
+			sharedLibrary = false
+
+			runtimeArgs.add('--user=ABC')
+		}
+	}
+}

cli/build.gradle

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2024 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.cli;
+
+import com.diffplug.spotless.cli.execution.SpotlessExecutionStrategy;
+import com.diffplug.spotless.cli.subcommands.SpotlessApply;
+import com.diffplug.spotless.cli.subcommands.SpotlessCheck;
+
+import picocli.CommandLine;
+import picocli.CommandLine.Command;
+
+@Command(name = "spotless cli", mixinStandardHelpOptions = true, version = "spotless ${version}", // https://picocli.info/#_dynamic_version_information
+		description = "Runs spotless", subcommands = {SpotlessCheck.class, SpotlessApply.class})
+public class SpotlessCLI implements SpotlessCommand {
+
+	@CommandLine.Option(names = {"-V", "--version"}, versionHelp = true, description = "Print version information and exit")
+	boolean versionRequested;
+
+	@CommandLine.Option(names = {"-h", "--help"}, usageHelp = true, description = "display this help message")
+	boolean usageHelpRequested;
+
+	public static void main(String... args) {
+		//		args = new String[]{"--version"};
+		args = new String[]{"apply", "license-header", "--header-file", "abc.txt", "license-header", "--header", "abc"};
+		int exitCode = new CommandLine(new SpotlessCLI())
+				.setExecutionStrategy(new SpotlessExecutionStrategy())
+				.execute(args);
+		System.exit(exitCode);
+	}
+}

cli/src/main/java/com/diffplug/spotless/cli/SpotlessCLI.java

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2024 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.cli;
+
+public interface SpotlessCommand {}

cli/src/main/java/com/diffplug/spotless/cli/SpotlessCommand.java

@@ -0,0 +1,78 @@
+/*
+ * Copyright 2024 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.cli.execution;
+
+import static picocli.CommandLine.executeHelpRequest;
+
+import java.util.function.Function;
+
+import com.diffplug.spotless.cli.SpotlessCommand;
+import com.diffplug.spotless.cli.subcommands.SpotlessActionCommand;
+import com.diffplug.spotless.cli.subcommands.steps.SpotlessCLIStep;
+
+import picocli.CommandLine;
+
+public class SpotlessExecutionStrategy implements CommandLine.IExecutionStrategy {
+
+	public int execute(CommandLine.ParseResult parseResult) throws CommandLine.ExecutionException {
+		Integer helpResult = executeHelpRequest(parseResult);
+		if (helpResult != null) {
+			return helpResult;
+		}
+		return runSpotlessActions(parseResult);
+	}
+
+	private Integer runSpotlessActions(CommandLine.ParseResult parseResult) {
+		// 1. run setup (for combining steps handled as subcommands)
+
+		// 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);
+	}
+
+	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 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;
+	}
+}

cli/src/main/java/com/diffplug/spotless/cli/execution/SpotlessExecutionStrategy.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2024 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.cli.subcommands;
+
+import com.diffplug.spotless.cli.SpotlessCommand;
+
+public interface SpotlessActionCommand extends SpotlessCommand {
+	Integer executeSpotlessAction();
+}

cli/src/main/java/com/diffplug/spotless/cli/subcommands/SpotlessActionCommand.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2024 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.cli.subcommands;
+
+import com.diffplug.spotless.cli.subcommands.steps.generic.LicenseHeader;
+import com.diffplug.spotless.cli.subcommands.steps.generic.RemoveMeLaterSubCommand;
+
+import picocli.CommandLine;
+
+// repeatable subcommands: https://picocli.info/#_repeatable_subcommands_specification
+
+// access command spec: https://picocli.info/#spec-annotation
+
+@CommandLine.Command(mixinStandardHelpOptions = true, subcommandsRepeatable = true, subcommands = {
+		LicenseHeader.class,
+		RemoveMeLaterSubCommand.class
+})
+public abstract class SpotlessActionSubCommand implements SpotlessActionCommand {
+
+	@Override
+	public Integer executeSpotlessAction() {
+		System.out.println("Hello " + getClass().getSimpleName() + ", abc!");
+		return 0;
+	}
+}

cli/src/main/java/com/diffplug/spotless/cli/subcommands/SpotlessActionSubCommand.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2024 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.cli.subcommands;
+
+import picocli.CommandLine;
+
+@CommandLine.Command(name = "apply", description = "Runs spotless apply")
+public class SpotlessApply extends SpotlessActionSubCommand {
+
+}

cli/src/main/java/com/diffplug/spotless/cli/subcommands/SpotlessApply.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2024 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.cli.subcommands;
+
+import picocli.CommandLine;
+
+@CommandLine.Command(name = "check", description = "Runs spotless check")
+public class SpotlessCheck extends SpotlessActionSubCommand {
+
+}

cli/src/main/java/com/diffplug/spotless/cli/subcommands/SpotlessCheck.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2024 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.cli.subcommands.steps;
+
+import com.diffplug.spotless.cli.SpotlessCommand;
+
+public interface SpotlessCLIStep extends SpotlessCommand {
+	void prepare();
+}