feat: console command runners

Author: xepozz

src/main/kotlin/com/github/tempest/framework/console/run/ConsoleCommandLineMarkerProvider.kt

@@ -0,0 +1,12 @@
+package com.github.tempest.framework.console.run
+
+import com.intellij.execution.lineMarker.RunLineMarkerContributor
+import com.intellij.psi.PsiElement
+import com.jetbrains.php.lang.psi.elements.Method
+
+class ConsoleCommandLineMarkerProvider : RunLineMarkerContributor() {
+    override fun getInfo(element: PsiElement) = when {
+        element !is Method -> null
+        else -> Info(TempestRunTargetAction(element))
+    }
+}

src/main/kotlin/com/github/tempest/framework/console/run/TempestConsoleCommandRunConfiguration.kt

@@ -0,0 +1,35 @@
+package com.github.tempest.framework.console.run
+
+import com.intellij.execution.configurations.ConfigurationFactory
+import com.intellij.execution.configurations.RunConfigurationOptions
+import com.intellij.openapi.project.Project
+import com.jetbrains.php.config.commandLine.PhpCommandSettings
+import com.jetbrains.php.run.PhpCommandLineRunConfiguration
+
+class TempestConsoleCommandRunConfiguration(
+    project: Project,
+    factory: ConfigurationFactory,
+    name: String
+) : PhpCommandLineRunConfiguration<TempestConsoleCommandRunConfigurationSettings>(project, factory, name) {
+    override fun fillCommandSettings(
+        envs: Map<String, String>,
+        command: PhpCommandSettings
+    ) {
+        val commandName = settings.commandName ?: return
+        command.setScript("tempest", false)
+        command.addArgument(commandName)
+
+        command.importCommandLineSettings(settings.commandLineSettings, command.workingDirectory)
+        command.addEnvs(envs)
+    }
+
+    override fun getOptions() = super.getOptions() as TempestConsoleCommandRunConfigurationSettings
+    override fun getOptionsClass(): Class<out RunConfigurationOptions> {
+        return TempestConsoleCommandRunConfigurationSettings::class.java
+    }
+
+    override fun getConfigurationEditor() = TempestConsoleCommandSettingsEditor(project)
+
+    override fun createSettings() = TempestConsoleCommandRunConfigurationSettings().apply {
+    }
+}

src/main/kotlin/com/github/tempest/framework/console/run/TempestConsoleCommandRunConfigurationSettings.kt

@@ -0,0 +1,37 @@
+package com.github.tempest.framework.console.run
+
+import com.intellij.execution.configurations.LocatableRunConfigurationOptions
+import com.jetbrains.php.run.PhpCommandLineSettings
+import com.jetbrains.php.run.PhpRunConfigurationSettings
+
+class TempestConsoleCommandRunConfigurationSettings : PhpRunConfigurationSettings, LocatableRunConfigurationOptions() {
+    private val myCommandName = string("").provideDelegate(this, "commandName")
+    private val myBinary = string("./tempest").provideDelegate(this, "binary")
+    private val myWorkingDirectory = string("").provideDelegate(this, "binary")
+
+    var commandName: String?
+        get() = myCommandName.getValue(this)
+        set(scriptName) {
+            myCommandName.setValue(this, scriptName)
+        }
+
+    var binary: String?
+        get() = myBinary.getValue(this)
+        set(scriptName) {
+            myBinary.setValue(this, scriptName)
+        }
+
+    var documentRoot: String?
+        get() = myBinary.getValue(this)
+        set(scriptName) {
+            myBinary.setValue(this, scriptName)
+        }
+
+    var commandLineSettings = PhpCommandLineSettings()
+
+    override fun getWorkingDirectory() = myWorkingDirectory.getValue(this)
+
+    override fun setWorkingDirectory(p0: String?) {
+        myWorkingDirectory.setValue(this, p0)
+    }
+}

src/main/kotlin/com/github/tempest/framework/console/run/TempestConsoleCommandRunConfigurationType.kt

@@ -0,0 +1,30 @@
+package com.github.tempest.framework.console.run
+
+import com.github.tempest.framework.TempestIcons
+import com.intellij.execution.configurations.ConfigurationFactory
+import com.intellij.execution.configurations.ConfigurationTypeBase
+import com.intellij.openapi.project.Project
+
+class TempestConsoleCommandRunConfigurationType : ConfigurationTypeBase(
+    ID,
+    "Tempest Command",
+    "Runs console command",
+    TempestIcons.TEMPEST,
+) {
+    init {
+        addFactory(object : ConfigurationFactory(this) {
+            override fun getId() = ID
+
+            override fun createTemplateConfiguration(project: Project) =
+                TempestConsoleCommandRunConfiguration(project, this, "Tempest")
+
+            override fun getOptionsClass() = TempestConsoleCommandRunConfigurationSettings::class.java
+        })
+    }
+
+    companion object {
+        const val ID = "TempestConsoleCommandRunConfiguration"
+
+        val INSTANCE = TempestConsoleCommandRunConfigurationType()
+    }
+}

src/main/kotlin/com/github/tempest/framework/console/run/TempestConsoleCommandSettingsEditor.kt

@@ -0,0 +1,58 @@
+package com.github.tempest.framework.console.run
+
+import com.intellij.openapi.options.SettingsEditor
+import com.intellij.openapi.ui.DialogPanel
+import com.intellij.ui.dsl.builder.Align
+import com.intellij.ui.dsl.builder.LabelPosition
+import com.intellij.ui.dsl.builder.TopGap
+import com.intellij.ui.dsl.builder.panel
+import com.jetbrains.php.run.PhpCommandLineConfigurationEditor
+import javax.swing.JPanel
+import javax.swing.JTextField
+
+private fun PhpCommandLineConfigurationEditor.getMainPanel(): JPanel? {
+    val reflection = PhpCommandLineConfigurationEditor::class.java.getDeclaredField("myMainPanel")
+    reflection.isAccessible = true
+    return reflection.get(this) as JPanel?
+}
+
+class TempestConsoleCommandSettingsEditor private constructor(): SettingsEditor<TempestConsoleCommandRunConfiguration>() {
+    private val commandNameField = JTextField()
+    private val phpCommandLineConfigurationEditor = PhpCommandLineConfigurationEditor()
+
+    private lateinit var myPanel: DialogPanel
+
+    constructor(project: com.intellij.openapi.project.Project) : this() {
+        myPanel = panel {
+            row {
+                cell(commandNameField)
+                    .label("Command:", LabelPosition.LEFT)
+                    .align(Align.FILL)
+            }.topGap(TopGap.MEDIUM)
+
+            row {
+                phpCommandLineConfigurationEditor.init(project, true)
+                phpCommandLineConfigurationEditor.getMainPanel()?.apply {
+                    scrollCell(this).align(Align.FILL)
+                }
+            }.topGap(TopGap.MEDIUM)
+        }
+    }
+
+    override fun resetEditorFrom(tempestConsoleCommandRunConfiguration: TempestConsoleCommandRunConfiguration) {
+        val settings = tempestConsoleCommandRunConfiguration.settings
+
+        myPanel.reset()
+        commandNameField.text = settings.commandName
+        phpCommandLineConfigurationEditor.resetEditorFrom(settings.commandLineSettings)
+    }
+
+    override fun applyEditorTo(tempestConsoleCommandRunConfiguration: TempestConsoleCommandRunConfiguration) {
+        val settings = tempestConsoleCommandRunConfiguration.settings
+
+        settings.commandName = commandNameField.text
+        phpCommandLineConfigurationEditor.applyEditorTo(settings.commandLineSettings)
+    }
+
+    override fun createEditor() = myPanel
+}

src/main/kotlin/com/github/tempest/framework/console/run/TempestRunConfigurationFactory.kt

@@ -0,0 +1,13 @@
+package com.github.tempest.framework.console.run
+
+import com.intellij.execution.configurations.ConfigurationFactory
+import com.intellij.openapi.project.Project
+
+class TempestRunConfigurationFactory(private val runConfigurationType: TempestConsoleCommandRunConfigurationType) :
+    ConfigurationFactory(runConfigurationType) {
+    override fun getId() = TempestConsoleCommandRunConfigurationType.ID
+    override fun getName() = runConfigurationType.displayName
+
+    override fun createTemplateConfiguration(project: Project) =
+        TempestConsoleCommandRunConfiguration(project, this, "name")
+}

src/main/kotlin/com/github/tempest/framework/console/run/TempestRunConfigurationProducer.kt

@@ -0,0 +1,35 @@
+package com.github.tempest.framework.console.run
+
+import com.github.tempest.framework.php.getConsoleCommandName
+import com.intellij.execution.actions.ConfigurationContext
+import com.intellij.execution.actions.LazyRunConfigurationProducer
+import com.intellij.openapi.util.Ref
+import com.intellij.psi.PsiElement
+import com.jetbrains.php.lang.psi.elements.Method
+
+class TempestRunConfigurationProducer : LazyRunConfigurationProducer<TempestConsoleCommandRunConfiguration>() {
+    override fun setupConfigurationFromContext(
+        configuration: TempestConsoleCommandRunConfiguration,
+        context: ConfigurationContext,
+        sourceElement: Ref<PsiElement>
+    ): Boolean {
+        val element = context.psiLocation as? Method ?: return false
+
+        configuration.settings.commandName = element.getConsoleCommandName() ?: return false
+        configuration.name = "tempest ${configuration.settings.commandName}"
+
+        return true
+    }
+
+    override fun isConfigurationFromContext(
+        configuration: TempestConsoleCommandRunConfiguration,
+        context: ConfigurationContext
+    ): Boolean {
+        val method = context.psiLocation as? Method ?: return false
+
+        return configuration.settings.commandName == method.getConsoleCommandName()
+    }
+
+    override fun getConfigurationFactory() =
+        TempestRunConfigurationFactory(TempestConsoleCommandRunConfigurationType.INSTANCE)
+}

src/main/kotlin/com/github/tempest/framework/console/run/TempestRunTargetAction.kt

@@ -0,0 +1,34 @@
+package com.github.tempest.framework.console.run
+
+import com.github.tempest.framework.TempestBundle
+import com.intellij.execution.Executor
+import com.intellij.execution.Location
+import com.intellij.execution.PsiLocation
+import com.intellij.execution.RunManagerEx
+import com.intellij.execution.actions.ConfigurationContext
+import com.intellij.execution.runners.ExecutionUtil
+import com.intellij.icons.AllIcons
+import com.intellij.openapi.actionSystem.AnAction
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.actionSystem.impl.SimpleDataContext
+import com.jetbrains.php.lang.psi.elements.Method
+
+internal class TempestRunTargetAction(private val target: Method) : AnAction() {
+    init {
+        templatePresentation.setText(TempestBundle.message("action.run.target.text", target.name), false)
+        templatePresentation.description = TempestBundle.message("action.run.target.description", target.name)
+        templatePresentation.icon = AllIcons.Actions.Execute
+    }
+
+    override fun actionPerformed(event: AnActionEvent) {
+        val dataContext = SimpleDataContext.getSimpleContext(Location.DATA_KEY, PsiLocation(target), event.dataContext)
+
+        val context = ConfigurationContext.getFromContext(dataContext, event.place)
+
+        val producer = TempestRunConfigurationProducer()
+        val configuration = producer.findOrCreateConfigurationFromContext(context)?.configurationSettings ?: return
+
+        (context.runManager as RunManagerEx).setTemporaryConfiguration(configuration)
+        ExecutionUtil.runConfiguration(configuration, Executor.EXECUTOR_EXTENSION_NAME.extensionList.first())
+    }
+}

src/main/kotlin/com/github/tempest/framework/php/mixin.kt

@@ -1,7 +1,10 @@
 package com.github.tempest.framework.php
 
+import com.github.tempest.framework.TempestFrameworkClasses
+import com.intellij.openapi.util.text.StringUtil
 import com.intellij.psi.util.PsiTreeUtil
 import com.jetbrains.php.lang.psi.PhpFile
+import com.jetbrains.php.lang.psi.elements.Method
 import com.jetbrains.php.lang.psi.elements.Variable
 
 fun PhpFile.getPhpViewVariables(): Set<Variable> {
@@ -11,3 +14,14 @@ fun PhpFile.getPhpViewVariables(): Set<Variable> {
         .distinctBy { it.name }
         .toSet()
 }
+
+fun Method.getConsoleCommandName(): String? {
+    return this
+        .getAttributes(TempestFrameworkClasses.ConsoleCommand)
+        .firstOrNull()
+        ?.arguments
+        ?.run { this.find { it.name == "name" } ?: firstOrNull() }
+        ?.argument
+        ?.value
+        ?.run { StringUtil.unquoteString(this) }
+}

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

@@ -10,6 +10,11 @@
     <resource-bundle>messages.TempestBundle</resource-bundle>
 
     <extensions defaultExtensionNs="com.intellij">
+        <configurationType
+                implementation="com.github.tempest.framework.console.run.TempestConsoleCommandRunConfigurationType"/>
+        <runLineMarkerContributor
+                language="PHP"
+                implementationClass="com.github.tempest.framework.console.run.ConsoleCommandLineMarkerProvider" />
         <multiHostInjector
                 implementation="com.github.tempest.framework.views.injection.PHPLanguageInjector"/>
         <webSymbols.webTypes
@@ -35,6 +40,5 @@
                 implementation="com.github.tempest.framework.router.index.RouterActionsIndex" />
     </extensions>
     <extensions defaultExtensionNs="com.jetbrains.php">
-
     </extensions>
 </idea-plugin>