comments

crogoz · crogoz · commit 0a9f08087841 · 2025-05-27T16:22:00.000+02:00
diff --git a/gradle-palantir-java-format/src/main/groovy/com/palantir/javaformat/gradle/NativeImageAtomicCopy.java b/gradle-palantir-java-format/src/main/groovy/com/palantir/javaformat/gradle/NativeImageAtomicCopy.java
@@ -16,6 +16,7 @@
 
 package com.palantir.javaformat.gradle;
 
+import java.io.File;
 import java.io.IOException;
 import java.net.URI;
 import java.nio.channels.FileChannel;
@@ -34,9 +35,9 @@ public class NativeImageAtomicCopy {
 
     private static Logger logger = Logging.getLogger(PalantirJavaFormatIdeaPlugin.class);
 
-    public static URI copyToCacheDir(URI srcUri) {
+    public static URI copyToCacheDir(URI srcUri, File cacheDir) {
         Path src = Paths.get(srcUri);
-        Path dst = getGradleCacheNativeImagesDir().resolve(src.getFileName());
+        Path dst = cacheDir.toPath().resolve(src.getFileName());
         if (Files.exists(dst)) {
             logger.info("Native image at path {} already exists", dst);
             return dst.toUri();
@@ -78,12 +79,6 @@ public static URI copyToCacheDir(URI srcUri) {
         }
     }
 
-    private static Path getGradleCacheNativeImagesDir() {
-        Path nativeImagesCacheDir = getGradleCacheDir().resolve("palantir-java-format-caches");
-        nativeImagesCacheDir.toFile().mkdirs();
-        return nativeImagesCacheDir;
-    }
-
     private static Path getGradleCacheDir() {
         return Path.of(Optional.ofNullable(System.getenv("GRADLE_USER_HOME"))
                 .orElseGet(() -> System.getenv("HOME") + "/.gradle"));
diff --git a/gradle-palantir-java-format/src/main/groovy/com/palantir/javaformat/gradle/PalantirJavaFormatIdeaPlugin.java b/gradle-palantir-java-format/src/main/groovy/com/palantir/javaformat/gradle/PalantirJavaFormatIdeaPlugin.java
@@ -45,20 +45,13 @@ public void apply(Project rootProject) {
                     .getTasks()
                     .register("updatePalantirJavaFormatXml", UpdatePalantirJavaFormatIdeaXmlFile.class, task -> {
                         task.getOutputFile().set(rootProject.file(".idea/palantir-java-format.xml"));
-                        task.getShouldCreateOutputIfAbsent().set(true);
-                    });
-
-            TaskProvider<UpdatePalantirJavaFormatIdeaXmlFile> updatePalantirJavaFormatIpr = rootProject
-                    .getTasks()
-                    .register("updatePalantirJavaFormatIpr", UpdatePalantirJavaFormatIdeaXmlFile.class, task -> {
-                        task.getOutputFile().set(rootProject.file(rootProject.getName() + ".ipr"));
-                        task.getShouldCreateOutputIfAbsent().set(false);
-                    });
-
-            rootProject
-                    .getTasks()
-                    .withType(UpdatePalantirJavaFormatIdeaXmlFile.class)
-                    .configureEach(task -> {
+                        task.getCacheDir()
+                                .set(rootProject
+                                        .getGradle()
+                                        .getGradleUserHomeDir()
+                                        .toPath()
+                                        .resolve("palantir-java-format-caches")
+                                        .toFile());
                         task.getImplementationConfig()
                                 .from(rootProject
                                         .getConfigurations()
@@ -71,23 +64,11 @@ public void apply(Project rootProject) {
                     .getTasks()
                     .register("updateWorkspaceXml", UpdateWorkspaceXmlFile.class, task -> {
                         task.getOutputFile().set(rootProject.file(".idea/workspace.xml"));
-                        task.getShouldCreateOutputIfAbsent().set(true);
-                    });
-
-            TaskProvider<UpdateWorkspaceXmlFile> updateWorkspaceIwsXml = rootProject
-                    .getTasks()
-                    .register("updateWorkspaceIwsXml", UpdateWorkspaceXmlFile.class, task -> {
-                        task.getOutputFile().set(rootProject.file(rootProject.getName() + ".iws"));
-                        task.getShouldCreateOutputIfAbsent().set(false);
                     });
 
             // Add the task to the Gradle start parameters so it executes automatically.
             StartParameter startParameter = rootProject.getGradle().getStartParameter();
-            List<String> updateTasks = Stream.of(
-                            updatePalantirJavaFormatXml,
-                            updatePalantirJavaFormatIpr,
-                            updateWorkspaceXml,
-                            updateWorkspaceIwsXml)
+            List<String> updateTasks = Stream.of(updatePalantirJavaFormatXml, updateWorkspaceXml)
                     .map(taskProvider -> String.format(":%s", taskProvider.getName()))
                     .toList();
             List<String> taskNames = ImmutableList.<String>builder()
diff --git a/gradle-palantir-java-format/src/main/groovy/com/palantir/javaformat/gradle/UpdatePalantirJavaFormatIdeaXmlFile.java b/gradle-palantir-java-format/src/main/groovy/com/palantir/javaformat/gradle/UpdatePalantirJavaFormatIdeaXmlFile.java
@@ -23,11 +23,10 @@
 import org.gradle.api.DefaultTask;
 import org.gradle.api.file.ConfigurableFileCollection;
 import org.gradle.api.file.RegularFileProperty;
-import org.gradle.api.provider.Property;
 import org.gradle.api.tasks.Classpath;
-import org.gradle.api.tasks.Input;
 import org.gradle.api.tasks.InputFiles;
 import org.gradle.api.tasks.Optional;
+import org.gradle.api.tasks.OutputDirectory;
 import org.gradle.api.tasks.OutputFile;
 import org.gradle.api.tasks.TaskAction;
 
@@ -45,8 +44,8 @@ public abstract class UpdatePalantirJavaFormatIdeaXmlFile extends DefaultTask {
     @OutputFile
     public abstract RegularFileProperty getOutputFile();
 
-    @Input
-    public abstract Property<Boolean> getShouldCreateOutputIfAbsent();
+    @OutputDirectory
+    public abstract RegularFileProperty getCacheDir();
 
     @TaskAction
     public final void updateXml() {
@@ -55,10 +54,10 @@ public final void updateXml() {
         java.util.Optional<URI> nativeUri = getNativeImageConfig().isEmpty()
                 ? java.util.Optional.empty()
                 : java.util.Optional.of(getNativeImageConfig().getSingleFile().toURI())
-                        .map(NativeImageAtomicCopy::copyToCacheDir);
+                        .map(uri -> NativeImageAtomicCopy.copyToCacheDir(
+                                uri, getCacheDir().getAsFile().get()));
         XmlUtils.updateIdeaXmlFile(
                 getOutputFile().getAsFile().get(),
-                node -> ConfigureJavaFormatterXml.configureJavaFormat(node, uris, nativeUri),
-                getShouldCreateOutputIfAbsent().get());
+                node -> ConfigureJavaFormatterXml.configureJavaFormat(node, uris, nativeUri));
     }
 }
diff --git a/gradle-palantir-java-format/src/main/groovy/com/palantir/javaformat/gradle/UpdateWorkspaceXmlFile.java b/gradle-palantir-java-format/src/main/groovy/com/palantir/javaformat/gradle/UpdateWorkspaceXmlFile.java
@@ -18,8 +18,6 @@
 
 import org.gradle.api.DefaultTask;
 import org.gradle.api.file.RegularFileProperty;
-import org.gradle.api.provider.Property;
-import org.gradle.api.tasks.Input;
 import org.gradle.api.tasks.Optional;
 import org.gradle.api.tasks.OutputFile;
 import org.gradle.api.tasks.TaskAction;
@@ -30,14 +28,8 @@ public abstract class UpdateWorkspaceXmlFile extends DefaultTask {
     @OutputFile
     public abstract RegularFileProperty getOutputFile();
 
-    @Input
-    public abstract Property<Boolean> getShouldCreateOutputIfAbsent();
-
     @TaskAction
     public final void updateXml() {
-        XmlUtils.updateIdeaXmlFile(
-                getOutputFile().getAsFile().get(),
-                ConfigureJavaFormatterXml::configureWorkspaceXml,
-                getShouldCreateOutputIfAbsent().get());
+        XmlUtils.updateIdeaXmlFile(getOutputFile().getAsFile().get(), ConfigureJavaFormatterXml::configureWorkspaceXml);
     }
 }
diff --git a/gradle-palantir-java-format/src/main/groovy/com/palantir/javaformat/gradle/XmlUtils.java b/gradle-palantir-java-format/src/main/groovy/com/palantir/javaformat/gradle/XmlUtils.java
@@ -32,7 +32,7 @@
 
 public class XmlUtils {
 
-    public static void updateIdeaXmlFile(File configurationFile, Consumer<Node> configure, boolean createIfAbsent) {
+    public static void updateIdeaXmlFile(File configurationFile, Consumer<Node> configure) {
         Node rootNode;
         if (configurationFile.isFile()) {
             try {
@@ -41,9 +41,6 @@ public static void updateIdeaXmlFile(File configurationFile, Consumer<Node> conf
                 throw new RuntimeException("Couldn't parse existing configuration file: " + configurationFile, e);
             }
         } else {
-            if (!createIfAbsent) {
-                return;
-            }
             rootNode = new Node(null, "project", ImmutableMap.of("version", "4"));
         }
 
diff --git a/gradle-palantir-java-format/src/test/groovy/com/palantir/javaformat/gradle/PalantirJavaFormatIdeaPluginTest.groovy b/gradle-palantir-java-format/src/test/groovy/com/palantir/javaformat/gradle/PalantirJavaFormatIdeaPluginTest.groovy
@@ -23,7 +23,7 @@ class PalantirJavaFormatIdeaPluginTest extends IntegrationTestKitSpec {
     private static final NATIVE_IMAGE_FILE = new File("build/nativeImage.path")
     private static final NATIVE_CONFIG = String.format("palantirJavaFormatNative files(\"%s\")", NATIVE_IMAGE_FILE.text)
 
-    def "idea_configuresIpr"() {
+    def "idea_configuresXmlFiles"() {
         file('gradle.properties') << extraGradleProperties
 
         buildFile << """
@@ -42,15 +42,24 @@ class PalantirJavaFormatIdeaPluginTest extends IntegrationTestKitSpec {
         runTasks('idea')
 
         then:
-        def iprFile = new File(projectDir, "${moduleName}.ipr")
-        def ipr = new XmlSlurper().parse(iprFile)
-        def settings = ipr.component.findAll { it.@name == "PalantirJavaFormatSettings" }
+        def pjfXmlFile = new File(projectDir, ".idea/palantir-java-format.xml")
+        def xmlContent = new XmlSlurper().parse(pjfXmlFile)
+        def settings = xmlContent.component.findAll { it.@name == "PalantirJavaFormatSettings" }
         !settings.isEmpty()
-        def implementationClassPathOption = ipr.component.option.find { it.@name == 'implementationClassPath' }
+        def implementationClassPathOption = xmlContent.component.option.find { it.@name == 'implementationClassPath' }
         !implementationClassPathOption.isEmpty()
-        def nativeImageClassPathOption = ipr.component.option.find { it.@name == 'nativeImageClassPath' }
+        def nativeImageClassPathOption = xmlContent.component.option.find { it.@name == 'nativeImageClassPath' }
         extraGradleProperties.contains("palantir.native.formatter=true") ? !nativeImageClassPathOption.isEmpty() : true
 
+        def workspaceXmlFile = new File(projectDir, ".idea/workspace.xml")
+        def workspaceContent = new XmlSlurper().parse(workspaceXmlFile)
+
+        def formatOnSave = workspaceContent.component.findAll { it.@name == "FormatOnSaveOptions" }
+        !formatOnSave.isEmpty()
+
+        def optimizeOnSave = workspaceContent.component.findAll { it.@name == "OptimizeOnSaveOptions" }
+        !formatOnSave.isEmpty()
+
         where:
         extraGradleProperties | extraDependencies
         "" | ""
