Skip to content

Commit 0829854

Browse files
abashevabashev
committed
List the required IDEA plugin without palantir's library
The Gradle plugin applied palantir's gradle-idea-configuration for one thing: when IntelliJ syncs the project, list the open-java-format IDEA plugin in .idea/externalDependencies.xml, so that IntelliJ offers to install it. UpdateExternalDependenciesXmlFile does that now, the way the plugin already edits open-java-format.xml and workspace.xml, through XmlUtils and ConfigureJavaFormatterXml. As before it runs only when idea.active is set, keeps the other required plugins, and keeps a higher min-version for this one; versions compare numerically. Its task name differs from palantir's updateExternalDepsXml, so a build that applies that plugin as well gets both tasks rather than a clash. The plugin no longer creates the ideaConfiguration extension, and its dependencies lose gradle-idea-configuration. ConfigureJavaFormatterXmlTest covers the XML: a new file, other required plugins, and a min-version that is missing, lower, equal or higher. RequiredIdeaPluginTest runs a build without idea.active and one with it. It is a class of its own because PalantirJavaFormatIdeaPluginTest needs the native image and runs only in CI's native jobs; with -PnativeImage=true that one passes as well.
1 parent 2eaf6b8 commit 0829854

7 files changed

Lines changed: 200 additions & 20 deletions

File tree

‎gradle-open-java-format/build.gradle‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ dependencies {
2323
implementation libs.guava
2424
implementation project(':open-java-format-spi')
2525
implementation project(':open-java-format-jdk-bootstrap')
26-
implementation libs.ideaConfiguration.gradlePlugin
2726

2827
testImplementation project(':open-java-format')
2928
testImplementation libs.junit.jupiter

‎gradle-open-java-format/src/main/groovy/com/palantir/javaformat/gradle/ConfigureJavaFormatterXml.groovy‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616

1717
package com.palantir.javaformat.gradle
1818

19+
import java.lang.module.ModuleDescriptor
20+
1921
class ConfigureJavaFormatterXml {
2022

2123
static void configureJavaFormat(Node rootNode, List<URI> uris, Optional<URI> nativeImageUri) {
@@ -42,6 +44,17 @@ class ConfigureJavaFormatterXml {
4244
configureOptimizeOnSave(rootNode)
4345
}
4446

47+
// Lists an IDEA plugin as required by the project, so IntelliJ offers to install or update it. The other
48+
// required plugins stay, and so does a higher min-version for this one, such as a developer's own choice.
49+
static void configureExternalDependencies(Node rootNode, String pluginId, String minVersion) {
50+
def externalDependencies = matchOrCreateChild(rootNode, 'component', [name: 'ExternalDependencies'])
51+
def plugin = matchOrCreateChild(externalDependencies, 'plugin', [id: pluginId])
52+
def existing = plugin.attribute('min-version') as String
53+
if (existing == null || ModuleDescriptor.Version.parse(existing) < ModuleDescriptor.Version.parse(minVersion)) {
54+
plugin.attributes().put('min-version', minVersion)
55+
}
56+
}
57+
4558
private static void configureFormatOnSave(Node rootNode) {
4659
configureOnSaveAction(matchOrCreateChild(rootNode, 'component', [name: 'FormatOnSaveOptions']))
4760
}

‎gradle-open-java-format/src/main/groovy/com/palantir/javaformat/gradle/PalantirJavaFormatIdeaPlugin.java‎

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,7 @@
1818

1919
import com.google.common.base.Preconditions;
2020
import com.google.common.collect.ImmutableList;
21-
import com.palantir.gradle.ideaconfiguration.IdeaConfigurationExtension;
22-
import com.palantir.gradle.ideaconfiguration.IdeaConfigurationPlugin;
2321
import java.nio.file.Paths;
24-
import java.util.List;
2522
import java.util.Optional;
2623
import java.util.stream.Stream;
2724
import javax.inject.Inject;
@@ -82,23 +79,34 @@ public void apply(Project rootProject) {
8279
task.getOutputFile().set(rootProject.file(".idea/workspace.xml"));
8380
});
8481

85-
// Add the task to the Gradle start parameters so it executes automatically.
86-
StartParameter startParameter = rootProject.getGradle().getStartParameter();
87-
List<String> updateTasks = Stream.of(updateOpenJavaFormatXml, updateWorkspaceXml)
88-
.map(taskProvider -> String.format(":%s", taskProvider.getName()))
89-
.toList();
90-
List<String> taskNames = ImmutableList.<String>builder()
91-
.addAll(startParameter.getTaskNames())
92-
.addAll(updateTasks)
93-
.build();
94-
startParameter.setTaskNames(taskNames);
82+
runWithEveryBuild(rootProject, updateOpenJavaFormatXml, updateWorkspaceXml);
9583
});
9684

97-
rootProject.getPluginManager().apply(IdeaConfigurationPlugin.class);
98-
IdeaConfigurationExtension extension = rootProject.getExtensions().getByType(IdeaConfigurationExtension.class);
99-
extension
100-
.getExternalDependencies()
101-
.register("open-java-format", dep -> dep.atLeastVersion(MIN_IDEA_PLUGIN_VERSION));
85+
// IntelliJ's Gradle sync sets idea.active. The project then lists the open-java-format IDEA plugin as
86+
// required, and IntelliJ offers to install it.
87+
if (rootProject
88+
.getProviders()
89+
.systemProperty("idea.active")
90+
.map(Boolean::parseBoolean)
91+
.getOrElse(false)) {
92+
TaskProvider<UpdateExternalDependenciesXmlFile> updateExternalDependenciesXml = rootProject
93+
.getTasks()
94+
.register("updateExternalDependenciesXml", UpdateExternalDependenciesXmlFile.class, task -> {
95+
task.getPluginId().set("open-java-format");
96+
task.getMinVersion().set(MIN_IDEA_PLUGIN_VERSION);
97+
task.getOutputFile().set(rootProject.file(".idea/externalDependencies.xml"));
98+
});
99+
runWithEveryBuild(rootProject, updateExternalDependenciesXml);
100+
}
101+
}
102+
103+
// Adds the tasks to the Gradle start parameters, so they run with whatever the build was asked to do.
104+
private static void runWithEveryBuild(Project rootProject, TaskProvider<?>... tasks) {
105+
StartParameter startParameter = rootProject.getGradle().getStartParameter();
106+
startParameter.setTaskNames(ImmutableList.<String>builder()
107+
.addAll(startParameter.getTaskNames())
108+
.addAll(Stream.of(tasks).map(task -> ":" + task.getName()).toList())
109+
.build());
102110
}
103111

104112
private Optional<Configuration> maybeGetNativeImplConfiguration() {

‎gradle-open-java-format/src/main/groovy/com/palantir/javaformat/gradle/UpdateExternalDependenciesXmlFile.java‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
/*
2+
* (c) Copyright 2026 Palantir Technologies Inc. All rights reserved.
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+
17+
package com.palantir.javaformat.gradle;
18+
19+
import org.gradle.api.DefaultTask;
20+
import org.gradle.api.file.RegularFileProperty;
21+
import org.gradle.api.provider.Property;
22+
import org.gradle.api.tasks.Input;
23+
import org.gradle.api.tasks.Optional;
24+
import org.gradle.api.tasks.OutputFile;
25+
import org.gradle.api.tasks.TaskAction;
26+
import org.gradle.work.DisableCachingByDefault;
27+
28+
/** Lists an IDEA plugin in .idea/externalDependencies.xml, IntelliJ's "Required plugins". */
29+
@DisableCachingByDefault(
30+
because = "Edits the developer's local .idea/externalDependencies.xml in place; nothing to cache")
31+
public abstract class UpdateExternalDependenciesXmlFile extends DefaultTask {
32+
33+
@Input
34+
public abstract Property<String> getPluginId();
35+
36+
@Input
37+
public abstract Property<String> getMinVersion();
38+
39+
@Optional
40+
@OutputFile
41+
public abstract RegularFileProperty getOutputFile();
42+
43+
@TaskAction
44+
public final void updateXml() {
45+
XmlUtils.updateIdeaXmlFile(
46+
getOutputFile().getAsFile().get(),
47+
node -> ConfigureJavaFormatterXml.configureExternalDependencies(
48+
node, getPluginId().get(), getMinVersion().get()));
49+
}
50+
}

‎gradle-open-java-format/src/test/java/com/palantir/javaformat/gradle/ConfigureJavaFormatterXmlTest.java‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
import org.intellij.lang.annotations.Language;
3131
import org.junit.jupiter.api.Test;
3232
import org.junit.jupiter.params.ParameterizedTest;
33+
import org.junit.jupiter.params.provider.CsvSource;
3334
import org.junit.jupiter.params.provider.MethodSource;
3435

3536
class ConfigureJavaFormatterXmlTest {
@@ -281,6 +282,63 @@ void if_the_myRunOnSave_for_action_on_save_is_explicitly_disabled_turn_it_on(Str
281282
assertThat(newXml).isEqualTo(expected);
282283
}
283284

285+
@Test
286+
void lists_the_required_plugin_in_a_new_file() {
287+
Node node = parseXml("<project version=\"4\"/>");
288+
289+
ConfigureJavaFormatterXml.configureExternalDependencies(node, "open-java-format", "2.57.0");
290+
291+
assertThat(xmlToString(node)).isEqualTo("""
292+
<project version="4">
293+
<component name="ExternalDependencies">
294+
<plugin id="open-java-format" min-version="2.57.0"/>
295+
</component>
296+
</project>
297+
""");
298+
}
299+
300+
@Test
301+
void keeps_the_other_required_plugins() {
302+
Node node = parseXml("""
303+
<project version="4">
304+
<component name="ExternalDependencies">
305+
<plugin id="CheckStyle-IDEA" min-version="5.0"/>
306+
</component>
307+
</project>
308+
""");
309+
310+
ConfigureJavaFormatterXml.configureExternalDependencies(node, "open-java-format", "2.57.0");
311+
312+
assertThat(xmlToString(node)).isEqualTo("""
313+
<project version="4">
314+
<component name="ExternalDependencies">
315+
<plugin id="CheckStyle-IDEA" min-version="5.0"/>
316+
<plugin id="open-java-format" min-version="2.57.0"/>
317+
</component>
318+
</project>
319+
""");
320+
}
321+
322+
// An empty cell is a plugin listed without a min-version. 2.100.0 is higher than 2.57.0: versions compare
323+
// numerically, not as text.
324+
@CsvSource({", 2.57.0", "2.100.0, 2.100.0", "2.50.0, 2.57.0", "2.57.0, 2.57.0", "2.98.0.5, 2.98.0.5"})
325+
@ParameterizedTest
326+
void raises_a_lower_min_version_and_keeps_a_higher_one(String existing, String expected) {
327+
Node node = parseXml("""
328+
<project version="4">
329+
<component name="ExternalDependencies">
330+
<plugin id="open-java-format"%s/>
331+
</component>
332+
</project>
333+
""".formatted(existing == null ? "" : " min-version=\"" + existing + "\""));
334+
335+
ConfigureJavaFormatterXml.configureExternalDependencies(node, "open-java-format", "2.57.0");
336+
337+
assertThat(xmlToString(node))
338+
.contains("<plugin id=\"open-java-format\" min-version=\"" + expected + "\"/>")
339+
.containsOnlyOnce("<plugin ");
340+
}
341+
284342
private static Node parseXml(@Language("xml") String xml) {
285343
try {
286344
return new XmlParser().parseText(xml);

‎gradle-open-java-format/src/test/java/com/palantir/javaformat/gradle/RequiredIdeaPluginTest.java‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
/*
2+
* (c) Copyright 2026 Palantir Technologies Inc. All rights reserved.
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+
17+
package com.palantir.javaformat.gradle;
18+
19+
import static org.assertj.core.api.Assertions.assertThat;
20+
21+
import com.palantir.javaformat.gradle.testing.GradleTestProject;
22+
import java.nio.file.Path;
23+
import org.gradle.testkit.runner.BuildResult;
24+
import org.gradle.testkit.runner.BuildTask;
25+
import org.gradle.testkit.runner.TaskOutcome;
26+
import org.junit.jupiter.api.Test;
27+
import org.junit.jupiter.api.io.TempDir;
28+
29+
// Apart from PalantirJavaFormatIdeaPluginTest, which needs the native image and so runs in CI's native jobs only.
30+
final class RequiredIdeaPluginTest {
31+
32+
@TempDir
33+
private Path projectDir;
34+
35+
@Test
36+
void lists_the_idea_plugin_as_required_when_intellij_syncs() {
37+
GradleTestProject project = new GradleTestProject(projectDir).plugins("dev.openjavaformat.java-format-idea");
38+
39+
project.succeeds("help");
40+
41+
assertThat(project.file(".idea/externalDependencies.xml")).doesNotExist();
42+
43+
// IntelliJ's Gradle sync runs the build with idea.active set.
44+
BuildResult result = project.succeeds("help", "-Didea.active=true");
45+
46+
assertThat(result.task(":updateExternalDependenciesXml"))
47+
.isNotNull()
48+
.extracting(BuildTask::getOutcome)
49+
.isEqualTo(TaskOutcome.SUCCESS);
50+
assertThat(project.readFile(".idea/externalDependencies.xml"))
51+
.contains("<plugin id=\"open-java-format\" min-version=\"2.57.0\"/>");
52+
}
53+
}

‎gradle/libs.versions.toml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ derive4j-annotation = { module = "org.derive4j:derive4j-annotation", version = "
3131
functionaljava = { module = "org.functionaljava:functionaljava", version = "5.0" }
3232
guava = { module = "com.google.guava:guava", version = "33.7.1-jre" }
3333
guava-testlib = { module = "com.google.guava:guava-testlib", version = "33.5.0-jre" }
34-
ideaConfiguration-gradlePlugin = { module = "com.palantir.gradle.idea-configuration:gradle-idea-configuration", version = "0.11.0" }
3534
immutables-value = { module = "org.immutables:value", version = "2.12.2" }
3635
jackson-annotations = { module = "com.fasterxml.jackson.core:jackson-annotations", version = "2.22" }
3736
jackson-core = { module = "com.fasterxml.jackson.core:jackson-core", version = "2.22.3" }

0 commit comments

Comments
 (0)