koxudaxi · koxudaxi · Apr 25, 2023 · Apr 25, 2023 · Apr 25, 2023 · Apr 25, 2023
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # Changelog
 
 ## [Unreleased]
+- Add disableOnSaveOutsideOfProject option [[#155](https://github.com/koxudaxi/ruff-pycharm-plugin/pull/155)]
 
 ## [0.0.12] - 2023-04-19
 - Support ruff 0.0.260 [[#144](https://github.com/koxudaxi/ruff-pycharm-plugin/pull/144)]

diff --git a/gradle.properties b/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.12
+pluginVersion = 0.0.13
 
 # Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 pluginSinceBuild = 222

diff --git a/src/com/koxudaxi/ruff/Ruff.kt b/src/com/koxudaxi/ruff/Ruff.kt
@@ -215,6 +215,9 @@ fun parseJsonResponse(response: String): List<Result> = try {
     listOf()
 }
 
+fun VirtualFile.isInProjectDir(project: Project): Boolean =
+    project.basePath?.let { canonicalPath?.startsWith(it) } ?: false
+
 fun getProjectRelativeFilePath(project: Project, virtualFile: VirtualFile): String? {
     val canonicalPath = virtualFile.canonicalPath ?: return null
     return project.basePath?.takeIf { canonicalPath.startsWith(it) }?.let {

diff --git a/src/com/koxudaxi/ruff/RuffConfigPanel.form b/src/com/koxudaxi/ruff/RuffConfigPanel.form
@@ -10,7 +10,7 @@
     </properties>
     <border type="none"/>
     <children>
-      <grid id="da542" layout-manager="GridLayoutManager" row-count="5" column-count="1" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
+      <grid id="da542" layout-manager="GridLayoutManager" row-count="6" column-count="1" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
         <margin top="0" left="0" bottom="0" right="0"/>
         <constraints>
           <grid row="0" column="0" row-span="1" col-span="2" vsize-policy="3" hsize-policy="3" anchor="0" fill="3" indent="0" use-parent-layout="false"/>
@@ -33,29 +33,37 @@
           </hspacer>
           <component id="d90c1" class="javax.swing.JCheckBox" binding="runRuffOnReformatCodeCheckBox">
             <constraints>
-              <grid row="2" column="0" row-span="1" col-span="1" vsize-policy="3" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+              <grid row="3" column="0" row-span="1" col-span="1" vsize-policy="3" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
             </constraints>
             <properties>
               <text value="Run ruff when Reformat Code"/>
             </properties>
           </component>
           <component id="d3ece" class="javax.swing.JCheckBox" binding="showRuleCodeCheckBox">
             <constraints>
-              <grid row="3" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+              <grid row="4" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
             </constraints>
             <properties>
               <text value="Show Rule Code on inspection message"/>
             </properties>
           </component>
           <component id="61d32" class="javax.swing.JCheckBox" binding="alwaysUseGlobalRuffCheckBox">
             <constraints>
-              <grid row="4" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+              <grid row="5" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
             </constraints>
             <properties>
               <actionCommand value="Always use global ruff executable. (if the option isn't checked then use ruff of current project environemnt)"/>
               <text value="Always use Global Ruff executable. (if the option isn't checked then use ruff of current project environemnt)"/>
             </properties>
           </component>
+          <component id="288de" class="javax.swing.JCheckBox" binding="disableOnSaveOutsideOfProjectCheckBox">
+            <constraints>
+              <grid row="2" column="0" row-span="1" col-span="1" vsize-policy="3" hsize-policy="3" anchor="8" fill="0" indent="1" use-parent-layout="false"/>
+            </constraints>
+            <properties>
+              <text value="Exclude files outside of the project"/>
+            </properties>
+          </component>
         </children>
       </grid>
       <vspacer id="a33f9">

diff --git a/src/com/koxudaxi/ruff/RuffConfigPanel.kt b/src/com/koxudaxi/ruff/RuffConfigPanel.kt
@@ -26,6 +26,7 @@ class RuffConfigPanel(project: Project) {
     private lateinit var projectRuffExecutablePathField: JBTextField
     private lateinit var ruffConfigPathField: TextFieldWithBrowseButton
     private lateinit var clearRuffConfigPathButton: JButton
+    private lateinit var disableOnSaveOutsideOfProjectCheckBox: JCheckBox
 
     init {
         val ruffConfigService = getInstance(project)
@@ -37,6 +38,11 @@ class RuffConfigPanel(project: Project) {
         showRuleCodeCheckBox.isEnabled = true
         alwaysUseGlobalRuffCheckBox.isEnabled = true
         alwaysUseGlobalRuffCheckBox.isSelected = ruffConfigService.alwaysUseGlobalRuff
+        disableOnSaveOutsideOfProjectCheckBox.isEnabled = ruffConfigService.runRuffOnSave
+        disableOnSaveOutsideOfProjectCheckBox.isSelected = ruffConfigService.disableOnSaveOutsideOfProject
+        runRuffOnSaveCheckBox.addActionListener {
+            disableOnSaveOutsideOfProjectCheckBox.isEnabled = runRuffOnSaveCheckBox.isSelected
+        }
         setProjectRuffExecutablePath(project)
 
         globalRuffExecutablePathField.apply {
@@ -85,6 +91,8 @@ class RuffConfigPanel(project: Project) {
         get() = alwaysUseGlobalRuffCheckBox.isSelected
     val ruffConfigPath: @SystemDependent String?
         get() = ruffConfigPathField.text.takeIf { it.isNotBlank() }
+    val disableOnSaveOutsideOfProject: Boolean
+        get() = disableOnSaveOutsideOfProjectCheckBox.isSelected
     companion object {
         const val RUFF_EXECUTABLE_NOT_FOUND =  "Ruff executable not found"
     }

diff --git a/src/com/koxudaxi/ruff/RuffConfigService.kt b/src/com/koxudaxi/ruff/RuffConfigService.kt
@@ -16,7 +16,7 @@ class RuffConfigService : PersistentStateComponent<RuffConfigService> {
     var alwaysUseGlobalRuff: Boolean = false
     var projectRuffExecutablePath: @SystemDependent String? = null
     var ruffConfigPath: @SystemDependent String? = null
-
+    var disableOnSaveOutsideOfProject: Boolean = true
 
     override fun getState(): RuffConfigService {
         return this

diff --git a/src/com/koxudaxi/ruff/RuffConfigurable.kt b/src/com/koxudaxi/ruff/RuffConfigurable.kt
@@ -29,7 +29,8 @@ class RuffConfigurable internal constructor(project: Project) : Configurable {
                 ruffConfigService.showRuleCode != configPanel.showRuleCode ||
                 ruffConfigService.alwaysUseGlobalRuff != configPanel.alwaysUseGlobalRuff ||
                 ruffConfigService.globalRuffExecutablePath != configPanel.globalRuffExecutablePath ||
-                ruffConfigService.ruffConfigPath != configPanel.ruffConfigPath
+                ruffConfigService.ruffConfigPath != configPanel.ruffConfigPath ||
+                ruffConfigService.disableOnSaveOutsideOfProject != configPanel.disableOnSaveOutsideOfProject
 
     }
 
@@ -40,6 +41,7 @@ class RuffConfigurable internal constructor(project: Project) : Configurable {
         ruffConfigService.alwaysUseGlobalRuff = configPanel.alwaysUseGlobalRuff
         ruffConfigService.globalRuffExecutablePath = configPanel.globalRuffExecutablePath
         ruffConfigService.ruffConfigPath = configPanel.ruffConfigPath
+        ruffConfigService.disableOnSaveOutsideOfProject = configPanel.disableOnSaveOutsideOfProject
     }
 
     override fun disposeUIResources() {

diff --git a/src/com/koxudaxi/ruff/RuffFileDocumentManagerListener.kt b/src/com/koxudaxi/ruff/RuffFileDocumentManagerListener.kt
@@ -4,14 +4,16 @@ import com.intellij.openapi.editor.Document
 import com.intellij.openapi.fileEditor.FileDocumentManagerListener
 import com.intellij.openapi.project.Project
 import com.intellij.psi.PsiDocumentManager
+import com.intellij.testFramework.utils.editor.getVirtualFile
 
-class RuffFileDocumentManagerListener(project: Project) : FileDocumentManagerListener {
+class RuffFileDocumentManagerListener(val project: Project) : FileDocumentManagerListener {
     private val ruffConfigService = RuffConfigService.getInstance(project)
     private val ruffFixService by lazy { RuffFixService.getInstance(project)}
     private val psiDocumentManager by lazy { PsiDocumentManager.getInstance(project) }
-    override fun beforeDocumentSaving(document: Document) {
+      override fun beforeDocumentSaving(document: Document) {
         if (!ruffConfigService.runRuffOnSave) return
         val psiFile = psiDocumentManager.getPsiFile(document) ?: return
+        if (ruffConfigService.disableOnSaveOutsideOfProject && !psiFile.virtualFile.isInProjectDir(project)) return
         if (!psiFile.isApplicableTo) return
         ruffFixService.fix(document, psiFile)
     }