Dev

.github/workflows/build.yml

@@ -47,7 +47,7 @@ jobs:
           name: refact-chat-js-latest
           path: ./src/main/resources/webview/dist
 
-      - uses: convictional/[email protected].1
+      - uses: convictional/[email protected].5
         name: "Build refact-lsp"
         with:
           owner: smallcloudai
@@ -63,20 +63,22 @@ jobs:
           github_token: ${{secrets.GITHUB_TOKEN}}
           workflow: build.yml
           repo: smallcloudai/refact-lsp
+          name_is_regexp: true
+          name: dist-*
           branch: ${{ steps.setupvars.outputs.lsp_version }}
           path: ./src/main/resources/bin
 
 
       # Validate wrapper
       - name: Gradle Wrapper Validation
-        uses: gradle/wrapper-validation-action@v3
+        uses: gradle/actions/wrapper-validation@v3
 
-      # Setup Java 11 environment for the next steps
+      # Setup Java 17 environment for the next steps
       - name: Setup Java
         uses: actions/setup-java@v4
         with:
           distribution: zulu
-          java-version: 11
+          java-version: 17
 
       # Set environment variables
       - name: Export Properties
@@ -85,7 +87,7 @@ jobs:
         run: |
           echo "pluginVerifierHomeDir=~/.pluginVerifier" >> $GITHUB_OUTPUT
           ./gradlew properties --console=plain -q
-          ./gradlew listProductsReleases # prepare list of IDEs for Plugin Verifier
+          ./gradlew printProductsReleases # prepare list of IDEs for Plugin Verifier
 
       # Run tests
       - name: Run Tests
@@ -108,11 +110,10 @@ jobs:
 
       # Run Verify Plugin task and IntelliJ Plugin Verifier tool
       - name: Run Plugin Verification tasks
-        run: ./gradlew runPluginVerifier -Dplugin.verifier.home.dir=${{ steps.properties.outputs.pluginVerifierHomeDir }}
+        run: ./gradlew verifyPlugin -Dplugin.verifier.home.dir=${{ steps.properties.outputs.pluginVerifierHomeDir }}
 
       # Collect Plugin Verifier Result
       - name: Collect Plugin Verifier Result
-        if: ${{ always() }}
         uses: actions/upload-artifact@v4
         with:
           name: pluginVerifier-result
@@ -131,7 +132,7 @@ jobs:
 
       # Store already-built plugin as an artifact for downloading
       - name: Upload artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ steps.artifact.outputs.filename }}
           path: ./build/distributions/content/*/*

.github/workflows/release.yml

@@ -37,6 +37,13 @@ jobs:
         with:
           fetch-depth: 0
 
+      # Setup Java 17 environment for the next steps
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: zulu
+          java-version: 17
+
       - name: Set env CHANNEL
         shell: bash
         id: setupvars
@@ -68,7 +75,7 @@ jobs:
           name: refact-chat-js-latest
           path: ./src/main/resources/webview/dist
 
-      - uses: convictional/[email protected].1
+      - uses: convictional/[email protected].5
         name: "Build refact-lsp"
         with:
           owner: smallcloudai
@@ -84,19 +91,14 @@ jobs:
           github_token: ${{secrets.GITHUB_TOKEN}}
           workflow: build.yml
           repo: smallcloudai/refact-lsp
+          name_is_regexp: true
+          name: dist-*
           branch: ${{ steps.setupvars.outputs.lsp_version }}
           path: ./src/main/resources/bin
 
       # Validate wrapper
       - name: Gradle Wrapper Validation
-        uses: gradle/wrapper-validation-action@v3
-
-      # Setup Java 11 environment for the next steps
-      - name: Setup Java
-        uses: actions/setup-java@v4
-        with:
-          distribution: zulu
-          java-version: 11
+        uses: gradle/actions/wrapper-validation@v3
 
       # Set environment variables
       - name: Export Properties
@@ -105,7 +107,7 @@ jobs:
         run: |
           echo "pluginVerifierHomeDir=~/.pluginVerifier" >> $GITHUB_OUTPUT
           ./gradlew properties --console=plain -q
-          ./gradlew listProductsReleases # prepare list of IDEs for Plugin Verifier
+          ./gradlew printProductsReleases # prepare list of IDEs for Plugin Verifier
 
       # Run tests
       - name: Run Tests
@@ -128,7 +130,7 @@ jobs:
 
       # Run Verify Plugin task and IntelliJ Plugin Verifier tool
       - name: Run Plugin Verification tasks
-        run: ./gradlew runPluginVerifier -Dplugin.verifier.home.dir=${{ steps.properties.outputs.pluginVerifierHomeDir }}
+        run: ./gradlew verifyPlugin -Dplugin.verifier.home.dir=${{ steps.properties.outputs.pluginVerifierHomeDir }}
 
       # Collect Plugin Verifier Result
       - name: Collect Plugin Verifier Result
@@ -151,7 +153,7 @@ jobs:
 
       # Store already-built plugin as an artifact for downloading
       - name: Upload artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ steps.artifact.outputs.filename }}
           path: ./build/distributions/content/*/*

.gitignore

@@ -29,6 +29,7 @@ bin/
 /nbproject/private/
 /nbbuild/
 /dist/
+.intellijPlatform/
 /nbdist/
 /.nb-gradle/
 

CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# refact-intellij & refact-chat-js
+### Instructions for React Chat build for JetBrains IDEs (to run locally)
+1. Clone the branch alpha of the repository `refact-chat-js`.
+2. Install dependencies and build the project:
+   ```bash
+   npm install && npm run build
+   ```
+3. Clone the branch `dev` of the repository `refact-intellij`.
+4. Move the generated `dist` directory from the `refact-chat-js` repository to the `src/main/resources/webview` directory of the `refact-intellij` repository.
+5. Wait for the files to be indexed.
+6. Open the IDE and navigate to the Gradle panel, then select Run Configurations with the suffix [runIde].
+7. In the Environment variables field, insert `REFACT_DEBUG=1`.
+8. Start the project by right-clicking on the command `refact-intellij [runIde]`.
+9. Inside the Refact.ai settings in the new IDE (PyCharm will open), select the field `Secret API Key` and press the key combination `Ctrl + Alt + - (minus)`, if using MacOS: `Command + Option + - (minus)`.
+10. Scroll down and insert the port value for `xDebug LSP port`, which is the port under which LSP is running locally. By default, LSP's port is `8001`.
+11. After that, you can test the chat functionality with latest features.

build.gradle.kts

@@ -1,10 +1,28 @@
+import org.jetbrains.intellij.platform.gradle.TestFrameworkType
+
 plugins {
-    id("java")
-    id("org.jetbrains.intellij") version "1.16.0"
-    id("org.jetbrains.kotlin.jvm") version "1.9.21"
-    id("org.jetbrains.changelog") version "2.0.0"
-    id("org.jetbrains.qodana") version "0.1.13"
-    id("org.jetbrains.kotlinx.kover") version "0.6.1"
+    id("java") // Java support
+    alias(libs.plugins.kotlin) // Kotlin support
+    alias(libs.plugins.intelliJPlatform) // IntelliJ Platform Gradle Plugin
+    alias(libs.plugins.changelog) // Gradle Changelog Plugin
+    alias(libs.plugins.qodana) // Gradle Qodana Plugin
+    alias(libs.plugins.kover) // Gradle Kover Plugin
+}
+
+group = providers.gradleProperty("pluginGroup").get()
+version = getVersionString(providers.gradleProperty("pluginVersion").get())
+
+val javaCompilerVersion = "17"
+kotlin {
+    jvmToolchain(javaCompilerVersion.toInt())
+}
+
+repositories {
+    mavenCentral()
+
+    intellijPlatform {
+        defaultRepositories()
+    }
 }
 
 dependencies {
@@ -18,31 +36,47 @@ dependencies {
 
     // test libraries
     testImplementation(kotlin("test"))
-}
-
+    intellijPlatform {
+        create(providers.gradleProperty("platformType"), providers.gradleProperty("platformVersion"))
 
+        // Plugin Dependencies. Uses `platformBundledPlugins` property from the gradle.properties file for bundled IntelliJ Platform plugins.
+        bundledPlugins(providers.gradleProperty("platformBundledPlugins").map { it.split(',') })
 
-group = "com.smallcloud"
-version = getVersionString("1.4.1")
+        // Plugin Dependencies. Uses `platformPlugins` property from the gradle.properties file for plugin from JetBrains Marketplace.
+        plugins(providers.gradleProperty("platformPlugins").map { it.split(',') })
 
-repositories {
-    mavenCentral()
+        instrumentationTools()
+        pluginVerifier()
+        zipSigner()
+        testFramework(TestFrameworkType.Platform)
+    }
 }
 
+intellijPlatform {
+    pluginConfiguration {
+        ideaVersion {
+            sinceBuild = providers.gradleProperty("pluginSinceBuild")
+            untilBuild = providers.gradleProperty("pluginUntilBuild")
+        }
+    }
 
-// Configure Gradle IntelliJ Plugin
-// Read more: https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#intellij-extension-type
-intellij {
-//    version.set("LATEST-EAP-SNAPSHOT")
-    version.set("2023.1.6")
-    type.set("PC") // Target IDE Platform
+    signing {
+        certificateChain = providers.environmentVariable("CERTIFICATE_CHAIN")
+        privateKey = providers.environmentVariable("PRIVATE_KEY")
+        password = providers.environmentVariable("PRIVATE_KEY_PASSWORD")
+    }
 
-    plugins.set(listOf(
-        "Git4Idea",
-    ))
-}
+    publishing {
+        token = providers.environmentVariable("PUBLISH_TOKEN")
+        channels = providers.environmentVariable("PUBLISH_CHANNEL").map { listOf(it) }
+    }
 
-val javaCompilerVersion = "17"
+    pluginVerification {
+        ides {
+            recommended()
+        }
+    }
+}
 
 tasks {
     // Set the JVM compatibility versions
@@ -53,59 +87,28 @@ tasks {
     withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
         kotlinOptions.jvmTarget = javaCompilerVersion
     }
-
-    patchPluginXml {
-        sinceBuild.set("231")
-        untilBuild.set("242.*")
-    }
-
-    signPlugin {
-        certificateChain.set(System.getenv("CERTIFICATE_CHAIN"))
-        privateKey.set(System.getenv("PRIVATE_KEY"))
-        password.set(System.getenv("PRIVATE_KEY_PASSWORD"))
-    }
-
-    publishPlugin {
-        channels.set(listOf(System.getenv("PUBLISH_CHANNEL")))
-        token.set(System.getenv("PUBLISH_TOKEN"))
-    }
-
-    test  {
-        useJUnitPlatform()
-    }
 }
 
-fun String.runCommand(
-    workingDir: File = File("."),
-    timeoutAmount: Long = 10,
-    timeoutUnit: TimeUnit = TimeUnit.SECONDS
-): String = ProcessBuilder(split("\\s(?=(?:[^'\"`]*(['\"`])[^'\"`]*\\1)*[^'\"`]*$)".toRegex()))
-    .directory(workingDir)
-    .redirectOutput(ProcessBuilder.Redirect.PIPE)
-    .redirectError(ProcessBuilder.Redirect.PIPE)
-    .start()
-    .apply { waitFor(timeoutAmount, timeoutUnit) }
-    .run {
-        val error = errorStream.bufferedReader().readText().trim()
-        if (error.isNotEmpty()) {
-            throw Exception(error)
-        }
-        inputStream.bufferedReader().readText().trim()
-    }
+fun runCommand(cmd: String): String {
+    return providers.exec {
+        commandLine(cmd.split(" "))
+    }.standardOutput.asText.get().trim()
+}
 
 fun getVersionString(baseVersion: String): String {
-    val tag = "git tag -l --points-at HEAD".runCommand(workingDir = rootDir)
+    val tag = runCommand("git tag -l --points-at HEAD")
+
     if (System.getenv("PUBLISH_EAP") != "1" &&
         tag.isNotEmpty() && tag.contains(baseVersion)) return baseVersion
 
-    val branch = "git rev-parse --abbrev-ref HEAD".runCommand(workingDir = rootDir)
+    val branch = runCommand("git rev-parse --abbrev-ref HEAD").replace("/", "-")
     val numberOfCommits = if (branch == "main") {
-        val lastTag = "git describe --tags --abbrev=0 @^".runCommand(workingDir = rootDir)
-        "git rev-list ${lastTag}..HEAD --count".runCommand(workingDir = rootDir)
+        val lastTag = runCommand("git describe --tags --abbrev=0 @^")
+        runCommand("git rev-list ${lastTag}..HEAD --count")
     } else {
-        "git rev-list --count HEAD ^origin/main".runCommand(workingDir = rootDir)
+        runCommand("git rev-list --count HEAD ^origin/main")
     }
-    val commitId = "git rev-parse --short=8 HEAD".runCommand(workingDir = rootDir)
+    val commitId = runCommand("git rev-parse --short=8 HEAD")
     return if (System.getenv("PUBLISH_EAP") == "1") {
         "$baseVersion.$numberOfCommits-eap-$commitId"
     } else {

gradle.properties

@@ -1 +1,34 @@
+# IntelliJ Platform Artifacts Repositories -> https://plugins.jetbrains.com/docs/intellij/intellij-artifacts.html
+
+pluginGroup = "com.smallcloud"
+pluginName = Refact.ai
+pluginRepositoryUrl = https://github.com/smallcloudai/refact-intellij
+# SemVer format -> https://semver.org
+pluginVersion = 1.4.3
+
+# Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
+pluginSinceBuild = 232
+pluginUntilBuild = 243.*
+
+# IntelliJ Platform Properties -> https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#configuration-intellij-extension
+platformType = PC
+platformVersion = 2023.2.8
+
+# Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html
+# Example: platformPlugins = com.jetbrains.php:203.4449.22, org.intellij.scala:2023.3.27@EAP
+platformPlugins =
+# Example: platformBundledPlugins = com.intellij.java
+platformBundledPlugins =
+
+# Gradle Releases -> https://github.com/gradle/gradle/releases
+gradleVersion = 8.10.2
+
+# Opt-out flag for bundling Kotlin standard library -> https://jb.gg/intellij-platform-kotlin-stdlib
+kotlin.stdlib.default.dependency = false
+
+# Enable Gradle Configuration Cache -> https://docs.gradle.org/current/userguide/configuration_cache.html
+org.gradle.configuration-cache = true
+
+# Enable Gradle Build Cache -> https://docs.gradle.org/current/userguide/build_cache.html
+org.gradle.caching = false
 org.gradle.jvmargs=-Xmx2048m

gradle/libs.versions.toml

@@ -0,0 +1,20 @@
+[versions]
+# libraries
+junit = "4.13.2"
+
+# plugins
+changelog = "2.2.1"
+intelliJPlatform = "2.1.0"
+kotlin = "1.9.25"
+kover = "0.8.3"
+qodana = "2024.2.3"
+
+[libraries]
+junit = { group = "junit", name = "junit", version.ref = "junit" }
+
+[plugins]
+changelog = { id = "org.jetbrains.changelog", version.ref = "changelog" }
+intelliJPlatform = { id = "org.jetbrains.intellij.platform", version.ref = "intelliJPlatform" }
+kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
+kover = { id = "org.jetbrains.kotlinx.kover", version.ref = "kover" }
+qodana = { id = "org.jetbrains.qodana", version.ref = "qodana" }