Merge pull request #548 from koxudaxi/improve-ruff-formatter

fix: improve ruff formatter

Author: koxudaxi

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## [Unreleased]
+- fix: improve ruff formatter [[#548](https://github.com/koxudaxi/ruff-pycharm-plugin/pull/548)]
 - Add ruff logging console [[#547](https://github.com/koxudaxi/ruff-pycharm-plugin/pull/547)]
 - Update dependency versions [[#538](https://github.com/koxudaxi/ruff-pycharm-plugin/pull/538)]
 

resources/META-INF/plugin.xml

@@ -16,7 +16,8 @@
                          enabledByDefault="true" level="WARNING"
                          implementationClass="com.koxudaxi.ruff.RuffInspection"/>
         <externalAnnotator language="Python" implementationClass="com.koxudaxi.ruff.RuffExternalAnnotator"/>
-        <formattingService implementation="com.koxudaxi.ruff.RuffAsyncFormatter"/>
+        <formattingService implementation="com.koxudaxi.ruff.RuffAsyncFormatterFormat"/>
+        <formattingService implementation="com.koxudaxi.ruff.RuffAsyncFormatterFix"/>
         <platform.backend.documentation.targetProvider
                 implementation="com.koxudaxi.ruff.RuffNoqaDocumentationTargetProvider"/>
         <actionOnSave id="BlackFormatterActionOnSave" implementation="com.koxudaxi.ruff.RuffActionOnSave" order="last"/>

src/com/koxudaxi/ruff/RuffAsyncFormatter.kt src/com/koxudaxi/ruff/RuffAsyncFormatterFix.kt

@@ -9,7 +9,7 @@ import com.intellij.psi.PsiFile
 import java.util.*
 
 
-class RuffAsyncFormatter : AsyncDocumentFormattingService() {
+class RuffAsyncFormatterFix : AsyncDocumentFormattingService() {
     private val FEATURES: MutableSet<FormattingService.Feature> = EnumSet.noneOf(
         FormattingService.Feature::class.java
     )
@@ -43,17 +43,7 @@ class RuffAsyncFormatter : AsyncDocumentFormattingService() {
                         request.onTextReady(null)
                         return@runCatching
                     }
-                    if (!RuffConfigService.getInstance(formattingContext.project).useRuffFormat) {
-                        updateText(currentText, fixCommandStdout)
-                        return@runCatching
-                    }
-                    val formatCommandArgs = generateCommandArgs(sourceFile, FORMAT_ARGS)
-                    if (formatCommandArgs == null) {
-                        updateText(currentText, fixCommandStdout)
-                        return@runCatching
-                    }
-                    val formatCommandStdout = runRuff(formatCommandArgs, fixCommandStdout.toByteArray())
-                    updateText(currentText, formatCommandStdout)
+                    updateText(currentText, fixCommandStdout)
 
                 }.onFailure { exception ->
                     when (exception) {
@@ -79,6 +69,6 @@ class RuffAsyncFormatter : AsyncDocumentFormattingService() {
     }
 
     override fun getName(): String {
-        return "Ruff Formatter"
+        return "Ruff Formatter Fix"
     }
 }

src/com/koxudaxi/ruff/RuffAsyncFormatterFormat.kt

@@ -0,0 +1,85 @@
+package com.koxudaxi.ruff
+
+import com.intellij.formatting.FormattingContext
+import com.intellij.formatting.service.AsyncDocumentFormattingService
+import com.intellij.formatting.service.AsyncFormattingRequest
+import com.intellij.formatting.service.FormattingService
+import com.intellij.openapi.progress.ProcessCanceledException
+import com.intellij.psi.PsiFile
+import java.util.*
+
+
+class RuffAsyncFormatterFormat : AsyncDocumentFormattingService() {
+    private val FEATURES: MutableSet<FormattingService.Feature> = EnumSet.noneOf(
+        FormattingService.Feature::class.java
+    )
+
+    override fun getFeatures(): MutableSet<FormattingService.Feature> {
+        return FEATURES
+    }
+
+    override fun canFormat(file: PsiFile): Boolean {
+        return RuffConfigService.getInstance(file.project).runRuffOnReformatCode &&
+                RuffConfigService.getInstance(file.project).useRuffFormat &&
+                file.isApplicableTo
+    }
+
+    override fun runAfter(): Class<out FormattingService> {
+        return RuffAsyncFormatterFix::class.java
+    }
+
+    override fun createFormattingTask(request: AsyncFormattingRequest): FormattingTask? {
+        val formattingContext: FormattingContext = request.context
+        val ioFile = request.ioFile ?: return null
+        return object : FormattingTask {
+            private fun updateText(currentText: String, text: String?) {
+                when {
+                    text == null -> request.onTextReady(null)
+                    currentText == text -> request.onTextReady(null)
+                    else -> request.onTextReady(text)
+                }
+            }
+
+            override fun run() {
+                runCatching {
+                    val sourceFile = formattingContext.containingFile.sourceFile
+                    val currentText = ioFile.readText()
+
+                    val formatCommandArgs = generateCommandArgs(sourceFile, FORMAT_ARGS)
+                    if (formatCommandArgs == null) {
+                        request.onTextReady(null)
+                        return@runCatching
+                    }
+                    val formatCommandStdout = runRuff(formatCommandArgs, currentText.toByteArray())
+                    updateText(currentText, formatCommandStdout)
+
+                }.onFailure { exception ->
+                    when (exception) {
+                        is ProcessCanceledException -> { /* ignore */
+                        }
+
+                        else -> {
+                            request.onError("Ruff Error", exception.localizedMessage)
+                        }
+                    }
+                }
+            }
+
+            override fun cancel(): Boolean {
+                return true
+            }
+
+            override fun isRunUnderProgress(): Boolean {
+                return true
+            }
+        }
+    }
+
+    override fun getNotificationGroupId(): String {
+        return "Ruff"
+    }
+
+    override fun getName(): String {
+        return "Ruff Formatter Format"
+    }
+}