feat: add project wizard

Author: xepozz

src/main/kotlin/com/github/tempest/framework/scaffolder/project/TempestGeneratorProjectWizard.kt

@@ -0,0 +1,22 @@
+package com.github.tempest.framework.scaffolder.project
+
+import com.github.tempest.framework.TempestIcons
+import com.github.tempest.framework.scaffolder.project.override.WebTemplateProjectWizardStep
+import com.intellij.ide.util.projectWizard.WebTemplateNewProjectWizardBase
+import com.intellij.ide.wizard.NewProjectWizardBaseStep
+import com.intellij.ide.wizard.NewProjectWizardChainStep.Companion.nextStep
+import com.intellij.ide.wizard.NewProjectWizardStep
+import com.intellij.ide.wizard.RootNewProjectWizardStep
+
+class TempestGeneratorProjectWizard : WebTemplateNewProjectWizardBase() {
+    override val id = "tempest-project"
+    override val name = "Tempest"
+    override val icon = TempestIcons.TEMPEST
+
+    val template = TempestProjectGenerator()
+
+    override fun createTemplateStep(parent: NewProjectWizardBaseStep): NewProjectWizardStep {
+        return RootNewProjectWizardStep(parent.context)
+            .nextStep { WebTemplateProjectWizardStep(parent, template) }
+    }
+}

src/main/kotlin/com/github/tempest/framework/scaffolder/project/TempestModuleBuilder.kt

@@ -0,0 +1,6 @@
+package com.github.tempest.framework.scaffolder.project
+
+import com.intellij.ide.wizard.GeneratorNewProjectWizardBuilderAdapter
+
+class TempestModuleBuilder: GeneratorNewProjectWizardBuilderAdapter(TempestGeneratorProjectWizard()) {
+}

src/main/kotlin/com/github/tempest/framework/scaffolder/project/TempestProjectGenerator.kt

@@ -0,0 +1,59 @@
+package com.github.tempest.framework.scaffolder.project
+
+import com.intellij.execution.configurations.PathEnvironmentVariableUtil
+import com.intellij.ide.util.projectWizard.WebProjectTemplate
+import com.intellij.openapi.module.Module
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.vfs.VirtualFile
+import com.jetbrains.php.composer.ComposerProjectGenerator
+import com.jetbrains.php.composer.ComposerProjectSettings
+import com.jetbrains.php.composer.addDependency.ComposerPackage
+import com.jetbrains.php.composer.execution.ComposerExecution
+import com.jetbrains.php.composer.execution.executable.ExecutableComposerExecution
+import com.jetbrains.php.composer.execution.phar.PharComposerExecution
+import com.jetbrains.php.config.interpreters.PhpInterpretersManagerImpl
+
+class TempestProjectGenerator : WebProjectTemplate<TempestProjectGeneratorSettings>() {
+    override fun getName() = "Tempest"
+
+    override fun generateProject(
+        project: Project,
+        baseDir: VirtualFile,
+        settings: TempestProjectGeneratorSettings,
+        module: Module
+    ) {
+        val isDownload = PathEnvironmentVariableUtil.findExecutableInPathOnAnyOS("composer") == null
+        val composerExecutable = when {
+            isDownload -> {
+                val phpInterpretersManager = PhpInterpretersManagerImpl.getInstance(project)
+                PharComposerExecution(
+                    phpInterpretersManager.interpreters.firstOrNull()?.id,
+                    "",
+                    false,
+                )
+            }
+
+            else -> ExecutableComposerExecution("composer")
+        }
+
+        println("generateProject: $baseDir, $settings, $module")
+        val version = if (settings.version != "latest") settings.version else null
+
+        val composerSettings = ComposerProjectSettings(
+            isDownload,
+            ComposerPackage(settings.template),
+            version,
+            "--no-progress --no-interaction --ansi --remove-vcs",
+            composerExecutable as ComposerExecution,
+            null,
+            settings.createGit,
+        )
+        ComposerProjectGenerator().generateProject(project, baseDir, composerSettings, module)
+
+        println("generateProject: $baseDir, $settings, $module")
+    }
+
+    override fun createPeer() = TempestProjectPeer()
+
+    override fun getDescription() = "Tempest project template"
+}

src/main/kotlin/com/github/tempest/framework/scaffolder/project/TempestProjectGeneratorSettings.kt

@@ -0,0 +1,7 @@
+package com.github.tempest.framework.scaffolder.project
+
+data class TempestProjectGeneratorSettings(
+    var version: String = "latest",
+    var createGit: Boolean = true,
+    var template: String = "tempest/app",
+)

src/main/kotlin/com/github/tempest/framework/scaffolder/project/TempestProjectPeer.kt

@@ -0,0 +1,67 @@
+package com.github.tempest.framework.scaffolder.project
+
+import com.intellij.ide.util.projectWizard.SettingsStep
+import com.intellij.openapi.application.ApplicationManager
+import com.intellij.openapi.application.ModalityState
+import com.intellij.openapi.application.ReadAction
+import com.intellij.openapi.ui.TextFieldWithBrowseButton
+import com.intellij.openapi.ui.ValidationInfo
+import com.intellij.platform.GeneratorPeerImpl
+import com.intellij.ui.MutableCollectionComboBoxModel
+import com.intellij.ui.dsl.builder.bindItem
+import com.intellij.ui.dsl.builder.bindSelected
+import com.intellij.ui.dsl.builder.panel
+import com.intellij.ui.dsl.builder.toNullableProperty
+import com.intellij.util.concurrency.AppExecutorUtil
+import com.jetbrains.php.composer.addDependency.ComposerPackage
+import com.jetbrains.php.composer.json.PhpComposerJsonCompletionContributor.PhpComposerPackageVersionsProvider
+import java.util.concurrent.Callable
+
+class TempestProjectPeer() : GeneratorPeerImpl<TempestProjectGeneratorSettings>() {
+    var versions = MutableCollectionComboBoxModel(mutableListOf("latest"))
+    val mySettings = TempestProjectGeneratorSettings()
+
+    val myPanel = panel {
+        row("Template") {
+            comboBox(listOf("tempest/app"))
+                .bindItem(mySettings::template.toNullableProperty())
+        }
+        row("Version") {
+            comboBox(versions)
+                .bindItem(mySettings::version.toNullableProperty())
+        }
+        row("Create Git") {
+            checkBox("")
+                .bindSelected(mySettings::createGit)
+        }
+    }
+
+    init {
+        ApplicationManager.getApplication().invokeLater {
+            ReadAction.nonBlocking(Callable {
+                PhpComposerPackageVersionsProvider
+                    .fetchPackageVersions("tempest/app")
+                    .sortedWith(ComposerPackage.VERSIONS_COMPARATOR)
+                    .apply { versions.add(this) }
+            })
+                .finishOnUiThread(ModalityState.defaultModalityState()) {}
+                .submit(AppExecutorUtil.getAppExecutorService())
+        }
+    }
+
+    override fun getComponent(myLocationField: TextFieldWithBrowseButton, checkValid: Runnable) = myPanel
+
+    override fun buildUI(settingsStep: SettingsStep) {
+        settingsStep.addSettingsComponent(myPanel)
+    }
+
+    override fun getSettings(): TempestProjectGeneratorSettings {
+        myPanel.apply()
+        return mySettings
+    }
+
+    override fun validate(): ValidationInfo? {
+        myPanel.validate()
+        return myPanel.validateAll().firstOrNull()
+    }
+}

src/main/kotlin/com/github/tempest/framework/scaffolder/project/override/PanelBuilderSettingsStep.kt

@@ -0,0 +1,69 @@
+package com.github.tempest.framework.scaffolder.project.override
+
+import com.intellij.ide.util.projectWizard.ModuleNameLocationSettings
+import com.intellij.ide.util.projectWizard.SettingsStep
+import com.intellij.ide.util.projectWizard.WizardContext
+import com.intellij.ide.wizard.NewProjectWizardBaseStep
+import com.intellij.openapi.util.io.FileUtil
+import com.intellij.ui.dsl.builder.AlignX
+import com.intellij.ui.dsl.builder.BottomGap
+import com.intellij.ui.dsl.builder.Panel
+import com.intellij.util.PathUtil
+import java.io.File
+import javax.swing.JComponent
+
+/**
+ * Port of [com.intellij.ide.util.projectWizard.PanelBuilderSettingsStep]
+ */
+class PanelBuilderSettingsStep(
+    private val wizardContext: WizardContext,
+    private val builder: Panel,
+    private val baseStep: NewProjectWizardBaseStep
+) : SettingsStep {
+    override fun getContext(): WizardContext = wizardContext
+
+    override fun addSettingsField(label: String, field: JComponent) {
+        with(builder) {
+            row(label) {
+                cell(field).align(AlignX.FILL)
+            }.bottomGap(BottomGap.SMALL)
+        }
+    }
+
+    override fun addSettingsComponent(component: JComponent) {
+        with(builder) {
+//            row("") { <---- seems like a bug, it adds left padding
+            row {
+                cell(component).align(AlignX.FILL)
+            }.bottomGap(BottomGap.SMALL)
+        }
+    }
+
+    override fun addExpertPanel(panel: JComponent) {
+        addSettingsComponent(panel)
+    }
+
+    override fun addExpertField(label: String, field: JComponent) {
+        addSettingsField(label, field)
+    }
+
+    override fun getModuleNameLocationSettings(): ModuleNameLocationSettings {
+        return object : ModuleNameLocationSettings {
+            override fun getModuleName(): String = baseStep.name
+
+            override fun setModuleName(moduleName: String) {
+                baseStep.name = moduleName
+            }
+
+            override fun getModuleContentRoot(): String {
+                return FileUtil.toSystemDependentName(baseStep.path)
+                    .trimEnd(File.separatorChar) + File.separatorChar + baseStep.name
+            }
+
+            override fun setModuleContentRoot(path: String) {
+                baseStep.path = PathUtil.getParentPath(path)
+                baseStep.name = PathUtil.getFileName(path)
+            }
+        }
+    }
+}

src/main/kotlin/com/github/tempest/framework/scaffolder/project/override/WebTemplateProjectWizardStep.kt

@@ -0,0 +1,37 @@
+package com.github.tempest.framework.scaffolder.project.override
+
+import com.github.tempest.framework.scaffolder.project.TempestProjectGenerator
+import com.github.tempest.framework.scaffolder.project.TempestProjectGeneratorSettings
+import com.intellij.ide.highlighter.ModuleFileType
+import com.intellij.ide.wizard.AbstractNewProjectWizardStep
+import com.intellij.ide.wizard.NewProjectWizardBaseStep
+import com.intellij.openapi.module.WebModuleBuilder
+import com.intellij.openapi.project.Project
+import com.intellij.ui.dsl.builder.Panel
+import java.nio.file.Path
+
+class WebTemplateProjectWizardStep(
+    val parentStep: NewProjectWizardBaseStep,
+    val template: TempestProjectGenerator,
+) : AbstractNewProjectWizardStep(parentStep) {
+    val peer = template.createLazyPeer()
+
+    override fun setupUI(builder: Panel) {
+        peer.value.buildUI(PanelBuilderSettingsStep(parentStep.context, builder, parentStep))
+    }
+
+    override fun setupProject(project: Project) {
+        webModuleBuilder().commitModule(project, null)
+    }
+
+    private fun webModuleBuilder(): WebModuleBuilder<TempestProjectGeneratorSettings> {
+        val moduleName = parentStep.name
+        val projectPath = Path.of(parentStep.path, moduleName)
+
+        return WebModuleBuilder(template, peer).apply {
+            contentEntryPath = projectPath.toString()
+            moduleFilePath = projectPath.resolve(moduleName + ModuleFileType.DOT_DEFAULT_EXTENSION).toString()
+            name = moduleName
+        }
+    }
+}

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

@@ -59,6 +59,11 @@
         <fileBasedIndex
                 implementation="com.github.tempest.framework.router.index.RoutesListIndex"/>
 
+        <directoryProjectGenerator
+                implementation="com.github.tempest.framework.scaffolder.project.TempestProjectGenerator" />
+        <moduleBuilder
+                builderClass="com.github.tempest.framework.scaffolder.project.TempestModuleBuilder" />
+
         <psi.referenceContributor
                 language="PHP"
                 implementation="com.github.tempest.framework.db.references.QueryBuilderReferenceContributor"/>