From e32fcbd93a50d3db5a48769f19fc201e4352ecc5 Mon Sep 17 00:00:00 2001 From: Markus Heberling Date: Fri, 24 Sep 2021 20:42:04 +0200 Subject: [PATCH] Added support for local binary formatters --- CHANGES.md | 2 + README.md | 2 + .../spotless/generic/NativeCmdStep.java | 67 +++++++++++++++++++ plugin-maven/CHANGES.md | 2 + plugin-maven/README.md | 8 +++ .../spotless/maven/FormatterFactory.java | 4 ++ .../spotless/maven/generic/NativeCmd.java | 47 +++++++++++++ .../spotless/maven/generic/NativeCmdTest.java | 49 ++++++++++++++ 8 files changed, 181 insertions(+) create mode 100644 lib/src/main/java/com/diffplug/spotless/generic/NativeCmdStep.java create mode 100644 plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/NativeCmd.java create mode 100644 plugin-maven/src/test/java/com/diffplug/spotless/maven/generic/NativeCmdTest.java diff --git a/CHANGES.md b/CHANGES.md index f4445118a4..e4847fb938 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -10,6 +10,8 @@ This document is intended for Spotless developers. We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`). ## [Unreleased] +### Added +* Added support for calling local binary formatters ([#949](https://github.com/diffplug/spotless/pull/949)) ### Changed * Added support and bump Eclipse formatter default versions to `4.21` for `eclipse-cdt`, `eclipse-jdt`, `eclipse-wtp`. Change is only applied for JVM 11+. * Added `groupArtifact` option for `google-java-format` ([#944](https://github.com/diffplug/spotless/pull/944)) diff --git a/README.md b/README.md index cebc182b82..3854ba7d69 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,7 @@ output = [ lib('generic.EndWithNewlineStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |', lib('generic.IndentStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |', lib('generic.LicenseHeaderStep') +'{{yes}} | {{yes}} | {{yes}} | {{no}} |', +lib('generic.NativeCmdStep') +'{{no}} | {{yes}} | {{no}} | {{no}} |', lib('generic.ReplaceRegexStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |', lib('generic.ReplaceStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |', lib('generic.TrimTrailingWhitespaceStep') +'{{yes}} | {{yes}} | {{no}} | {{no}} |', @@ -83,6 +84,7 @@ extra('wtp.EclipseWtpFormatterStep') +'{{yes}} | {{yes}} | [`generic.EndWithNewlineStep`](lib/src/main/java/com/diffplug/spotless/generic/EndWithNewlineStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: | | [`generic.IndentStep`](lib/src/main/java/com/diffplug/spotless/generic/IndentStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: | | [`generic.LicenseHeaderStep`](lib/src/main/java/com/diffplug/spotless/generic/LicenseHeaderStep.java) | :+1: | :+1: | :+1: | :white_large_square: | +| [`generic.NativeCmdStep`](lib/src/main/java/com/diffplug/spotless/generic/NativeCmdStep.java) | :white_large_square: | :+1: | :white_large_square: | :white_large_square: | | [`generic.ReplaceRegexStep`](lib/src/main/java/com/diffplug/spotless/generic/ReplaceRegexStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: | | [`generic.ReplaceStep`](lib/src/main/java/com/diffplug/spotless/generic/ReplaceStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: | | [`generic.TrimTrailingWhitespaceStep`](lib/src/main/java/com/diffplug/spotless/generic/TrimTrailingWhitespaceStep.java) | :+1: | :+1: | :white_large_square: | :white_large_square: | 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..bfc90d6843 --- /dev/null +++ b/lib/src/main/java/com/diffplug/spotless/generic/NativeCmdStep.java @@ -0,0 +1,67 @@ +/* + * 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.File; +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.FileSignature; +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, File pathToExe, List arguments) { + Objects.requireNonNull(name, "name"); + Objects.requireNonNull(pathToExe, "pathToExe"); + List argumentsWithPathToExe = new ArrayList<>(); + argumentsWithPathToExe.add(pathToExe.getAbsolutePath()); + if (arguments != null) { + argumentsWithPathToExe.addAll(arguments); + } + return FormatterStep.createLazy(name, () -> new State(FileSignature.signAsList(pathToExe), argumentsWithPathToExe), State::toFunc); + } + + static class State implements Serializable { + private static final long serialVersionUID = 1L; + + final FileSignature pathToExe; + + final List arguments; + + State(FileSignature 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/CHANGES.md b/plugin-maven/CHANGES.md index a1e738ddfd..fa57b090b7 100644 --- a/plugin-maven/CHANGES.md +++ b/plugin-maven/CHANGES.md @@ -3,6 +3,8 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`). ## [Unreleased] +### Added +* Added support for calling local binary formatters ([#949](https://github.com/diffplug/spotless/pull/949)) ### Changed * Added support and bump Eclipse formatter default versions to `4.21` for `eclipse-cdt`, `eclipse-jdt`, `eclipse-wtp`. Change is only applied for JVM 11+. * Added `groupArtifact` option for `google-java-format` ([#944](https://github.com/diffplug/spotless/pull/944)) diff --git a/plugin-maven/README.md b/plugin-maven/README.md index caa22d1d3d..d43ca6a415 100644 --- a/plugin-maven/README.md +++ b/plugin-maven/README.md @@ -769,6 +769,14 @@ to true. 4 + + Greetings to Mars from sed + /usr/bin/sed + + s/World/Mars/g + + + Say Hello to Mars World 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..c430edb740 --- /dev/null +++ b/plugin-maven/src/main/java/com/diffplug/spotless/maven/generic/NativeCmd.java @@ -0,0 +1,47 @@ +/* + * 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.io.File; +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 File 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..fe1fdd3c6e --- /dev/null +++ b/plugin-maven/src/test/java/com/diffplug/spotless/maven/generic/NativeCmdTest.java @@ -0,0 +1,49 @@ +/* + * 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 static org.assertj.core.api.Assumptions.assumeThat; + +import java.io.File; + +import org.junit.jupiter.api.Test; + +import com.diffplug.spotless.maven.MavenIntegrationHarness; + +public class NativeCmdTest extends MavenIntegrationHarness { + + @Test + public void fromStdInToStdOut() throws Exception { + // This will only work if /usr/bin/sed is available + assumeThat(new File("/usr/bin/sed")).exists(); + writePomWithFormatSteps( + "", + " Greetings to Mars", + " /usr/bin/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); + } +}