feat: configurations for Spotless Gradle daemon version and jar (#129)

Author: ghostflyby

.idea/.gitignore

@@ -6,6 +6,9 @@
 
 ### Added
 
+- configuration options for Spotless Gradle daemon version and
+  jar [#127](https://github.com/ghostflyby/IntelliJ-Plugins/pull/127)
+
 ### Changed
 
 ### Deprecated
@@ -34,5 +37,7 @@
 - Support for automatic code formatting using Spotless.
 
 [Unreleased]: https://github.com/ghostflyby/IntelliJ-Plugins/compare/v0.1.1...HEAD
+
 [0.1.1]: https://github.com/ghostflyby/IntelliJ-Plugins/compare/v0.0.1...v0.1.1
+
 [0.0.1]: https://github.com/ghostflyby/IntelliJ-Plugins/commits/v0.0.1

.idea/scopes/spellcheck.xml

@@ -28,7 +28,7 @@ plugins {
     id("repo.intellij-plugin")
 }
 
-version = "0.1.1"
+version = "0.2.0"
 
 buildLogic {
     pluginVersion = version.toString()

plugins/SpotlessIntegration/CHANGELOG.md

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2025 ghostflyby
+ * SPDX-FileCopyrightText: 2025 ghostflyby
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ *
+ * This file is part of IntelliJ-Plugins by ghostflyby
+ *
+ * IntelliJ-Plugins by ghostflyby is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3.0 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see
+ * <https://www.gnu.org/licenses/>.
+ */
+
+package dev.ghostflyby.spotless.gradle
+
+import com.intellij.openapi.components.service
+import com.intellij.openapi.fileChooser.FileChooserDescriptorFactory
+import com.intellij.openapi.options.BoundConfigurable
+import com.intellij.openapi.project.Project
+import com.intellij.ui.dsl.builder.bindText
+import com.intellij.ui.dsl.builder.panel
+import dev.ghostflyby.spotless.Bundle
+
+internal class SpotlessGradleConfigurable(private val project: Project) :
+    BoundConfigurable(Bundle.message("spotless.configuration.title.workspace")) {
+
+    private val settings = project.service<SpotlessGradleStateHolder>()
+
+    override fun createPanel() = panel {
+        row(Bundle.message("spotless.configuration.daemonVersion.label")) {
+            textField()
+                .bindText(settings::gradleDaemonVersion)
+                .comment(Bundle.message("spotless.configuration.daemonVersion.comment"))
+        }
+        row(Bundle.message("spotless.configuration.daemonJar.label")) {
+            @Suppress("UnstableApiUsage")
+            textFieldWithBrowseButton(
+                project = project,
+                fileChooserDescriptor = FileChooserDescriptorFactory.singleFile()
+                    .withTitle(Bundle.message("spotless.configuration.daemonJar.title")),
+            )
+                .bindText(settings::gradleDaemonJar)
+                .comment(Bundle.message("spotless.configuration.daemonJar.comment"))
+        }
+    }
+}

plugins/SpotlessIntegration/build.gradle.kts

@@ -25,6 +25,7 @@ package dev.ghostflyby.spotless.gradle
 import com.intellij.openapi.components.service
 import com.intellij.openapi.externalSystem.model.task.ExternalSystemTaskId
 import org.gradle.util.GradleVersion
+import org.jetbrains.plugins.gradle.service.execution.toGroovyStringLiteral
 import org.jetbrains.plugins.gradle.service.task.GradleTaskManagerExtension
 import org.jetbrains.plugins.gradle.settings.GradleExecutionSettings
 import kotlin.io.path.Path
@@ -38,25 +39,37 @@ internal class SpotlessGradleTaskManagerExtension : GradleTaskManagerExtension {
         gradleVersion: GradleVersion?,
     ) {
         id.project.service<SpotlessGradleStateHolder>().isSpotlessEnabledForProjectDir(Path(projectPath)) || return
-        settings.addInitScript(
-            "dev.ghostflyby.spotless.daemon",
-            @Suppress("SpellCheckingInspection")
-            """
+        val persistent = id.project.service<SpotlessGradleStateHolder>()
+        val daemonVersion = persistent.gradleDaemonVersion.trim()
+        val daemonJar = persistent.gradleDaemonJar.trim()
+
+        val s = @Suppress("SpellCheckingInspection")
+        $$"""
             gradle.allprojects { proj ->
                 proj.buildscript {
                     repositories {
                         gradlePluginPortal()
                     }
                     dependencies {
-                        classpath "dev.ghostflyby.spotless.daemon:dev.ghostflyby.spotless.daemon.gradle.plugin:0.4.0"
+                        def daemonJar = $${daemonJar.toGroovyStringLiteral()}
+                        def daemonVersion = $${daemonVersion.toGroovyStringLiteral()}
+                        if (daemonJar) {
+                            classpath files(daemonJar)
+                        } else {
+                            def resolved = daemonVersion ? daemonVersion : '0.4.0'
+                            classpath "dev.ghostflyby.spotless.daemon:dev.ghostflyby.spotless.daemon.gradle.plugin:$resolved"
+                        }
                     }
                 }
 
                 proj.pluginManager.withPlugin("com.diffplug.spotless") {
                     proj.apply plugin: "dev.ghostflyby.spotless.daemon"
                 }
             }
-        """.trimIndent(),
+        """.trimIndent()
+        settings.addInitScript(
+            "dev.ghostflyby.spotless.daemon",
+            s
         )
     }
 }

plugins/SpotlessIntegration/src/main/kotlin/dev/ghostflyby/spotless/gradle/SpotlessGradleConfigurable.kt

@@ -39,6 +39,7 @@ import com.intellij.openapi.externalSystem.service.project.manage.AbstractProjec
 import com.intellij.openapi.externalSystem.util.ExternalSystemUtil
 import com.intellij.openapi.externalSystem.util.task.TaskExecutionSpec
 import com.intellij.openapi.util.Disposer
+import com.intellij.openapi.util.NlsSafe
 import dev.ghostflyby.spotless.Spotless
 import dev.ghostflyby.spotless.SpotlessDaemonHost
 import org.gradle.api.Project
@@ -119,17 +120,17 @@ internal class SpotlessGradleStateDataService : AbstractProjectDataService<Spotl
     storages = [Storage(StoragePathMacros.WORKSPACE_FILE, roamingType = RoamingType.DISABLED)],
 )
 internal class SpotlessGradleStateHolder
-    : SerializablePersistentStateComponent<SpotlessGradleStateHolder.PathsState>(PathsState()) {
+    : SerializablePersistentStateComponent<SpotlessGradleStateHolder.State>(State()) {
     fun isSpotlessEnabledForProjectDir(path: Path): Boolean {
         return state.paths.contains(path.absolutePathString())
     }
 
     val daemons = mutableListOf<SpotlessDaemonHost>()
 
     fun updateFrom(nodes: Collection<DataNode<SpotlessGradleStateData>>) {
-        updateState {
-            PathsState(
-                nodes.asSequence()
+        updateState { state ->
+            state.copy(
+                paths = nodes.asSequence()
                     .filter { it.data.spotless }
                     .map { it.data.projectDirectory.absolutePathString() }
                     .toSet(),
@@ -140,8 +141,22 @@ internal class SpotlessGradleStateHolder
         daemons.clear()
     }
 
-    internal data class PathsState(
+    var gradleDaemonVersion: @NlsSafe String
+        get() = state.gradleDaemonVersion
+        set(value) {
+            state = state.copy(gradleDaemonVersion = value)
+        }
+
+    var gradleDaemonJar: @NlsSafe String
+        get() = state.gradleDaemonJar
+        set(value) {
+            state = state.copy(gradleDaemonJar = value)
+        }
+
+    internal data class State(
         @JvmField val paths: Set<String> = emptySet(),
+        @JvmField val gradleDaemonVersion: String = "",
+        @JvmField val gradleDaemonJar: String = "",
     )
 }
 

plugins/SpotlessIntegration/src/main/kotlin/dev/ghostflyby/spotless/gradle/SpotlessGradleTaskManagerExtension.kt

@@ -13,6 +13,10 @@
         <!--        <checkinHandlerFactory implementation="dev.ghostflyby.spotless.SpotlessCommitHandlerFactory"/>-->
         <formattingService implementation="dev.ghostflyby.spotless.SpotlessFormatingService"/>
         <!--        <fileEncodingProvider implementation="dev.ghostflyby.spotless.SpotlessFileEncodingProvider"/>-->
+        <projectConfigurable bundle="messages.Bundle" id="dev.ghostflyby.spotless.workspace"
+                             instance="dev.ghostflyby.spotless.gradle.SpotlessGradleConfigurable"
+                             key="spotless.configuration.title.workspace"
+                             parentId="build"/>
     </extensions>
 
     <extensionPoints>

plugins/SpotlessIntegration/src/main/kotlin/dev/ghostflyby/spotless/gradle/ToolingExtension.kt

@@ -1,3 +1,9 @@
 # SPDX-FileCopyrightText: 2025 ghostflyby
 # SPDX-License-Identifier: LGPL-3.0-or-later
-spotless.format.notification.error.title=Spotless Formatting Error
+spotless.format.notification.error.title=Spotless Formatting Error
+spotless.configuration.title.workspace=Spotless Integration
+spotless.configuration.daemonVersion.label=Gradle Spotless daemon version override
+spotless.configuration.daemonVersion.comment=Leave blank to use the bundled daemon plugin version.
+spotless.configuration.daemonJar.label=Local daemon plugin jar
+spotless.configuration.daemonJar.title=Select Spotless daemon plugin jar
+spotless.configuration.daemonJar.comment=Absolute path to dev.ghostflyby.spotless.daemon Gradle plugin jar; overrides the version when set.

plugins/SpotlessIntegration/src/main/resources/META-INF/plugin.xml

@@ -1,3 +1,9 @@
 # SPDX-FileCopyrightText: 2025 ghostflyby
 # SPDX-License-Identifier: LGPL-3.0-or-later
-spotless.format.notification.error.title=Spotless格式化错误
+spotless.format.notification.error.title=Spotless格式化错误
+spotless.configuration.title.workspace=Spotless集成
+spotless.configuration.daemonVersion.label=Gradle Spotless daemon版本覆盖
+spotless.configuration.daemonVersion.comment=留空以使用插件内置版本。
+spotless.configuration.daemonJar.label=本地daemon插件jar
+spotless.configuration.daemonJar.title=选择Spotless daemon插件jar
+spotless.configuration.daemonJar.comment=dev.ghostflyby.spotless.daemon Gradle插件jar的绝对路径；填写后优先生效。