feat: refactor executable configurations, allow use any tool path

xepozz · xepozz · commit 2590549ffec0 · 2025-12-25T12:50:26.000+04:00
diff --git a/src/main/kotlin/com/github/xepozz/mago/configuration/MagoConfigurable.kt b/src/main/kotlin/com/github/xepozz/mago/configuration/MagoConfigurable.kt
@@ -3,7 +3,6 @@ package com.github.xepozz.mago.configuration
 import com.github.xepozz.mago.MagoBundle
 import com.github.xepozz.mago.qualityTool.MagoQualityToolType
 import com.intellij.codeInsight.daemon.HighlightDisplayKey
-import com.intellij.openapi.fileChooser.FileChooserDescriptor
 import com.intellij.openapi.options.Configurable
 import com.intellij.openapi.options.ex.ConfigurableExtensionPointUtil
 import com.intellij.openapi.project.Project
@@ -17,11 +16,14 @@ import com.intellij.ui.dsl.builder.bindSelected
 import com.intellij.ui.dsl.builder.bindText
 import com.intellij.ui.dsl.builder.panel
 import com.jetbrains.php.lang.inspections.PhpInspectionsUtil
+import com.jetbrains.php.tools.quality.QualityToolConfigurationComboBox
+import javax.swing.JComponent
 
 class MagoConfigurable(val project: Project) : Configurable {
     val settings = project.getService(MagoProjectConfiguration::class.java)
     val inspectionProfileManager = InspectionProfileManager.getInstance(project)
 
+    val qualityToolConfigurationComboBox = QualityToolConfigurationComboBox(project, getQualityToolType())
     var myPanel = panel {
         group("Features") {
             row {
@@ -60,9 +62,8 @@ class MagoConfigurable(val project: Project) : Configurable {
         }
         group("Options") {
             row {
-                label("Path to Mago executable")
-                textFieldWithBrowseButton(FileChooserDescriptor(true, false, false, false, false, false))
-                    .bindText(settings::magoExecutable)
+                cell(qualityToolConfigurationComboBox)
+                    .label("Mago executable")
                     .align(AlignX.FILL)
             }.layout(RowLayout.PARENT_GRID)
             row {
@@ -78,24 +79,38 @@ class MagoConfigurable(val project: Project) : Configurable {
         }
     }
 
-    override fun getDisplayName() = "Mago"
+    override fun createComponent(): JComponent = myPanel
 
-    override fun getHelpTopic() = "reference.settings.php.mago"
+    override fun isModified(): Boolean {
+        return myPanel.isModified()
+                || qualityToolConfigurationComboBox.selectedItemId != getSavedSelectedConfigurationId()
+    }
+
+    override fun apply() {
+        updateSelectedConfiguration(qualityToolConfigurationComboBox.selectedItemId)
+        myPanel.apply()
+    }
 
-    fun getQualityToolType() = MagoQualityToolType.INSTANCE
+    private fun getQualityToolType() = MagoQualityToolType.INSTANCE
 
-    fun getInspectionShortName() = getQualityToolType().getInspectionShortName(project)
+    override fun reset() {
+        qualityToolConfigurationComboBox.reset(project, getSavedSelectedConfigurationId())
+    }
 
-    override fun createComponent() = myPanel
+    private fun getInspectionShortName() = getQualityToolType().getInspectionShortName(project)
 
-    override fun isModified() = this.myPanel.isModified()
+    override fun getDisplayName() = getQualityToolType().getDisplayName()
 
-    override fun apply() {
-        myPanel.apply()
+    private fun updateSelectedConfiguration(newConfigurationId: String?) {
+        val projectConfiguration = getQualityToolType().getProjectConfiguration(project)
+        if (newConfigurationId != projectConfiguration.selectedConfigurationId) {
+            projectConfiguration.selectedConfigurationId = newConfigurationId
+        }
     }
 
-    override fun reset() {
-        myPanel.reset()
+    private fun getSavedSelectedConfigurationId(): String? {
+        return getQualityToolType().getProjectConfiguration(project).selectedConfigurationId
     }
+
 }
 
diff --git a/src/main/kotlin/com/github/xepozz/mago/configuration/MagoConfigurableForm.kt b/src/main/kotlin/com/github/xepozz/mago/configuration/MagoConfigurableForm.kt
@@ -5,23 +5,28 @@ import com.github.xepozz.mago.qualityTool.MagoCustomOptionsForm
 import com.github.xepozz.mago.qualityTool.MagoQualityToolType
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.util.Pair
+import com.intellij.openapi.vfs.VirtualFile
 import com.jetbrains.php.PhpBundle
 import com.jetbrains.php.tools.quality.QualityToolConfigurableForm
 import com.jetbrains.php.tools.quality.QualityToolConfiguration
 import com.jetbrains.php.tools.quality.QualityToolType
 
 // TODO: change to PhpStanOptionsPanel
 class MagoConfigurableForm(project: Project, configuration: MagoConfiguration) :
-    QualityToolConfigurableForm<MagoConfiguration>(project, configuration, MAGO, "Mago") {
+    QualityToolConfigurableForm<MagoConfiguration>(project, configuration, MAGO, "mago") {
     override fun getQualityToolType(): QualityToolType<QualityToolConfiguration> {
         try {
             @Suppress("UNCHECKED_CAST")
             return MagoQualityToolType.INSTANCE as QualityToolType<QualityToolConfiguration>
         } catch (e: Throwable) {
+            println("error: $e")
             throw e
         }
     }
 
+    // allow any files to be selected
+    override fun isValidToolFile(file: VirtualFile?): Boolean = true
+
     override fun getCustomConfigurable(project: Project, configuration: MagoConfiguration) =
         MagoCustomOptionsForm(project, configuration)
 
diff --git a/src/main/kotlin/com/github/xepozz/mago/configuration/MagoConfigurationBaseManager.kt b/src/main/kotlin/com/github/xepozz/mago/configuration/MagoConfigurationBaseManager.kt
@@ -21,6 +21,6 @@ open class MagoConfigurationBaseManager : QualityToolConfigurationBaseManager<Ma
     companion object {
         const val MAGO = "Mago"
         const val MAGO_PATH = "MagoPath"
-        const val MAGO_ROOT_NAME = "Mago_settings"
+        const val MAGO_ROOT_NAME = "MagoSettings"
     }
 }
diff --git a/src/main/kotlin/com/github/xepozz/mago/configuration/MagoProjectConfiguration.kt b/src/main/kotlin/com/github/xepozz/mago/configuration/MagoProjectConfiguration.kt
@@ -16,7 +16,6 @@ class MagoProjectConfiguration : QualityToolProjectConfiguration<MagoConfigurati
     PersistentStateComponent<MagoProjectConfiguration> {
     var linterEnabled = true
     var formatterEnabled = true
-    var magoExecutable = "vendor/bin/mago"
     var additionalParameters = ""
 
     override fun getState() = this
diff --git a/src/main/kotlin/com/github/xepozz/mago/formatter/MagoReformatFile.kt b/src/main/kotlin/com/github/xepozz/mago/formatter/MagoReformatFile.kt
@@ -37,10 +37,7 @@ class MagoReformatFile(val project: Project) : QualityToolReformatFile() {
 
     override fun getName() = MagoBundle.message("quality.tool.mago")
 
-    override fun getToolPath(settings: QualityToolConfiguration?): String? {
-//        val settings = settings as? MagoConfiguration ?: return null
-        return this.settings.magoExecutable
-    }
+    override fun getToolPath(settings: QualityToolConfiguration?) = settings?.toolPath
 
     override fun getOptions(project: Project, virtualFiles: Array<VirtualFile>): List<String> {
         val projectPath = project.basePath ?: return emptyList()
diff --git a/src/main/kotlin/com/github/xepozz/mago/qualityTool/MagoAnnotatorProxy.kt b/src/main/kotlin/com/github/xepozz/mago/qualityTool/MagoAnnotatorProxy.kt
@@ -59,15 +59,13 @@ open class MagoAnnotatorProxy : QualityToolAnnotator<MagoValidationInspection>()
             LOG.warn("isOnTheFly is False")
         }
 
-        val settings = project.getService(MagoProjectConfiguration::class.java)
-
         return QualityToolAnnotatorInfo(
             file,
             tool,
             inspectionProfile,
             project,
             configuration.interpreterId,
-            settings.magoExecutable,
+            configuration.toolPath,
             configuration.maxMessagesPerFile,
             configuration.timeout,
             false
diff --git a/src/main/kotlin/com/github/xepozz/mago/qualityTool/MagoCustomOptionsForm.kt b/src/main/kotlin/com/github/xepozz/mago/qualityTool/MagoCustomOptionsForm.kt
@@ -2,49 +2,39 @@ package com.github.xepozz.mago.qualityTool
 
 import com.github.xepozz.mago.configuration.MagoConfiguration
 import com.intellij.openapi.project.Project
-import com.intellij.openapi.ui.DialogPanel
 import com.intellij.openapi.util.Pair
 import com.intellij.ui.dsl.builder.AlignX
 import com.intellij.ui.dsl.builder.bindText
 import com.intellij.ui.dsl.builder.panel
 import com.jetbrains.php.tools.quality.QualityToolCustomSettings
 
+// a bit useless, but still
 class MagoCustomOptionsForm(
     private val project: Project,
     private val configuration: MagoConfiguration,
 ) : QualityToolCustomSettings() {
-
-    // TODO: maybe use MagoConfiguration?
-    data class Model(
-        var customParameters: String = "",
-    )
-
-    private lateinit var panel: DialogPanel
-    private val model = Model()
-
-    override fun createComponent() = panel {
+    private var myPanel = panel {
         row("Other parameters:") {
             expandableTextField()
+                .enabled(false)
                 .align(AlignX.FILL)
-                .bindText(model::customParameters)
+                .bindText(configuration::customParameters)
         }
-    }.also { panel = it }
+    }
 
-    override fun isModified() = panel.isModified()
+    override fun createComponent() = myPanel
 
-    override fun apply() {
-        panel.apply()
+    override fun isModified() = myPanel.isModified()
 
-        configuration.customParameters = model.customParameters
+    override fun apply() {
+        myPanel.apply()
     }
 
     override fun reset() {
-        model.customParameters = configuration.customParameters
-
-        panel.reset()
+        myPanel.reset()
     }
 
     override fun getDisplayName() = null
 
-    override fun validate() = Pair.create(false, "")
+    override fun validate() = Pair.create(true, "")
 }

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,6 @@ open class MagoConfigurationBaseManager : QualityToolConfigurationBaseManager<Ma`
`21`	`21`	`companion object {`
`22`	`22`	`const val MAGO = "Mago"`
`23`	`23`	`const val MAGO_PATH = "MagoPath"`
`24`		`- const val MAGO_ROOT_NAME = "Mago_settings"`
	`24`	`+ const val MAGO_ROOT_NAME = "MagoSettings"`
`25`	`25`	`}`
`26`	`26`	`}`