-
Notifications
You must be signed in to change notification settings - Fork 435
/
SpotlessTask.java
194 lines (163 loc) · 5.69 KB
/
SpotlessTask.java
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/*
* Copyright 2020-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.gradle.spotless;
import java.io.File;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Objects;
import org.eclipse.jgit.lib.ObjectId;
import org.gradle.api.DefaultTask;
import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.file.FileCollection;
import org.gradle.api.provider.Property;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.InputFiles;
import org.gradle.api.tasks.Internal;
import org.gradle.api.tasks.OutputDirectory;
import org.gradle.api.tasks.PathSensitive;
import org.gradle.api.tasks.PathSensitivity;
import org.gradle.work.Incremental;
import com.diffplug.gradle.spotless.JvmLocalCache.LiveCache;
import com.diffplug.spotless.FormatExceptionPolicy;
import com.diffplug.spotless.FormatExceptionPolicyStrict;
import com.diffplug.spotless.Formatter;
import com.diffplug.spotless.FormatterStep;
import com.diffplug.spotless.LineEnding;
import com.diffplug.spotless.extra.GitRatchet;
public abstract class SpotlessTask extends DefaultTask {
@Internal
abstract Property<SpotlessTaskService> getTaskService();
protected <T> LiveCache<T> createLive(String keyName) {
return JvmLocalCache.createLive(this, keyName);
}
// set by SpotlessExtension, but possibly overridden by FormatExtension
protected String encoding = "UTF-8";
@Input
public String getEncoding() {
return encoding;
}
public void setEncoding(String encoding) {
this.encoding = Objects.requireNonNull(encoding);
}
protected final LiveCache<LineEnding.Policy> lineEndingsPolicy = createLive("lineEndingsPolicy");
@Input
public LineEnding.Policy getLineEndingsPolicy() {
return lineEndingsPolicy.get();
}
public void setLineEndingsPolicy(LineEnding.Policy lineEndingsPolicy) {
this.lineEndingsPolicy.set(lineEndingsPolicy);
}
/** The sha of the tree at repository root, used for determining if an individual *file* is clean according to git. */
private transient ObjectId rootTreeSha;
/**
* The sha of the tree at the root of *this project*, used to determine if the git baseline has changed within this folder.
* Using a more fine-grained tree (rather than the project root) allows Gradle to mark more subprojects as up-to-date
* compared to using the project root.
*/
private transient ObjectId subtreeSha = ObjectId.zeroId();
/** Stored so that the configuration cache can recreate the GitRatchetGradle state. */
protected String ratchetFrom;
public void setupRatchet(String ratchetFrom) {
this.ratchetFrom = ratchetFrom;
if (!ratchetFrom.isEmpty()) {
GitRatchet ratchet = getTaskService().get().getRatchet();
File projectDir = getProjectDir().get().getAsFile();
rootTreeSha = ratchet.rootTreeShaOf(projectDir, ratchetFrom);
subtreeSha = ratchet.subtreeShaOf(projectDir, rootTreeSha);
} else {
subtreeSha = ObjectId.zeroId();
}
}
@Internal
abstract DirectoryProperty getProjectDir();
@Internal
GitRatchetGradle getRatchet() {
return ObjectId.zeroId().equals(getRatchetSha()) ? null : getTaskService().get().getRatchet();
}
@Internal
ObjectId getRootTreeSha() {
return rootTreeSha;
}
@Input
public ObjectId getRatchetSha() {
if (subtreeSha == null) {
setupRatchet(ratchetFrom);
}
return subtreeSha;
}
protected FormatExceptionPolicy exceptionPolicy = new FormatExceptionPolicyStrict();
public void setExceptionPolicy(FormatExceptionPolicy exceptionPolicy) {
this.exceptionPolicy = Objects.requireNonNull(exceptionPolicy);
}
@Input
public FormatExceptionPolicy getExceptionPolicy() {
return exceptionPolicy;
}
protected FileCollection target;
@PathSensitive(PathSensitivity.RELATIVE)
@Incremental
@InputFiles
public FileCollection getTarget() {
return target;
}
public void setTarget(Iterable<File> target) {
if (target instanceof FileCollection) {
this.target = (FileCollection) target;
} else {
this.target = getProject().files(target);
}
}
protected File outputDirectory = new File(getProject().getBuildDir(), "spotless/" + getName());
@OutputDirectory
public File getOutputDirectory() {
return outputDirectory;
}
protected final LiveCache<List<FormatterStep>> steps = createLive("steps");
{
steps.set(new ArrayList<FormatterStep>());
}
@Input
public List<FormatterStep> getSteps() {
return Collections.unmodifiableList(steps.get());
}
public void setSteps(List<FormatterStep> steps) {
this.steps.set(PluginGradlePreconditions.requireElementsNonNull(steps));
}
public boolean addStep(FormatterStep step) {
return this.steps.get().add(Objects.requireNonNull(step));
}
/** Returns the name of this format. */
String formatName() {
String name = getName();
if (name.startsWith(SpotlessExtension.EXTENSION)) {
return name.substring(SpotlessExtension.EXTENSION.length()).toLowerCase(Locale.ROOT);
} else {
return name;
}
}
Formatter buildFormatter() {
return Formatter.builder()
.lineEndingsPolicy(lineEndingsPolicy.get())
.encoding(Charset.forName(encoding))
.rootDir(getProjectDir().get().getAsFile().toPath())
.steps(steps.get())
.exceptionPolicy(exceptionPolicy)
.build();
}
}