Skip to content

Commit a23c9d2

Browse files
dansanduleacbulldozer-bot[bot]
authored andcommitted
Improvement: Better import from intellij (#120)
When importing a gradle project with `com.palantir.java-format-idea` from IntelliJ, eagerly configure the necessary XML files in `.idea` rather than relying on unwieldy IntelliJ task triggers.
1 parent 4cddeec commit a23c9d2

9 files changed

Lines changed: 74 additions & 178 deletions

File tree

‎.palantir/revapi.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
versionOverrides: {}
2+
acceptedBreaks:
3+
"0.3.9":
4+
com.palantir.javaformat:palantir-java-format-spi: []
5+
com.palantir.javaformat:gradle-palantir-java-format:
6+
- code: "java.class.removed"
7+
old: "class com.palantir.javaformat.gradle.ConfigureExternalDependenciesXml"
8+
new: null
9+
justification: "nobody used this directly"
10+
- code: "java.class.removed"
11+
old: "class com.palantir.javaformat.gradle.ConfigurePalantirJavaFormatXml"
12+
new: null
13+
justification: "nobody used this directly"
14+
- code: "java.class.removed"
15+
old: "class com.palantir.javaformat.gradle.UpdateIntellijXmlTask"
16+
new: null
17+
justification: "nobody used this directly"
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
type: improvement
2+
improvement:
3+
description: When importing a gradle project with `com.palantir.java-format-idea`
4+
from IntelliJ, eagerly configure the necessary XML files in `.idea` rather than
5+
relying on unwieldy IntelliJ task triggers.
6+
links:
7+
- https://github.com/palantir/palantir-java-format/pull/120

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ configurations {
1111
dependencies {
1212
implementation gradleApi()
1313
implementation 'com.google.guava:guava'
14-
implementation 'gradle.plugin.org.jetbrains.gradle.plugin.idea-ext:gradle-idea-ext'
1514
implementation project(':palantir-java-format-spi')
1615

1716
testImplementation 'com.netflix.nebula:nebula-test'
@@ -36,12 +35,12 @@ gradlePlugin {
3635
palantirJavaFormat {
3736
id = 'com.palantir.java-format'
3837
implementationClass = 'com.palantir.javaformat.gradle.PalantirJavaFormatPlugin'
39-
description = 'A modern, lambda-friendly, 120 character Java formatter. Applies all other palantir-java-format plugins.'
38+
description = 'A modern, lambda-friendly, 120 character Java formatter. Applies all other ' + 'palantir-java-format plugins.'
4039
}
4140
palantirJavaFormatIdea {
4241
id = 'com.palantir.java-format-idea'
4342
implementationClass = 'com.palantir.javaformat.gradle.PalantirJavaFormatIdeaPlugin'
44-
description = 'Plugin to configure the PalantirJavaFormat IDEA plugin based on an optional implementation version of the formatter.'
43+
description = 'Plugin to configure the PalantirJavaFormat IDEA plugin based on an optional implementation' + ' version of the formatter.'
4544
}
4645
palantirJavaFormatSpotless {
4746
id = 'com.palantir.java-format-spotless'

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

Lines changed: 0 additions & 30 deletions
This file was deleted.

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

Lines changed: 0 additions & 45 deletions
This file was deleted.

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

Lines changed: 47 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,26 @@
1717
package com.palantir.javaformat.gradle;
1818

1919
import com.google.common.base.Preconditions;
20+
import com.google.common.collect.ImmutableMap;
21+
import com.google.common.io.Files;
22+
import groovy.util.Node;
23+
import groovy.util.XmlNodePrinter;
24+
import groovy.util.XmlParser;
25+
import java.io.BufferedWriter;
2026
import java.io.File;
27+
import java.io.IOException;
28+
import java.io.PrintWriter;
2129
import java.net.URI;
30+
import java.nio.charset.Charset;
2231
import java.util.List;
32+
import java.util.function.Consumer;
2333
import java.util.stream.Collectors;
34+
import javax.xml.parsers.ParserConfigurationException;
2435
import org.gradle.api.Plugin;
2536
import org.gradle.api.Project;
26-
import org.gradle.api.Task;
2737
import org.gradle.api.artifacts.Configuration;
28-
import org.gradle.api.plugins.ExtensionAware;
29-
import org.gradle.api.provider.Provider;
3038
import org.gradle.plugins.ide.idea.model.IdeaModel;
31-
import org.jetbrains.gradle.ext.TaskTriggersConfig;
39+
import org.xml.sax.SAXException;
3240

3341
public final class PalantirJavaFormatIdeaPlugin implements Plugin<Project> {
3442

@@ -60,25 +68,44 @@ private static void configureLegacyIdea(Project project, Configuration implConfi
6068
}
6169

6270
private static void configureIntelliJImport(Project project, Configuration implConfiguration) {
63-
project.getPluginManager().apply("org.jetbrains.gradle.plugin.idea-ext");
71+
// Note: we tried using 'org.jetbrains.gradle.plugin.idea-ext' and afterSync triggers, but these are currently
72+
// very hard to manage as the tasks feel disconnected from the Sync operation, and you can't remove them once
73+
// you've added them. For that reason, we accept that we have to resolve this configuration at
74+
// configuration-time, but only do it when part of an IDEA import.
75+
if (!Boolean.getBoolean("idea.active")) {
76+
return;
77+
}
78+
project.getGradle().projectsEvaluated(gradle -> {
79+
List<URI> uris = implConfiguration.getFiles().stream().map(File::toURI).collect(Collectors.toList());
6480

65-
Provider<? extends Task> configurePalantirJavaFormatXmlTask = project.getTasks()
66-
.register("configurePalantirJavaFormatXml", ConfigurePalantirJavaFormatXml.class, task -> {
67-
task.getImplConfiguration().set(implConfiguration);
68-
});
81+
createOrUpdateIdeaXmlFile(project.file(".idea/palantir-java-format.xml"), node ->
82+
ConfigureJavaFormatterXml.configureJavaFormat(node, uris));
83+
createOrUpdateIdeaXmlFile(project.file(".idea/externalDependencies.xml"), node ->
84+
ConfigureJavaFormatterXml.configureExternalDependencies(node));
85+
});
86+
}
6987

70-
Provider<? extends Task> configurePalantirJavaFormatPluginDependencyXml = project.getTasks()
71-
.register("configurePalantirJavaFormatPluginDependencyXml", ConfigureExternalDependenciesXml.class);
88+
private static void createOrUpdateIdeaXmlFile(File configurationFile, Consumer<Node> configure) {
89+
Node rootNode;
90+
if (configurationFile.isFile()) {
91+
try {
92+
rootNode = new XmlParser().parse(configurationFile);
93+
} catch (IOException | SAXException | ParserConfigurationException e) {
94+
throw new RuntimeException("Couldn't parse existing configuration file: " + configurationFile, e);
95+
}
96+
} else {
97+
rootNode = new Node(null, "project", ImmutableMap.of("version", "4"));
98+
}
7299

73-
Task palantirJavaFormatIntellij = project.getTasks().create("palantirJavaFormatIntellij", task -> {
74-
task.setDescription("Configure IntelliJ directory-based repository after importing");
75-
task.setGroup(UpdateIntellijXmlTask.INTELLIJ_TASK_GROUP);
76-
task.dependsOn(configurePalantirJavaFormatXmlTask, configurePalantirJavaFormatPluginDependencyXml);
77-
});
100+
configure.accept(rootNode);
78101

79-
ExtensionAware ideaProject = (ExtensionAware) project.getExtensions().getByType(IdeaModel.class).getProject();
80-
ExtensionAware settings = (ExtensionAware) ideaProject.getExtensions().getByName("settings");
81-
TaskTriggersConfig taskTriggers = settings.getExtensions().getByType(TaskTriggersConfig.class);
82-
taskTriggers.beforeSync(palantirJavaFormatIntellij);
102+
try (BufferedWriter writer = Files.newWriter(configurationFile, Charset.defaultCharset());
103+
PrintWriter printWriter = new PrintWriter(writer)) {
104+
XmlNodePrinter nodePrinter = new XmlNodePrinter(printWriter);
105+
nodePrinter.setPreserveWhitespace(true);
106+
nodePrinter.print(rootNode);
107+
} catch (IOException e) {
108+
throw new RuntimeException("Failed to write back to configuration file: " + configurationFile, e);
109+
}
83110
}
84111
}

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

Lines changed: 0 additions & 76 deletions
This file was deleted.

‎versions.lock‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,16 @@ com.google.auto:auto-common:0.10 (2 constraints: 29219941)
1414
com.google.auto.service:auto-service:1.0-rc6 (1 constraints: dd05b441)
1515
com.google.auto.service:auto-service-annotations:1.0-rc6 (1 constraints: 741058a7)
1616
com.google.code.findbugs:jsr305:3.0.2 (3 constraints: 571ca3f6)
17-
com.google.code.gson:gson:2.8.2 (1 constraints: b61a7239)
1817
com.google.errorprone:error_prone_annotations:2.3.4 (4 constraints: b626aa1f)
1918
com.google.errorprone:javac-shaded:9+181-r4173-1 (1 constraints: e0067767)
2019
com.google.guava:failureaccess:1.0.1 (1 constraints: 140ae1b4)
21-
com.google.guava:guava:27.0.1-jre (8 constraints: 2b7e42c3)
20+
com.google.guava:guava:27.0.1-jre (7 constraints: 3a621748)
2221
com.google.guava:listenablefuture:9999.0-empty-to-avoid-conflict-with-guava (1 constraints: bd17c918)
2322
com.google.j2objc:j2objc-annotations:1.1 (2 constraints: 8f167910)
2423
com.googlecode.concurrent-trees:concurrent-trees:2.6.1 (1 constraints: 761166da)
2524
com.googlecode.javaewah:JavaEWAH:1.1.6 (1 constraints: 480e7e50)
2625
com.jcraft:jsch:0.1.55 (1 constraints: 7b0ef35e)
2726
com.jcraft:jzlib:1.1.1 (1 constraints: 430e7950)
28-
gradle.plugin.org.jetbrains.gradle.plugin.idea-ext:gradle-idea-ext:0.7 (1 constraints: ab041e2c)
2927
org.bouncycastle:bcpg-jdk15on:1.61 (1 constraints: 1a0e4342)
3028
org.bouncycastle:bcpkix-jdk15on:1.61 (1 constraints: 1a0e4342)
3129
org.bouncycastle:bcprov-jdk15on:1.61 (3 constraints: e327dc7a)

‎versions.props‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ com.google.guava:guava-testlib = 27.0.1-jre
99
com.google.testing.compile:compile-testing = 0.15
1010
com.google.truth:truth = 1.0
1111
com.netflix.nebula:nebula-test = 7.6.0
12-
gradle.plugin.org.jetbrains.gradle.plugin.idea-ext:gradle-idea-ext = 0.7
1312
junit:junit = 4.13
1413
org.assertj:assertj-core = 3.14.0
1514
org.derive4j:* = 1.1.1

0 commit comments

Comments
 (0)