feat: migrate to IntelliJ Platform Gradle Plugin

biomejs · Aug 15, 2024 · 2929750 · 2929750
1 parent 223fb0b
commit 2929750
Show file tree

Hide file tree

Showing 8 changed files with 122 additions and 78 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 .gradle
 .idea
+.intellijPlatform
 .qodana
 build
 .DS_Store

diff --git a/.run/Run Verifications.run.xml b/.run/Run Verifications.run.xml
@@ -1,27 +1,25 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run Verifications" type="GradleRunConfiguration" factoryName="Gradle">
-    <log_file alias="idea.log" path="$PROJECT_DIR$/build/idea-sandbox/system/log/idea.log"/>
+    <log_file alias="idea.log" path="$PROJECT_DIR$/build/idea-sandbox/system/log/idea.log" />
     <ExternalSystemSettings>
-      <option name="executionName"/>
-      <option name="externalProjectPath" value="$PROJECT_DIR$"/>
-      <option name="externalSystemIdString" value="GRADLE"/>
-      <option name="scriptParameters" value=""/>
+      <option name="executionName" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$" />
+      <option name="externalSystemIdString" value="GRADLE" />
+      <option name="scriptParameters" value="" />
       <option name="taskDescriptions">
-        <list/>
+        <list />
       </option>
       <option name="taskNames">
         <list>
-          <option value="runPluginVerifier"/>
+          <option value="verifyPlugin" />
         </list>
       </option>
-      <option name="vmOptions" value=""/>
+      <option name="vmOptions" value="" />
     </ExternalSystemSettings>
     <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
     <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
     <DebugAllEnabled>false</DebugAllEnabled>
-    <method v="2">
-      <option name="Gradle.BeforeRunTask" enabled="true" tasks="clean" externalProjectPath="$PROJECT_DIR$" vmOptions=""
-              scriptParameters=""/>
-    </method>
+    <RunAsTest>false</RunAsTest>
+    <method v="2" />
   </configuration>
-</component>
+</component>
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,22 +1,34 @@
-import java.net.URI
+import org.jetbrains.intellij.platform.gradle.TestFrameworkType
 
 fun properties(key: String) = providers.gradleProperty(key)
 fun environment(key: String) = providers.environmentVariable(key)
 val remoteRobotVersion = "0.11.21"
 
+group = properties("pluginGroup").get()
+version = properties("pluginVersion").get()
+
 plugins {
   id("java") // Java support
   alias(libs.plugins.kotlin) // Kotlin support
-  alias(libs.plugins.gradleIntelliJPlugin) // Gradle IntelliJ Plugin
+  alias(libs.plugins.intelliJPlatform) // IntelliJ Platform Gradle Plugin
 }
 
 group = properties("pluginGroup").get()
 version = properties("pluginVersion").get()
 
+// Set the JVM language level used to build the project.
+kotlin {
+  jvmToolchain(17)
+}
+
 // Configure project's dependencies
 repositories {
   mavenCentral()
-  maven { url = URI("https://packages.jetbrains.team/maven/p/ij/intellij-dependencies") }
+
+  // IntelliJ Platform Gradle Plugin Repositories Extension - read more: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-repositories-extension.html
+  intellijPlatform {
+    defaultRepositories()
+  }
 }
 
 // Dependencies are managed with Gradle version catalog - read more: https://docs.gradle.org/current/userguide/platforms.html#sub:version-catalog
@@ -29,21 +41,54 @@ dependencies {
 
   // Logging Network Calls
   testImplementation("com.squareup.okhttp3:logging-interceptor:4.12.0")
-}
 
-// Set the JVM language level used to build the project. Use Java 11 for 2020.3+, and Java 17 for 2022.2+.
-kotlin {
-  jvmToolchain(17)
+  // IntelliJ Platform Gradle Plugin Dependencies Extension - read more: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-dependencies-extension.html
+  intellijPlatform {
+    create(properties("platformType"), properties("platformVersion"))
+
+    // Plugin Dependencies. Uses `platformBundledPlugins` property from the gradle.properties file for bundled IntelliJ Platform plugins.
+    bundledPlugins(properties("platformBundledPlugins").map { it.split(',') })
+
+    // Plugin Dependencies. Uses `platformPlugins` property from the gradle.properties file for plugin from JetBrains Marketplace.
+    plugins(properties("platformPlugins").map { it.split(',') })
+
+    instrumentationTools()
+    pluginVerifier()
+    zipSigner()
+    testFramework(TestFrameworkType.Platform)
+  }
 }
 
-// Configure Gradle IntelliJ Plugin - read more: https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html
-intellij {
-  pluginName = properties("pluginName")
-  version = properties("platformVersion")
-  type = properties("platformType")
+// Configure IntelliJ Platform Gradle Plugin - read more: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-extension.html
+intellijPlatform {
+  pluginConfiguration {
+    version = properties("pluginVersion")
+
+    ideaVersion {
+      sinceBuild = properties("pluginSinceBuild")
+      untilBuild = properties("pluginUntilBuild")
+    }
+  }
+
+  signing {
+    certificateChain = environment("CERTIFICATE_CHAIN")
+    privateKey = environment("PRIVATE_KEY")
+    password = environment("PRIVATE_KEY_PASSWORD")
+  }
+
+  publishing {
+    token = environment("PUBLISH_TOKEN")
+    // The pluginVersion is based on the SemVer (https://semver.org) and supports pre-release labels, like 2.1.7-alpha.3
+    // Specify pre-release label to publish the plugin in a custom Release Channel automatically. Read more:
+    // https://plugins.jetbrains.com/docs/intellij/deployment.html#specifying-a-release-channel
+    channels = properties("pluginVersion").map { listOf(it.substringAfter('-', "").substringBefore('.').ifEmpty { "default" }) }
+  }
 
-  // Plugin Dependencies. Uses `platformPlugins` property from the gradle.properties file.
-  plugins = properties("platformPlugins").map { it.split(',').map(String::trim).filter(String::isNotEmpty) }
+  pluginVerification {
+    ides {
+      recommended()
+    }
+  }
 }
 
 tasks {
@@ -57,30 +102,6 @@ tasks {
     untilBuild = properties("pluginUntilBuild")
   }
 
-  downloadRobotServerPlugin {
-    version.set(remoteRobotVersion)
-  }
-
-  // Configure UI tests plugin
-  // Read more: https://github.com/JetBrains/intellij-ui-test-robot
-  runIdeForUiTests {
-    systemProperty("robot-server.port", "8082")
-    systemProperty("ide.mac.message.dialogs.as.sheets", "false")
-    systemProperty("jb.privacy.policy.text", "<!--999.999-->")
-    systemProperty("jb.consents.confirmation.enabled", "false")
-    systemProperty("ide.mac.file.chooser.native", "false")
-    systemProperty("jbScreenMenuBar.enabled", "false")
-    systemProperty("apple.laf.useScreenMenuBar", "false")
-    systemProperty("idea.trust.all.projects", "true")
-    systemProperty("ide.show.tips.on.startup.default.value", "false")
-    systemProperty("eap.require.license", "false")
-
-  }
-
-  test {
-    useJUnitPlatform()
-  }
-
   signPlugin {
     certificateChain = environment("CERTIFICATE_CHAIN")
     privateKey = environment("PRIVATE_KEY")
@@ -96,5 +117,29 @@ tasks {
   }
 }
 
-
-
+intellijPlatformTesting {
+  runIde {
+    register("runIdeForUiTests") {
+      task {
+        jvmArgumentProviders += CommandLineArgumentProvider {
+          listOf(
+            "-Drobot-server.port=8082",
+            "-Dide.mac.message.dialogs.as.sheets=false",
+            "-Djb.privacy.policy.text=<!--999.999-->",
+            "-Djb.consents.confirmation.enabled=false",
+            "-Dide.mac.file.chooser.native=false",
+            "-DjbScreenMenuBar.enabled=false",
+            "-Dapple.laf.useScreenMenuBar=false",
+            "-Didea.trust.all.projects=true",
+            "-Dide.show.tips.on.startup.default.value=false",
+            "-Deap.require.license=false"
+          )
+        }
+      }
+
+      plugins {
+        robotServerPlugin()
+      }
+    }
+  }
+}
diff --git a/gradle.properties b/gradle.properties
@@ -3,23 +3,30 @@ pluginGroup=com.github.biomejs.intellijbiome
 pluginName=Biome
 pluginRepositoryUrl=https://github.com/biomejs/biome
 # SemVer format -> https://semver.org
-pluginVersion=1.2.1
+pluginVersion=1.3.1
+
 # Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
-pluginSinceBuild=241
-pluginUntilBuild=241.*
+pluginSinceBuild = 241
+pluginUntilBuild = 242.*
+
 # IntelliJ Platform Properties -> https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#configuration-intellij-extension
-platformType=IU
-platformVersion=2024.1
+platformType = WS
+platformVersion = 2024.1.1
+
 # Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html
-# Example: platformPlugins = com.intellij.java, com.jetbrains.php:203.4449.22
-platformPlugins=JavaScript
+# Example: platformPlugins = com.jetbrains.php:203.4449.22, org.intellij.scala:2023.3.27@EAP
+platformPlugins =
+# Example: platformBundledPlugins = com.intellij.java
+platformBundledPlugins = JavaScript
+
 # Gradle Releases -> https://github.com/gradle/gradle/releases
-gradleVersion=8.5
+gradleVersion = 8.9
+
 # Opt-out flag for bundling Kotlin standard library -> https://jb.gg/intellij-platform-kotlin-stdlib
-kotlin.stdlib.default.dependency=false
+kotlin.stdlib.default.dependency = false
+
 # Enable Gradle Configuration Cache -> https://docs.gradle.org/current/userguide/configuration_cache.html
-org.gradle.configuration-cache=true
+org.gradle.configuration-cache = true
+
 # Enable Gradle Build Cache -> https://docs.gradle.org/current/userguide/build_cache.html
-org.gradle.caching=true
-# Enable Gradle Kotlin DSL Lazy Property Assignment -> https://docs.gradle.org/current/userguide/kotlin_dsl.html#kotdsl:assignment
-systemProp.org.gradle.unsafe.kotlin.assignment=true
+org.gradle.caching = true
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,14 +1,7 @@
 [versions]
-# libraries
-annotations = "24.1.0"
-
-# plugins
-kotlin = "1.9.21"
-gradleIntelliJPlugin = "1.16.1"
-
-[libraries]
-annotations = { group = "org.jetbrains", name = "annotations", version.ref = "annotations" }
+intelliJPlatform = "2.0.1"
+kotlin = "1.9.25"
 
 [plugins]
-gradleIntelliJPlugin = { id = "org.jetbrains.intellij", version.ref = "gradleIntelliJPlugin" }
+intelliJPlatform = { id = "org.jetbrains.intellij.platform", version.ref = "intelliJPlatform" }
 kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

diff --git a/src/main/kotlin/com/github/biomejs/intellijbiome/actions/BiomeCheckOnSaveAction.kt b/src/main/kotlin/com/github/biomejs/intellijbiome/actions/BiomeCheckOnSaveAction.kt
@@ -6,7 +6,7 @@ import com.intellij.openapi.editor.Document
 import com.intellij.openapi.project.Project
 
 
-class BiomeCheckOnSaveAction() :
+class BiomeCheckOnSaveAction :
     ActionsOnSaveFileDocumentManagerListener.ActionOnSave() {
     override fun isEnabledForProject(project: Project): Boolean {
         val settings = BiomeSettings.getInstance(project)