Merge pull request #503 from koxudaxi/fix-multi-project-formatting-isolation

Fix: Isolate Ruff formatting to the active project

Author: koxudaxi

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## [Unreleased]
+- Fix: Isolate Ruff formatting to the active project [[#503](https://github.com/koxudaxi/ruff-pycharm-plugin/pull/503)]
 
 ## [0.0.38] - 2024-09-12
 

gradle.properties

@@ -4,7 +4,7 @@ pluginGroup = com.koxudaxi.ruff
 pluginName = Ruff
 pluginRepositoryUrl = https://github.com/koxudaxi/ruff-pycharm-plugin
 # SemVer format -> https://semver.org
-pluginVersion = 0.0.38
+pluginVersion = 0.0.39
 
 # Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 pluginSinceBuild = 242.20224.89

resources/META-INF/plugin.xml

@@ -20,10 +20,9 @@
         <externalAnnotator language="Python" implementationClass="com.koxudaxi.ruff.RuffExternalAnnotator"/>
         <platform.backend.documentation.targetProvider
                 implementation="com.koxudaxi.ruff.RuffNoqaDocumentationTargetProvider"/>
+        <actionOnSave id="BlackFormatterActionOnSave" implementation="com.koxudaxi.ruff.RuffActionOnSave" order="last"/>
     </extensions>
     <projectListeners>
-        <listener class="com.koxudaxi.ruff.RuffFileDocumentManagerListener"
-                  topic="com.intellij.openapi.fileEditor.FileDocumentManagerListener"/>
         <listener class="com.koxudaxi.ruff.RuffPackageManagerListener"
                   topic="com.jetbrains.python.packaging.PyPackageManager$Listener"/>
     </projectListeners>

src/com/koxudaxi/ruff/RuffConfigService.kt

@@ -8,8 +8,8 @@ import com.intellij.openapi.project.Project
 import com.intellij.util.xmlb.XmlSerializerUtil
 import org.jetbrains.annotations.SystemDependent
 
-@State(name = "RuffConfigService", storages = [Storage("ruff.xml")])
 @Service(Service.Level.PROJECT)
+@State(name = "RuffConfigService", storages = [Storage("ruff.xml")])
 class RuffConfigService : PersistentStateComponent<RuffConfigService> {
     var runRuffOnSave: Boolean = false
     var runRuffOnReformatCode: Boolean = true

src/com/koxudaxi/ruff/RuffConfigurable.kt

@@ -3,16 +3,11 @@ package com.koxudaxi.ruff
 import com.intellij.openapi.options.Configurable
 import com.intellij.openapi.project.Project
 import com.koxudaxi.ruff.lsp.ClientType
-import com.koxudaxi.ruff.lsp.intellij.RuffIntellijLspClient
-import com.koxudaxi.ruff.lsp.lsp4ij.RuffLsp4IntellijClient
 import javax.swing.JComponent
 
 
 class RuffConfigurable internal constructor(val project: Project) : Configurable {
-    private val ruffConfigService: RuffConfigService = RuffConfigService.getInstance(project)
     private val configPanel: RuffConfigPanel = RuffConfigPanel(project)
-    private val ruffCacheService: RuffCacheService = RuffCacheService.getInstance(project)
-    private val ruffLspClientManager = RuffLspClientManager.getInstance(project)
     override fun getDisplayName(): String {
         return "Ruff"
     }
@@ -29,6 +24,7 @@ class RuffConfigurable internal constructor(val project: Project) : Configurable
     override fun reset() {}
 
     override fun isModified(): Boolean {
+        val ruffConfigService: RuffConfigService = RuffConfigService.getInstance(project)
         return ruffConfigService.runRuffOnSave != configPanel.runRuffOnSave ||
                 ruffConfigService.runRuffOnReformatCode != configPanel.runRuffOnReformatCode ||
                 ruffConfigService.showRuleCode != configPanel.showRuleCode ||
@@ -46,6 +42,9 @@ class RuffConfigurable internal constructor(val project: Project) : Configurable
     }
 
     override fun apply() {
+        val ruffConfigService: RuffConfigService = RuffConfigService.getInstance(project)
+        val ruffCacheService: RuffCacheService = RuffCacheService.getInstance(project)
+        val ruffLspClientManager = RuffLspClientManager.getInstance(project)
         ruffConfigService.runRuffOnSave = configPanel.runRuffOnSave
         ruffConfigService.runRuffOnReformatCode = configPanel.runRuffOnReformatCode
         ruffConfigService.showRuleCode = configPanel.showRuleCode

src/com/koxudaxi/ruff/RuffFileDocumentManagerListener.kt

@@ -0,0 +1,26 @@
+package com.koxudaxi.ruff
+
+import com.intellij.ide.actionsOnSave.impl.ActionsOnSaveFileDocumentManagerListener.ActionOnSave
+import com.intellij.openapi.editor.Document
+import com.intellij.openapi.project.Project
+import com.intellij.psi.PsiDocumentManager
+
+class RuffActionOnSave : ActionOnSave() {
+    override fun isEnabledForProject(project: Project): Boolean {
+        val ruffConfigService = RuffConfigService.getInstance(project)
+        return ruffConfigService.runRuffOnSave
+    }
+    override fun processDocuments(project: Project, documents: Array<Document>) {
+        val ruffApplyService = RuffApplyService.getInstance(project)
+        val ruffConfigService = RuffConfigService.getInstance(project)
+        val ruffCacheService = RuffCacheService.getInstance(project)
+        val psiDocumentManager = PsiDocumentManager.getInstance(project)
+        val withFormat = ruffConfigService.useRuffFormat && ruffCacheService.hasFormatter()
+        for (document in documents) {
+            val psiFile = psiDocumentManager.getPsiFile(document) ?: continue
+            if (!psiFile.isApplicableTo) continue
+            if (ruffConfigService.disableOnSaveOutsideOfProject && !psiFile.virtualFile.isInProjectDir(project)) return
+            ruffApplyService.apply(document, psiFile.sourceFile, withFormat)
+        }
+    }
+}

src/com/koxudaxi/ruff/RuffFormatOnSaveAction.kt

@@ -5,14 +5,16 @@ import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.projectRoots.Sdk
 import com.jetbrains.python.packaging.PyPackageManager
+import com.jetbrains.python.sdk.pythonSdk
 import com.koxudaxi.ruff.lsp.ClientType
 
-class RuffPackageManagerListener(project: Project) : PyPackageManager.Listener {
-    private val ruffConfigService = RuffConfigService.getInstance(project)
-    private val ruffCacheService = RuffCacheService.getInstance(project)
-    private val ruffLspClientManager = RuffLspClientManager.getInstance(project)
+class RuffPackageManagerListener(private val project: Project) : PyPackageManager.Listener {
 
     override fun packagesRefreshed(sdk: Sdk) {
+        if (project.pythonSdk != sdk) return
+        val ruffConfigService = RuffConfigService.getInstance(project)
+        val ruffCacheService = RuffCacheService.getInstance(project)
+        val ruffLspClientManager = RuffLspClientManager.getInstance(project)
         ruffConfigService.projectRuffExecutablePath = findRuffExecutableInSDK(sdk, false)?.absolutePath
         ruffConfigService.projectRuffLspExecutablePath = findRuffExecutableInSDK(sdk, true)?.absolutePath
         if (!lspSupported || !ruffConfigService.enableLsp) return