-
Notifications
You must be signed in to change notification settings - Fork 449
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
463 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,7 @@ def special = [ | |
| 'Black', | ||
| 'Buf', | ||
| 'Clang', | ||
| 'gofmt', | ||
| 'Npm', | ||
| 'Shfmt' | ||
| ] | ||
|
|
||
111 changes: 111 additions & 0 deletions
111
lib/src/main/java/com/diffplug/spotless/go/GofmtFormatStep.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| /* | ||
| * Copyright 2024 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.go; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.io.Serializable; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.nio.file.Path; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
|
|
||
| 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; | ||
|
|
||
| /** | ||
| * Note: gofmt doesn't have a version flag, because it's part of standard Go distribution. | ||
| * So `go` executable can be used to determine base path and version, and path to gofmt can be built from it. | ||
| */ | ||
| public class GofmtFormatStep { | ||
| public static String name() { | ||
| return "gofmt"; | ||
| } | ||
|
|
||
| public static String defaultVersion() { | ||
| return "go1.20.0"; | ||
| } | ||
|
|
||
| private final String version; | ||
| private final @Nullable String pathToExe; | ||
|
|
||
| private GofmtFormatStep(String version, String pathToExe) { | ||
| this.version = version; | ||
| this.pathToExe = pathToExe; | ||
| } | ||
|
|
||
| public static GofmtFormatStep withVersion(String version) { | ||
| return new GofmtFormatStep(version, null); | ||
| } | ||
|
|
||
| public GofmtFormatStep withGoExecutable(String pathToExe) { | ||
| return new GofmtFormatStep(version, pathToExe); | ||
| } | ||
|
|
||
| public FormatterStep create() { | ||
| return FormatterStep.createLazy(name(), this::createState, GofmtFormatStep.State::toFunc); | ||
| } | ||
|
|
||
| private State createState() throws IOException, InterruptedException { | ||
| String howToInstall = "gofmt is a part of standard go distribution. If spotless can't discover it automatically, " + | ||
| "you can point Spotless to the go binary with {@code pathToExe('/path/to/go')}"; | ||
| final ForeignExe exe = ForeignExe.nameAndVersion("go", version) | ||
| .pathToExe(pathToExe) | ||
| .versionFlag("version") | ||
| .fixCantFind(howToInstall) | ||
| .fixWrongVersion( | ||
| "You can tell Spotless to use the version you already have with {@code gofmt('{versionFound}')}" + | ||
| "or you can install the currently specified Go version, {version}.\n" + howToInstall); | ||
| return new State(this, exe); | ||
| } | ||
|
|
||
| @SuppressFBWarnings("SE_TRANSIENT_FIELD_NOT_RESTORED") | ||
| static class State implements Serializable { | ||
| private static final long serialVersionUID = -1825662355363926318L; | ||
| // used for up-to-date checks and caching | ||
| final String version; | ||
| final transient ForeignExe exe; | ||
|
|
||
| public State(GofmtFormatStep step, ForeignExe goExecutable) { | ||
| this.version = step.version; | ||
| this.exe = Objects.requireNonNull(goExecutable); | ||
| } | ||
|
|
||
| String format(ProcessRunner runner, String input, File file) throws IOException, InterruptedException { | ||
| final List<String> processArgs = new ArrayList<>(); | ||
| String pathToGoBinary = exe.confirmVersionAndGetAbsolutePath(); | ||
| Path goBasePath = Path.of(pathToGoBinary).getParent(); | ||
| if (goBasePath == null) { | ||
| throw new IllegalStateException("Unable to resolve base path of Go installation directory"); | ||
| } | ||
| String pathToGoFmt = goBasePath.resolve("gofmt").toString(); | ||
| processArgs.add(pathToGoFmt); | ||
| return runner.exec(input.getBytes(StandardCharsets.UTF_8), processArgs).assertExitZero(StandardCharsets.UTF_8); | ||
| } | ||
|
|
||
| FormatterFunc.Closeable toFunc() { | ||
| ProcessRunner runner = new ProcessRunner(); | ||
| return FormatterFunc.Closeable.of(runner, this::format); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
57 changes: 57 additions & 0 deletions
57
plugin-gradle/src/main/java/com/diffplug/gradle/spotless/GoExtension.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /* | ||
| * Copyright 2024 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 javax.inject.Inject; | ||
|
|
||
| import com.diffplug.spotless.FormatterStep; | ||
| import com.diffplug.spotless.go.GofmtFormatStep; | ||
|
|
||
| public class GoExtension extends FormatExtension { | ||
| public static final String NAME = "go"; | ||
|
|
||
| @Inject | ||
| public GoExtension(SpotlessExtension spotless) { | ||
| super(spotless); | ||
| } | ||
|
|
||
| public GofmtConfig gofmt() { | ||
| return new GofmtConfig(GofmtFormatStep.defaultVersion()); | ||
| } | ||
|
|
||
| public GofmtConfig gofmt(String version) { | ||
| return new GofmtConfig(version); | ||
| } | ||
|
|
||
| public class GofmtConfig { | ||
| GofmtFormatStep stepCfg; | ||
|
|
||
| public GofmtConfig(String version) { | ||
| stepCfg = GofmtFormatStep.withVersion(version); | ||
| addStep(createStep()); | ||
| } | ||
|
|
||
| public GofmtConfig withGoExecutable(String pathToGo) { | ||
| stepCfg = stepCfg.withGoExecutable(pathToGo); | ||
| replaceStep(createStep()); | ||
| return this; | ||
| } | ||
|
|
||
| private FormatterStep createStep() { | ||
| return stepCfg.create(); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
plugin-gradle/src/test/java/com/diffplug/gradle/spotless/GoGradleTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /* | ||
| * Copyright 2020-2024 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.IOException; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import com.diffplug.spotless.tag.GofmtTest; | ||
|
|
||
| @GofmtTest | ||
| class GoGradleTest extends GradleIntegrationHarness { | ||
| @Test | ||
| void gofmt() throws IOException { | ||
| setFile("build.gradle").toLines( | ||
| "plugins {", | ||
| " id 'com.diffplug.spotless'", | ||
| "}", | ||
| "spotless {", | ||
| " go {", | ||
| " target 'src/**/*.go'", | ||
| " gofmt(\"go1.21.5\")", | ||
| " }", | ||
| "}"); | ||
| setFile("src/test.go").toResource("go/gofmt/go.dirty"); | ||
| gradleRunner().withArguments("spotlessApply").build(); | ||
| assertFile("src/test.go").sameAsResource("go/gofmt/go.clean"); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
39 changes: 39 additions & 0 deletions
39
plugin-maven/src/main/java/com/diffplug/spotless/maven/go/Go.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| /* | ||
| * Copyright 2024 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.go; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.Set; | ||
|
|
||
| import org.apache.maven.project.MavenProject; | ||
|
|
||
| import com.diffplug.spotless.maven.FormatterFactory; | ||
|
|
||
| public class Go extends FormatterFactory { | ||
| @Override | ||
| public Set<String> defaultIncludes(MavenProject project) { | ||
| return Collections.emptySet(); | ||
| } | ||
|
|
||
| @Override | ||
| public String licenseHeaderDelimiter() { | ||
| return null; | ||
| } | ||
|
|
||
| public void addGofmt(Gofmt gofmt) { | ||
| addStepFactory(gofmt); | ||
| } | ||
| } |
Oops, something went wrong.