feat: support mago formatter

Author: xepozz

src/main/kotlin/com/github/xepozz/mago/MagoCustomOptionsForm.kt

@@ -8,7 +8,6 @@ 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
-import javax.swing.JComponent
 
 class MagoCustomOptionsForm(
     private val project: Project,
@@ -23,22 +22,15 @@ class MagoCustomOptionsForm(
     private lateinit var panel: DialogPanel
     private val model = Model()
 
-    override fun createComponent(): JComponent {
-        panel = panel {
-            row("Other parameters:") {
-                expandableTextField()
-                    .align(AlignX.FILL)
-                    .bindText(model::customParameters)
-            }
+    override fun createComponent() = panel {
+        row("Other parameters:") {
+            expandableTextField()
+                .align(AlignX.FILL)
+                .bindText(model::customParameters)
         }
+    }.also { panel = it }
 
-        return panel
-    }
-
-    override fun isModified(): Boolean {
-        panel.reset()
-        return model.customParameters != configuration.customParameters
-    }
+    override fun isModified() = panel.isModified()
 
     override fun apply() {
         panel.apply()

src/main/kotlin/com/github/xepozz/mago/config/MagoConfigurable.kt

@@ -59,14 +59,14 @@ class MagoConfigurable(val project: Project) : Configurable {
                 row {
                     cell(OnOffButton())
                         .label("Linter")
-                        .bindSelected({ false }, {})
+                        .bindSelected({ settings.linterEnabled }, { settings.linterEnabled = (it) })
                 }.visible(true).enabled(false)
 
                 row {
                     cell(OnOffButton())
                         .label("Formatter")
-                        .bindSelected({ false }, {})
-                }.visible(true).enabled(false)
+                        .bindSelected({ settings.formatterEnabled }, { settings.formatterEnabled = (it) })
+                }
             }
             group("Options") {
                 row {

src/main/kotlin/com/github/xepozz/mago/config/MagoProjectConfiguration.kt

@@ -14,6 +14,8 @@ import com.jetbrains.php.tools.quality.QualityToolProjectConfiguration
 @State(name = "MagoProjectConfiguration", storages = [Storage(StoragePathMacros.WORKSPACE_FILE)])
 class MagoProjectConfiguration : QualityToolProjectConfiguration<MagoConfiguration>(),
     PersistentStateComponent<MagoProjectConfiguration> {
+    var linterEnabled = true
+    var formatterEnabled = true
 
     override fun getState() = this
 

src/main/kotlin/com/github/xepozz/mago/formatter/MagoExternalFormatter.kt

@@ -0,0 +1,44 @@
+package com.github.xepozz.mago.formatter
+
+import com.github.xepozz.mago.config.MagoProjectConfiguration
+import com.intellij.openapi.diagnostic.thisLogger
+import com.intellij.openapi.progress.ProgressManager
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiFile
+import com.intellij.psi.codeStyle.ExternalFormatProcessor
+import com.jetbrains.php.lang.PhpFileType
+
+class MagoExternalFormatter : ExternalFormatProcessor {
+    override fun activeForFile(source: PsiFile): Boolean {
+        val project = source.project
+        if (project.isDisposed) return false
+
+        val projectConfiguration = project.getService(MagoProjectConfiguration::class.java)
+        if (!projectConfiguration.formatterEnabled) return false
+
+        return source.fileType == PhpFileType.INSTANCE
+    }
+
+    override fun format(
+        source: PsiFile,
+        range: TextRange,
+        canChangeWhiteSpacesOnly: Boolean,
+        keepLineBreaks: Boolean,
+        enableBulkUpdate: Boolean,
+        cursorOffset: Int
+    ): TextRange? {
+        val virtualFile = source.originalFile.virtualFile
+        if (virtualFile != null) {
+            thisLogger().debug("Reformatting file: ${virtualFile.path}")
+            ProgressManager.checkCanceled()
+//            println("before: ${source.text}")
+            MagoReformatFile().invoke(source.project, source)
+            return null
+        }
+        return null
+    }
+
+    override fun indent(source: PsiFile, lineStartOffset: Int) = null
+
+    override fun getId() = "Mago"
+}

src/main/resources/META-INF/plugin.xml

@@ -14,6 +14,7 @@
     <resource-bundle>messages.MagoBundle</resource-bundle>
 
     <extensions defaultExtensionNs="com.intellij">
+        <externalFormatProcessor implementation="com.github.xepozz.mago.formatter.MagoExternalFormatter" order="first" />
         <projectConfigurable
                 instance="com.github.xepozz.mago.config.MagoConfigurable"
                 bundle="messages.MagoBundle"