|
| 1 | +/* |
| 2 | + * Copyright 2024 DiffPlug |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | +package com.diffplug.spotless.shell; |
| 17 | + |
| 18 | +import java.io.File; |
| 19 | +import java.io.IOException; |
| 20 | +import java.io.Serializable; |
| 21 | +import java.nio.charset.StandardCharsets; |
| 22 | +import java.util.List; |
| 23 | +import java.util.Objects; |
| 24 | +import java.util.regex.Pattern; |
| 25 | + |
| 26 | +import javax.annotation.Nullable; |
| 27 | + |
| 28 | +import com.diffplug.spotless.ForeignExe; |
| 29 | +import com.diffplug.spotless.FormatterFunc; |
| 30 | +import com.diffplug.spotless.FormatterStep; |
| 31 | +import com.diffplug.spotless.ProcessRunner; |
| 32 | + |
| 33 | +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; |
| 34 | + |
| 35 | +public class ShfmtStep { |
| 36 | + public static String name() { |
| 37 | + return "shfmt"; |
| 38 | + } |
| 39 | + |
| 40 | + public static String defaultVersion() { |
| 41 | + return "3.7.0"; |
| 42 | + } |
| 43 | + |
| 44 | + private final String version; |
| 45 | + private final @Nullable String pathToExe; |
| 46 | + |
| 47 | + private ShfmtStep(String version, @Nullable String pathToExe) { |
| 48 | + this.version = version; |
| 49 | + this.pathToExe = pathToExe; |
| 50 | + } |
| 51 | + |
| 52 | + public static ShfmtStep withVersion(String version) { |
| 53 | + return new ShfmtStep(version, null); |
| 54 | + } |
| 55 | + |
| 56 | + public ShfmtStep withPathToExe(String pathToExe) { |
| 57 | + return new ShfmtStep(version, pathToExe); |
| 58 | + } |
| 59 | + |
| 60 | + public FormatterStep create() { |
| 61 | + return FormatterStep.createLazy(name(), this::createState, State::toFunc); |
| 62 | + } |
| 63 | + |
| 64 | + private State createState() throws IOException, InterruptedException { |
| 65 | + String howToInstall = "" + |
| 66 | + "You can download shfmt from https://github.com/mvdan/sh and " + |
| 67 | + "then point Spotless to it with {@code pathToExe('/path/to/shfmt')} " + |
| 68 | + "or you can use your platform's package manager:" + |
| 69 | + "\n win: choco install shfmt" + |
| 70 | + "\n mac: brew install shfmt" + |
| 71 | + "\n linux: apt install shfmt" + |
| 72 | + "\n github issue to handle this better: https://github.com/diffplug/spotless/issues/673"; |
| 73 | + final ForeignExe exe = ForeignExe.nameAndVersion("shfmt", version) |
| 74 | + .pathToExe(pathToExe) |
| 75 | + .versionRegex(Pattern.compile("(\\S*)")) |
| 76 | + .fixCantFind(howToInstall) |
| 77 | + .fixWrongVersion( |
| 78 | + "You can tell Spotless to use the version you already have with {@code shfmt('{versionFound}')}" + |
| 79 | + "or you can download the currently specified version, {version}.\n" + howToInstall); |
| 80 | + return new State(this, exe); |
| 81 | + } |
| 82 | + |
| 83 | + @SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED") |
| 84 | + static class State implements Serializable { |
| 85 | + private static final long serialVersionUID = -1825662356883926318L; |
| 86 | + // used for up-to-date checks and caching |
| 87 | + final String version; |
| 88 | + final transient ForeignExe exe; |
| 89 | + // used for executing |
| 90 | + private transient @Nullable List<String> args; |
| 91 | + |
| 92 | + State(ShfmtStep step, ForeignExe pathToExe) { |
| 93 | + this.version = step.version; |
| 94 | + this.exe = Objects.requireNonNull(pathToExe); |
| 95 | + } |
| 96 | + |
| 97 | + String format(ProcessRunner runner, String input, File file) throws IOException, InterruptedException { |
| 98 | + if (args == null) { |
| 99 | + args = List.of(exe.confirmVersionAndGetAbsolutePath(), "-i", "2", "-ci"); |
| 100 | + } |
| 101 | + |
| 102 | + return runner.exec(input.getBytes(StandardCharsets.UTF_8), args).assertExitZero(StandardCharsets.UTF_8); |
| 103 | + } |
| 104 | + |
| 105 | + FormatterFunc.Closeable toFunc() { |
| 106 | + ProcessRunner runner = new ProcessRunner(); |
| 107 | + return FormatterFunc.Closeable.of(runner, this::format); |
| 108 | + } |
| 109 | + } |
| 110 | +} |
0 commit comments