Improvement: Load palantir-java-format dynamically #989
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| type: improvement | ||
| improvement: | ||
| description: Load palantir-java-format dynamically from the same configuration set | ||
| up by `com.palantir-java-format` which is also used to determine the version used | ||
| by IntelliJ. | ||
| links: | ||
| - https://github.com/palantir/gradle-baseline/pull/989 |
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
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,90 @@ | ||
| /* | ||
| * (c) Copyright 2019 Palantir Technologies Inc. All rights reserved. | ||
| * | ||
| * 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.palantir.baseline.plugins.format; | ||
|
|
||
| import com.diffplug.spotless.FileSignature; | ||
| import com.diffplug.spotless.FormatterFunc; | ||
| import com.diffplug.spotless.FormatterStep; | ||
| import com.google.common.base.Suppliers; | ||
| import com.palantir.javaformat.gradle.JavaFormatExtension; | ||
| import com.palantir.javaformat.java.FormatterService; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.io.Serializable; | ||
| import java.util.function.Supplier; | ||
| import org.gradle.api.artifacts.Configuration; | ||
|
|
||
| public final class PalantirJavaFormatStep { | ||
|
|
||
| private static final String IMPL_CLASS = "com.palantir.javaformat.java.Formatter"; | ||
|
|
||
| private PalantirJavaFormatStep() {} | ||
|
|
||
| private static final String NAME = "palantir-java-format"; | ||
|
|
||
| /** Creates a step which formats everything - code, import order, and unused imports. */ | ||
| public static FormatterStep create(Configuration palantirJavaFormat, JavaFormatExtension extension) { | ||
| ensureImplementationNotDirectlyLoadable(); | ||
| Supplier<FormatterService> memoizedService = Suppliers.memoize(extension::serviceLoad); | ||
| return FormatterStep.createLazy( | ||
| NAME, () -> new State(palantirJavaFormat.getFiles(), memoizedService), State::createFormat); | ||
| } | ||
|
|
||
| static final class State implements Serializable { | ||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| // Kept for state serialization purposes. | ||
| @SuppressWarnings("unused") | ||
| private final String stepName = NAME; | ||
|
|
||
| // Kept for state serialization purposes. | ||
| @SuppressWarnings({"unused", "FieldCanBeLocal"}) | ||
| private final FileSignature jarsSignature; | ||
|
|
||
| // Transient as this is not serializable. | ||
| private final transient Supplier<FormatterService> memoizedFormatter; | ||
|
|
||
| /** | ||
| * Build a cacheable state for spotless from the given jars, that uses the given {@link FormatterService}. | ||
| * | ||
| * @param jars The jars that contain the palantir-java-format implementation. This is only used for caching and | ||
| * up-to-dateness purposes. | ||
| */ | ||
| State(Iterable<File> jars, Supplier<FormatterService> memoizedFormatter) throws IOException { | ||
| this.jarsSignature = FileSignature.signAsSet(jars); | ||
| this.memoizedFormatter = memoizedFormatter; | ||
| } | ||
|
|
||
| @SuppressWarnings("NullableProblems") | ||
| FormatterFunc createFormat() { | ||
| return memoizedFormatter.get()::formatSourceReflowStringsAndFixImports; | ||
| } | ||
| } | ||
|
|
||
| private static void ensureImplementationNotDirectlyLoadable() { | ||
| try { | ||
| PalantirJavaFormatStep.class.getClassLoader().loadClass(IMPL_CLASS); | ||
| } catch (ClassNotFoundException e) { | ||
| // expected | ||
| return; | ||
| } | ||
| throw new RuntimeException("Expected not be be able to load " | ||
| + IMPL_CLASS | ||
| + " via main class loader but was able to. Please ensure that `buildscript.configurations.classpath`" | ||
| + " doesn't depend on `com.palantir.javaformat:palantir-java-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
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I reformatted the whole file using the formatter so a few other things have changed, sorry!