-
Notifications
You must be signed in to change notification settings - Fork 565
Expand file tree
/
Copy pathShfmtStep.java
More file actions
136 lines (112 loc) · 4.39 KB
/
Copy pathShfmtStep.java
File metadata and controls
136 lines (112 loc) · 4.39 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
* Copyright 2024-2026 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.shell;
import java.io.File;
import java.io.IOException;
import java.io.Serializable;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.Objects;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.annotation.Nullable;
import com.diffplug.spotless.ForeignExe;
import com.diffplug.spotless.FormatterFunc;
import com.diffplug.spotless.FormatterStep;
import com.diffplug.spotless.ProcessRunner;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
public final class ShfmtStep {
public static String name() {
return "shfmt";
}
public static String defaultVersion() {
return "3.8.0";
}
private final String version;
private final @Nullable String pathToExe;
private ShfmtStep(String version, @Nullable String pathToExe) {
this.version = version;
this.pathToExe = pathToExe;
}
public static ShfmtStep withVersion(String version) {
return new ShfmtStep(version, null);
}
public ShfmtStep withPathToExe(String pathToExe) {
return new ShfmtStep(version, pathToExe);
}
public FormatterStep create() {
return FormatterStep.createLazy(name(), this::createRoundtrip, RoundtripState::toEquality, EqualityState::toFunc);
}
private RoundtripState createRoundtrip() throws IOException, InterruptedException {
String howToInstall = """
You can download shfmt from https://github.com/mvdan/sh and \
then point Spotless to it with {@code pathToExe('/path/to/shfmt')} \
or you can use your platform's package manager:
win: choco install shfmt
mac: brew install shfmt
linux: apt install shfmt
github issue to handle this better: https://github.com/diffplug/spotless/issues/673""";
final ForeignExe exe = ForeignExe.nameAndVersion("shfmt", version)
.pathToExe(pathToExe)
.versionRegex(Pattern.compile("([\\d.]+)"))
.fixCantFind(howToInstall)
.fixWrongVersion(
"You can tell Spotless to use the version you already have with {@code shfmt('{versionFound}')}"
+ "or you can download the currently specified version, {version}.\n" + howToInstall);
return new RoundtripState(version, exe);
}
static class RoundtripState implements Serializable {
private static final long serialVersionUID = 1L;
final String version;
final ForeignExe exe;
RoundtripState(String version, ForeignExe exe) {
this.version = version;
this.exe = exe;
}
private EqualityState toEquality() {
return new EqualityState(version, exe);
}
}
@SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED")
static class EqualityState implements Serializable {
private static final long serialVersionUID = -1825662356883926318L;
// used for up-to-date checks and caching
final String version;
final transient ForeignExe exe;
// used for executing
private transient @Nullable List<String> args;
EqualityState(String version, ForeignExe pathToExe) {
this.version = version;
this.exe = Objects.requireNonNull(pathToExe);
}
String format(ProcessRunner runner, String input, File file) throws IOException, InterruptedException {
if (args == null) {
// args will be reused during a single Spotless task execution,
// so this "prefix" is being "cached" for each Spotless format with shfmt.
args = List.of(exe.confirmVersionAndGetAbsolutePath(), "--filename");
}
// This will ensure that the next file name is retrieved on every format
final List<String> finalArgs = Stream.concat(args.stream(), Stream.of(file.getAbsolutePath()))
.collect(Collectors.toList());
return runner.exec(input.getBytes(StandardCharsets.UTF_8), finalArgs).assertExitZero(StandardCharsets.UTF_8);
}
FormatterFunc.Closeable toFunc() {
ProcessRunner runner = new ProcessRunner();
return FormatterFunc.Closeable.of(runner, this::format);
}
}
}