diff --git a/lib/src/main/java/com/diffplug/spotless/generic/NativeCmdStep.java b/lib/src/main/java/com/diffplug/spotless/generic/NativeCmdStep.java new file mode 100644 index 0000000000..603b6b30c0 --- /dev/null +++ b/lib/src/main/java/com/diffplug/spotless/generic/NativeCmdStep.java @@ -0,0 +1,65 @@ +/* + * Copyright 2021 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.generic; + +import java.io.IOException; +import java.io.Serializable; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; + +import com.diffplug.spotless.FormatterFunc; +import com.diffplug.spotless.FormatterStep; +import com.diffplug.spotless.ProcessRunner; + +public class NativeCmdStep { + // prevent direct instantiation + private NativeCmdStep() {} + + public static FormatterStep create(String name, String pathToExe, List arguments) { + Objects.requireNonNull(name, "name"); + Objects.requireNonNull(pathToExe, "pathToExe"); + List argumentsWithPathToExe = new ArrayList<>(); + argumentsWithPathToExe.add(pathToExe); + if (arguments != null) { + argumentsWithPathToExe.addAll(arguments); + } + return FormatterStep.createLazy(name, () -> new State(pathToExe, argumentsWithPathToExe), State::toFunc); + } + + static class State implements Serializable { + private static final long serialVersionUID = 1L; + + final String pathToExe; + + final List arguments; + + State(String pathToExe, List arguments) { + this.pathToExe = pathToExe; + this.arguments = arguments; + } + + String format(ProcessRunner runner, String input) throws IOException, InterruptedException { + return runner.exec(input.getBytes(StandardCharsets.UTF_8), arguments).assertExitZero(StandardCharsets.UTF_8); + } + + FormatterFunc.Closeable toFunc() { + ProcessRunner runner = new ProcessRunner(); + return FormatterFunc.Closeable.of(runner, this::format); + } + } +} diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/FormatterFactory.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/FormatterFactory.java index 90fad16e9d..0ff3980893 100644 --- a/plugin-maven/src/main/java/com/diffplug/spotless/maven/FormatterFactory.java +++ b/plugin-maven/src/main/java/com/diffplug/spotless/maven/FormatterFactory.java @@ -118,6 +118,10 @@ public final void addReplace(Replace replace) { addStepFactory(replace); } + public final void addNativeCmd(NativeCmd nativeCmd) { + addStepFactory(nativeCmd); + } + public final void addReplaceRegex(ReplaceRegex replaceRegex) { addStepFactory(replaceRegex); } diff --git a/plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/NativeCmd.java b/plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/NativeCmd.java new file mode 100644 index 0000000000..b0063f07f4 --- /dev/null +++ b/plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/NativeCmd.java @@ -0,0 +1,46 @@ +/* + * Copyright 2021 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.maven.generic; + +import java.util.List; + +import org.apache.maven.plugins.annotations.Parameter; + +import com.diffplug.spotless.FormatterStep; +import com.diffplug.spotless.generic.NativeCmdStep; +import com.diffplug.spotless.maven.FormatterStepConfig; +import com.diffplug.spotless.maven.FormatterStepFactory; + +public class NativeCmd implements FormatterStepFactory { + + @Parameter + private String name; + + @Parameter + private String pathToExe; + + @Parameter + private List arguments; + + @Override + public FormatterStep newFormatterStep(FormatterStepConfig config) { + if (name == null || pathToExe == null) { + throw new IllegalArgumentException("Must specify 'name' and 'pathToExe'."); + } + + return NativeCmdStep.create(name, pathToExe, arguments); + } +} diff --git a/plugin-maven/src/test/java/com/diffplug/spotless/maven/generic/NativeCmdTest.java b/plugin-maven/src/test/java/com/diffplug/spotless/maven/generic/NativeCmdTest.java new file mode 100644 index 0000000000..a9a15576df --- /dev/null +++ b/plugin-maven/src/test/java/com/diffplug/spotless/maven/generic/NativeCmdTest.java @@ -0,0 +1,43 @@ +/* + * Copyright 2021 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.maven.generic; + +import org.junit.Test; + +import com.diffplug.spotless.maven.MavenIntegrationHarness; + +public class NativeCmdTest extends MavenIntegrationHarness { + + @Test + public void fromStdOutToStdOut() throws Exception { + writePomWithFormatSteps( + "", + " Greetings to Mars", + " sed", + " " + + " s/World/Mars/g" + + " ", + ""); + runTest("Hello World", "Hello Mars"); + } + + private void runTest(String sourceContent, String targetContent) throws Exception { + String path = "src/main/java/test.java"; + setFile(path).toContent(sourceContent); + mavenRunner().withArguments("spotless:apply").runNoError(); + assertFile(path).hasContent(targetContent); + } +}