Merge pull request #42 from block/mehdi.idea-plugin-config

Add configuration for using a formatting script in the idea-plugin

Author: mmollaverdi

README.md

@@ -3,18 +3,22 @@
 [![release](https://img.shields.io/maven-central/v/xyz.block.kotlin-formatter/kotlin-formatter?label=release&color=blue)](https://central.sonatype.com/namespace/xyz.block.kotlin-formatter)
 [![main](https://github.com/block/kotlin-formatter/actions/workflows/push.yml/badge.svg)](https://github.com/block/kotlin-formatter/actions/workflows/push.yml)
 
-**A command-line tool for formatting Kotlin source code files**, implemented as a wrapper around [ktfmt](https://github.com/facebook/ktfmt/tree/main).
+This project provides:
+- **A command-line tool for formatting Kotlin source code files**, implemented as a wrapper around [ktfmt](https://github.com/facebook/ktfmt/tree/main).
+- **An IntelliJ idea plugin** for formatting Kotlin source code files.
 
 It can be used to automate code formatting, ensuring a clean and consistent codebase, while integrating seamlessly into development workflows.
 
-The tool can:
+The CLI tool can:
 
 - **Format files and directories**: Apply consistent formatting to files, directories, or standard input.
 - **Integrate with Git workflows**:
   - **Pre-commit**: Format staged files before committing. 
   - **Pre-push**: Check committed files before pushing.
 
-## Usage
+The plugin can format Kotlin files on save, or on the format action.
+
+## CLI Usage
 
 ```bash
 kotlin-format [OPTIONS] [FILES...]
@@ -70,3 +74,21 @@ A fat JAR of the CLI is available on [Maven Central](https://repo1.maven.org/mav
 ```bash
 java -jar path/to/kotlin-formatter-$version-all.jar [OPTIONS] [FILES...]
 ```
+
+## Idea Plugin Usage
+
+A properties file can be used to configure the plugin for each project. The properties file should be named `kotlin-formatter.properties` and placed in the `.idea` of the project. The following properties are supported:
+
+- `kotlin-formatter.enabled`: Enable or disable the plugin, disabled by default.
+- `kotlin-formatter.script-path`: Path to the Kotlin Formatter script. The `kotlin-format` library in this project is used if this is not specified.
+
+Example:
+```properties
+kotlin-formatter.enabled=true
+kotlin-formatter.script-path=bin/kotlin-format
+```
+
+Changes to these config require an IDE restart to take effect.
+
+To enable formatting of files on save, navigate to "Settings" > "Tools" > Actions on Save", activate the "Reformat code" checkbox, and ensure that the "Kotlin" file type is selected.
+Make sure "Optimize imports" is NOT enabled for the "Kotlin" file type.

idea-plugin/src/main/kotlin/xyz/block/kotlinformatter/idea/FormatConfigurationService.kt

@@ -12,23 +12,33 @@ class FormatConfigurationService(private val project: Project) {
 
   // This is calculated once and on demand.
   // Changes to the config file will require a restart.
-  val formattingEnabled by lazy {
+  private val config: Properties by lazy {
     val configFile = project.getFile(CONFIG_FILE_PATH)
-    val enabled = configFile?.let { file ->
-      val properties = Properties()
+    val properties = Properties()
+    configFile?.let { file ->
       InputStreamReader(file.inputStream).use {
         properties.load(it)
-        properties.getProperty(ENABLED_PROPERTY_NAME)?.toBoolean() == true
       }
-    } ?: false
+    }
+    properties
+  }
 
+  val formattingEnabled: Boolean by lazy {
+    val enabled = config.getProperty(ENABLED_PROPERTY_NAME)?.toBoolean() ?: false
     logger.info("Formatting enabled: $enabled")
     enabled
   }
 
+  val scriptPath: String? by lazy {
+    val path = config.getProperty(SCRIPT_PATH_PROPERTY_NAME)
+    logger.info("Formatting script: $path")
+    path
+  }
+
   companion object {
-    private const val CONFIG_FILE_PATH: String = ".idea/kotlin-formater.properties"
+    private const val CONFIG_FILE_PATH: String = ".idea/kotlin-formatter.properties"
     private const val ENABLED_PROPERTY_NAME: String = "kotlin-formatter.enabled"
+    private const val SCRIPT_PATH_PROPERTY_NAME: String = "kotlin-formatter.script-path"
     private val logger = Logger.getInstance(FormatConfigurationService::class.java.name)
   }
 }

idea-plugin/src/main/kotlin/xyz/block/kotlinformatter/idea/FormatOnSaveListener.kt

@@ -19,7 +19,10 @@ import java.util.concurrent.ConcurrentHashMap
 /**
  * A listener that formats a document when it is saved.
  */
-class FormatOnSaveListener(private val project: Project, private val formatter: AsyncDocumentFormattingService) :
+class FormatOnSaveListener(
+  private val project: Project,
+  private val formatter: AsyncDocumentFormattingService
+) :
   FileDocumentManagerListener {
 
   /**

idea-plugin/src/main/kotlin/xyz/block/kotlinformatter/idea/KotlinReformatService.kt

@@ -8,6 +8,8 @@ import com.intellij.openapi.diagnostic.Logger
 import com.intellij.psi.PsiFile
 import xyz.block.kotlinformatter.Ktfmt
 import xyz.block.kotlinformatter.idea.KotlinReformatService.Companion.FORMATTING_IGNORE_FILE
+import java.io.File
+import kotlin.text.Charsets.UTF_8
 
 /**
  * A service that overrides the default IntelliJ formatting behavior for Kotlin files.
@@ -34,12 +36,12 @@ class KotlinReformatService : AsyncDocumentFormattingService() {
     return !isFormattingIgnored(file)
   }
 
-  override fun createFormattingTask(request: AsyncFormattingRequest): FormattingTask? {
+  override fun createFormattingTask(request: AsyncFormattingRequest): FormattingTask {
     return object : FormattingTask {
       override fun run() {
         ApplicationManager.getApplication().executeOnPooledThread {
           try {
-            val formattedCode = Ktfmt().format(request.documentText)
+            val formattedCode = format(request)
             request.onTextReady(formattedCode)
           } catch (e: Exception) {
             // If an error occurs, notify IntelliJ
@@ -62,6 +64,41 @@ class KotlinReformatService : AsyncDocumentFormattingService() {
     return "Reformat Kotlin Files"
   }
 
+  private fun format(request: AsyncFormattingRequest): String {
+    val file = request.context.psiElement.containingFile
+    val scriptPath = file.project.getService(FormatConfigurationService::class.java).scriptPath
+    return if (scriptPath != null) {
+
+      val process = ProcessBuilder(scriptPath, "--set-exit-if-changed", "-")
+        .directory(file.project.basePath?.let { File(it) })
+        .start()
+
+      // Stream file content to the process's input
+      file.virtualFile.inputStream.use { inputStream ->
+        process.outputStream.use { outputStream -> inputStream.copyTo(outputStream) }
+      }
+
+      val formattedContent = process.inputStream.bufferedReader(UTF_8).use { it.readText() }
+
+      // Wait for the process to complete
+      val exitCode = process.waitFor()
+      LOG.info("Process exited with code: $exitCode")
+      return when (exitCode) {
+        3 -> formattedContent
+        0 -> {
+          LOG.info("Nothing to format")
+          request.documentText
+        }
+        else -> {
+          LOG.error("Formatting failed with exit code $exitCode")
+          request.documentText
+        }
+      }
+    } else {
+      Ktfmt().format(request.documentText)
+    }
+  }
+
   /**
    * Determines whether formatting should be ignored for the given module based on [FORMATTING_IGNORE_FILE].
    *