src/main/kotlin/creator/ProjectSetupFinalizerWizardStep.kt diff

← → edited src/main/kotlin/creator/ProjectSetupFinalizerWizardStep.kt

Ignore whitespaces Open in IDE

⁠ rednesto: Repo-based creator templates (#2304 )

* Initial custom template system

* Add remember, editable and property derivation

* Add hidden properties

* Implement property derivation for all types

* Actual types implementation

Also fix template condition evaluation

* Some more stuff

* Some more refactoring to get things working nicely

* Move CreatorProperties to an EP

* Add property UI order

* Move custom template to a separate module builder

* Add default values to template descriptor

* Add option to output null value if default

* Add group/collapsibleGroup support

* Dropdown labels

* Use segmented buttons for options by default

* Support comma separated string lists

* Add TemplateProviders

* WIP Sponge creator

* Support built-in templates

* Support multiple templates per provider

* Remove commented code

* Remember used templates

* Move CustomPlatformStep to the appropriate package

* Fix recent template provider being saved in the recent list

Also always show the templates list in recent templates

* Switch BuiltInTemplateProvider to flat dir

* Add NeoForge specific stuff

* Add TemplateApi marker annotation for template models

* Move RecentProjectTemplates out of the models package

* Remove old commented code

* Replace usage of kotlin plugin function by stdlib one

* Always refresh template files

* Add fabric_versions

* Add license property

* Handle template descriptor deserialization errors

* Basic template inheritance and template labels

* Add basic versioning

* Display all yarn/fabric api versions if none match the selected game version

* Add property validation support

* Don't even call buildUi if property is hidden

* Add "select" derivation

* Fix templates not getting access to builtin properties

* Include license displayname in LicenseData

* Add 1.16 & 1.20.6 to MinecraftVersions

* Remove unused class

* Some ClassFqn doc & withCl...

Copy Copy

/*
* Minecraft Development for IntelliJ
*
* https://mcdev.io/
*
* Copyright (C) 2024 minecraft-dev
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, version 3.0 only.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

package com.demonwav.mcdev.creator

import com.demonwav.mcdev.asset.MCDevBundle
import com.demonwav.mcdev.creator.ProjectSetupFinalizer.Factory
import com.demonwav.mcdev.creator.step.NewProjectWizardChainStep.Companion.nextStep
import com.demonwav.mcdev.util.mapFirstNotNull
import com.intellij.ide.wizard.AbstractNewProjectWizardStep
import com.intellij.ide.wizard.NewProjectWizardStep
import com.intellij.openapi.extensions.ExtensionPointName
import com.intellij.openapi.observable.properties.GraphProperty
import com.intellij.openapi.project.Project
import com.intellij.openapi.projectRoots.JavaSdk
import com.intellij.openapi.projectRoots.JavaSdkVersion
import com.intellij.openapi.projectRoots.Sdk
import com.intellij.openapi.ui.ValidationInfo
import com.intellij.openapi.ui.validation.DialogValidation
import com.intellij.openapi.ui.validation.WHEN_GRAPH_PROPAGATION_FINISHED
import com.intellij.ui.JBColor
import com.intellij.ui.dsl.builder.Panel
import com.intellij.ui.dsl.builder.Placeholder
import javax.swing.JLabel
import javax.swing.JPanel

class ProjectSetupFinalizerWizardStep(parent: NewProjectWizardStep) : AbstractNewProjectWizardStep(parent) {
private val finalizers: List<ProjectSetupFinalizer> by lazy {
val factories = ProjectSetupFinalizer.EP_NAME.extensionList
val result = mutableListOf<ProjectSetupFinalizer>()
if (factories.isNotEmpty()) {
var par: NewProjectWizardStep = this
for (factory in factories) {
val finalizer = factory.create(par)
result += finalizer
par = finalizer
}
}
result
}
private val step by lazy {
when (finalizers.size) {
0 -> null
1 -> finalizers[0]
else -> {
var step = finalizers[0].nextStep { finalizers[1] }
for (i in 2 until finalizers.size) {
step = step.nextStep { finalizers[i] }
}
step
}
}
}

override fun setupUI(builder: Panel) {
for (step in finalizers) {
step.setupUI(builder)
}
if (finalizers.isNotEmpty()) {
builder.row {
cell(JPanel())
.validationRequestor(WHEN_GRAPH_PROPAGATION_FINISHED(propertyGraph))
.validation(
DialogValidation {
finalizers.mapFirstNotNull(ProjectSetupFinalizer::validate)?.let(::ValidationInfo)
}
)
}
}
}

override fun setupProject(project: Project) {
for (step in finalizers) {
step.setupProject(project)
}
}
}

/**
* A step applied after all other steps for all Minecraft project creators. These steps can also block project creation
* by providing extra validations.
*
* To add custom project setup finalizers, register a [Factory] to the
* `com.demonwav.minecraft-dev.projectSetupFinalizer` extension point.
*/
interface ProjectSetupFinalizer : NewProjectWizardStep {
companion object {
val EP_NAME = ExtensionPointName<Factory>("com.demonwav.minecraft-dev.projectSetupFinalizer")
}

/**
* Validates the existing settings of this wizard.
*
* @return `null` if the settings are valid, or an error message if they are invalid.
*/
fun validate(): String? = null

interface Factory {
fun create(parent: NewProjectWizardStep): ProjectSetupFinalizer
}
}

class JdkProjectSetupFinalizer(
parent: NewProjectWizardStep,
) : AbstractNewProjectWizardStep(parent), ProjectSetupFinalizer {
private val sdkProperty: GraphProperty<Sdk?> = propertyGraph.property(null)
private var sdk by sdkProperty
private var sdkComboBox: JdkComboBoxWithPreference? = null
private var preferredJdkLabel: Placeholder? = null
private var preferredJdkReason = MCDevBundle("creator.validation.jdk_preferred_default_reason")

var preferredJdk: JavaSdkVersion = JavaSdkVersion.JDK_17
private set

fun setPreferredJdk(value: JavaSdkVersion, reason: String) {
preferredJdk = value
preferredJdkReason = reason
sdkComboBox?.setPreferredJdk(value)
updatePreferredJdkLabel()
}

init {
storeToData()

sdkProperty.afterChange {
updatePreferredJdkLabel()
}
}

private fun updatePreferredJdkLabel() {
val sdk = this.sdk ?: return
val version = JavaSdk.getInstance().getVersion(sdk) ?: return
if (version == preferredJdk) {
preferredJdkLabel?.component = null
} else {
preferredJdkLabel?.component =
JLabel(MCDevBundle("creator.validation.jdk_preferred", preferredJdk.description, preferredJdkReason))
.also { it.foreground = JBColor.YELLOW }
}
}

override fun setupUI(builder: Panel) {
with(builder) {
row("JDK:") {
val sdkComboBox = jdkComboBoxWithPreference(context, sdkProperty, "${javaClass.name}.sdk")
[email protected] = sdkComboBox.component
[email protected] = placeholder()
updatePreferredJdkLabel()
}
}
}

class Factory : ProjectSetupFinalizer.Factory {
override fun create(parent: NewProjectWizardStep) = JdkProjectSetupFinalizer(parent)
}
}

/*
* Minecraft Development for IntelliJ
*
* https://mcdev.io/
*
* Copyright (C) 2024 minecraft-dev
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, version 3.0 only.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

package com.demonwav.mcdev.creator

import com.demonwav.mcdev.asset.MCDevBundle
import com.demonwav.mcdev.creator.ProjectSetupFinalizer.Factory
import com.demonwav.mcdev.creator.step.NewProjectWizardChainStep.Companion.nextStep
import com.demonwav.mcdev.util.mapFirstNotNull
import com.intellij.ide.wizard.AbstractNewProjectWizardStep
import com.intellij.ide.wizard.NewProjectWizardStep
import com.intellij.openapi.extensions.ExtensionPointName
import com.intellij.openapi.observable.properties.GraphProperty
import com.intellij.openapi.project.Project
import com.intellij.openapi.projectRoots.JavaSdk
import com.intellij.openapi.projectRoots.JavaSdkVersion
import com.intellij.openapi.projectRoots.Sdk
import com.intellij.openapi.ui.ValidationInfo
import com.intellij.openapi.ui.validation.DialogValidation
import com.intellij.openapi.ui.validation.WHEN_GRAPH_PROPAGATION_FINISHED
import com.intellij.ui.JBColor
import com.intellij.ui.dsl.builder.Panel
import com.intellij.ui.dsl.builder.Placeholder
import javax.swing.JLabel
import javax.swing.JPanel

class ProjectSetupFinalizerWizardStep(parent: NewProjectWizardStep) : AbstractNewProjectWizardStep(parent) {
private val finalizers: List<ProjectSetupFinalizer> by lazy {
val factories = ProjectSetupFinalizer.EP_NAME.extensionList
val result = mutableListOf<ProjectSetupFinalizer>()
if (factories.isNotEmpty()) {
var par: NewProjectWizardStep = this
for (factory in factories) {
val finalizer = factory.create(par)
result += finalizer
par = finalizer
}
}
result
}
private val step by lazy {
when (finalizers.size) {
0 -> null
1 -> finalizers[0]
else -> {
var step = finalizers[0].nextStep { finalizers[1] }
for (i in 2 until finalizers.size) {
step = step.nextStep { finalizers[i] }
}
step
}
}
}

override fun setupUI(builder: Panel) {
for (step in finalizers) {
step.setupUI(builder)
}
if (finalizers.isNotEmpty()) {
builder.row {
cell(JPanel())
.validationRequestor(WHEN_GRAPH_PROPAGATION_FINISHED(propertyGraph))
.validation(
DialogValidation {
finalizers.mapFirstNotNull(ProjectSetupFinalizer::validate)?.let(::ValidationInfo)
}
)
}
}
}

override fun setupProject(project: Project) {
for (step in finalizers) {
step.setupProject(project)
}
}
}

/**
* A step applied after all other steps for all Minecraft project creators. These steps can also block project creation
* by providing extra validations.
*
* To add custom project setup finalizers, register a [Factory] to the
* `com.demonwav.minecraft-dev.projectSetupFinalizer` extension point.
*/
interface ProjectSetupFinalizer : NewProjectWizardStep {
companion object {
val EP_NAME = ExtensionPointName<Factory>("com.demonwav.minecraft-dev.projectSetupFinalizer")
}

/**
* Validates the existing settings of this wizard.
*
* @return `null` if the settings are valid, or an error message if they are invalid.
*/
fun validate(): String? = null

interface Factory {
fun create(parent: NewProjectWizardStep): ProjectSetupFinalizer
}
}

class JdkProjectSetupFinalizer(
parent: NewProjectWizardStep,
) : AbstractNewProjectWizardStep(parent), ProjectSetupFinalizer {
private val sdkProperty: GraphProperty<Sdk?> = propertyGraph.property(null)
private var sdk by sdkProperty
private var sdkComboBox: JdkComboBoxWithPreference? = null
private var preferredJdkLabel: Placeholder? = null
private var preferredJdkReason = MCDevBundle("creator.validation.jdk_preferred_default_reason")

val preferredJdkProperty = propertyGraph.property(JavaSdkVersion.JDK_17)

var preferredJdk: JavaSdkVersion by preferredJdkProperty
private set

fun setPreferredJdk(value: JavaSdkVersion, reason: String) {
preferredJdk = value
preferredJdkReason = reason
sdkComboBox?.setPreferredJdk(value)
updatePreferredJdkLabel()
}

init {
storeToData()

sdkProperty.afterChange {
updatePreferredJdkLabel()
}
}

private fun updatePreferredJdkLabel() {
val sdk = this.sdk ?: return
val version = JavaSdk.getInstance().getVersion(sdk) ?: return
if (version == preferredJdk) {
preferredJdkLabel?.component = null
} else {
preferredJdkLabel?.component =
JLabel(MCDevBundle("creator.validation.jdk_preferred", preferredJdk.description, preferredJdkReason))
.also { it.foreground = JBColor.YELLOW }
}
}

override fun setupUI(builder: Panel) {
with(builder) {
row("JDK:") {
val sdkComboBox = jdkComboBoxWithPreference(context, sdkProperty, "${javaClass.name}.sdk")
[email protected] = sdkComboBox.component
[email protected] = placeholder()
updatePreferredJdkLabel()
}
}
}

class Factory : ProjectSetupFinalizer.Factory {
override fun create(parent: NewProjectWizardStep) = JdkProjectSetupFinalizer(parent)
}
}

/* * Minecraft Development for IntelliJ * * https://mcdev.io/ * * Copyright (C) 2024 minecraft-dev * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published * by the Free Software Foundation, version 3.0 only. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>. */ package com.demonwav.mcdev.creator import com.demonwav.mcdev.asset.MCDevBundle import com.demonwav.mcdev.creator.ProjectSetupFinalizer.Factory import com.demonwav.mcdev.creator.step.NewProjectWizardChainStep.Companion.nextStep import com.demonwav.mcdev.util.mapFirstNotNull import com.intellij.ide.wizard.AbstractNewProjectWizardStep import com.intellij.ide.wizard.NewProjectWizardStep import com.intellij.openapi.extensions.ExtensionPointName import com.intellij.openapi.observable.properties.GraphProperty import com.intellij.openapi.project.Project import com.intellij.openapi.projectRoots.JavaSdk import com.intellij.openapi.projectRoots.JavaSdkVersion import com.intellij.openapi.projectRoots.Sdk import com.intellij.openapi.ui.ValidationInfo import com.intellij.openapi.ui.validation.DialogValidation import com.intellij.openapi.ui.validation.WHEN_GRAPH_PROPAGATION_FINISHED import com.intellij.ui.JBColor import com.intellij.ui.dsl.builder.Panel import com.intellij.ui.dsl.builder.Placeholder import javax.swing.JLabel import javax.swing.JPanel class ProjectSetupFinalizerWizardStep(parent: NewProjectWizardStep) : AbstractNewProjectWizardStep(parent) { private val finalizers: List<ProjectSetupFinalizer> by lazy { val factories = ProjectSetupFinalizer.EP_NAME.extensionList val result = mutableListOf<ProjectSetupFinalizer>() if (factories.isNotEmpty()) { var par: NewProjectWizardStep = this for (factory in factories) { val finalizer = factory.create(par) result += finalizer par = finalizer } } result } private val step by lazy { when (finalizers.size) { 0 -> null 1 -> finalizers[0] else -> { var step = finalizers[0].nextStep { finalizers[1] } for (i in 2 until finalizers.size) { step = step.nextStep { finalizers[i] } } step } } } override fun setupUI(builder: Panel) { for (step in finalizers) { step.setupUI(builder) } if (finalizers.isNotEmpty()) { builder.row { cell(JPanel()) .validationRequestor(WHEN_GRAPH_PROPAGATION_FINISHED(propertyGraph)) .validation( DialogValidation { finalizers.mapFirstNotNull(ProjectSetupFinalizer::validate)?.let(::ValidationInfo) } ) } } } override fun setupProject(project: Project) { for (step in finalizers) { step.setupProject(project) } } } /** * A step applied after all other steps for all Minecraft project creators. These steps can also block project creation * by providing extra validations. * * To add custom project setup finalizers, register a [Factory] to the * `com.demonwav.minecraft-dev.projectSetupFinalizer` extension point. */ interface ProjectSetupFinalizer : NewProjectWizardStep { companion object { val EP_NAME = ExtensionPointName<Factory>("com.demonwav.minecraft-dev.projectSetupFinalizer") } /** * Validates the existing settings of this wizard. * * @return `null` if the settings are valid, or an error message if they are invalid. */ fun validate(): String? = null interface Factory { fun create(parent: NewProjectWizardStep): ProjectSetupFinalizer } } class JdkProjectSetupFinalizer( parent: NewProjectWizardStep, ) : AbstractNewProjectWizardStep(parent), ProjectSetupFinalizer { private val sdkProperty: GraphProperty<Sdk?> = propertyGraph.property(null) private var sdk by sdkProperty private var sdkComboBox: JdkComboBoxWithPreference? = null private var preferredJdkLabel: Placeholder? = null private var preferredJdkReason = MCDevBundle("creator.validation.jdk_preferred_default_reason") var preferredJdk: JavaSdkVersion = JavaSdkVersion.JDK_17 private set fun setPreferredJdk(value: JavaSdkVersion, reason: String) { preferredJdk = value preferredJdkReason = reason sdkComboBox?.setPreferredJdk(value) updatePreferredJdkLabel() } init { storeToData() sdkProperty.afterChange { updatePreferredJdkLabel() } } private fun updatePreferredJdkLabel() { val sdk = this.sdk ?: return val version = JavaSdk.getInstance().getVersion(sdk) ?: return if (version == preferredJdk) { preferredJdkLabel?.component = null } else { preferredJdkLabel?.component = JLabel(MCDevBundle("creator.validation.jdk_preferred", preferredJdk.description, preferredJdkReason)) .also { it.foreground = JBColor.YELLOW } } } override fun setupUI(builder: Panel) { with(builder) { row("JDK:") { val sdkComboBox = jdkComboBoxWithPreference(context, sdkProperty, "${javaClass.name}.sdk") this@JdkProjectSetupFinalizer.sdkComboBox = sdkComboBox.component this@JdkProjectSetupFinalizer.preferredJdkLabel = placeholder() updatePreferredJdkLabel() } } } class Factory : ProjectSetupFinalizer.Factory { override fun create(parent: NewProjectWizardStep) = JdkProjectSetupFinalizer(parent) } } /* * Minecraft Development for IntelliJ * * https://mcdev.io/ * * Copyright (C) 2024 minecraft-dev * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published * by the Free Software Foundation, version 3.0 only. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>. */ package com.demonwav.mcdev.creator import com.demonwav.mcdev.asset.MCDevBundle import com.demonwav.mcdev.creator.ProjectSetupFinalizer.Factory import com.demonwav.mcdev.creator.step.NewProjectWizardChainStep.Companion.nextStep import com.demonwav.mcdev.util.mapFirstNotNull import com.intellij.ide.wizard.AbstractNewProjectWizardStep import com.intellij.ide.wizard.NewProjectWizardStep import com.intellij.openapi.extensions.ExtensionPointName import com.intellij.openapi.observable.properties.GraphProperty import com.intellij.openapi.project.Project import com.intellij.openapi.projectRoots.JavaSdk import com.intellij.openapi.projectRoots.JavaSdkVersion import com.intellij.openapi.projectRoots.Sdk import com.intellij.openapi.ui.ValidationInfo import com.intellij.openapi.ui.validation.DialogValidation import com.intellij.openapi.ui.validation.WHEN_GRAPH_PROPAGATION_FINISHED import com.intellij.ui.JBColor import com.intellij.ui.dsl.builder.Panel import com.intellij.ui.dsl.builder.Placeholder import javax.swing.JLabel import javax.swing.JPanel class ProjectSetupFinalizerWizardStep(parent: NewProjectWizardStep) : AbstractNewProjectWizardStep(parent) { private val finalizers: List<ProjectSetupFinalizer> by lazy { val factories = ProjectSetupFinalizer.EP_NAME.extensionList val result = mutableListOf<ProjectSetupFinalizer>() if (factories.isNotEmpty()) { var par: NewProjectWizardStep = this for (factory in factories) { val finalizer = factory.create(par) result += finalizer par = finalizer } } result } private val step by lazy { when (finalizers.size) { 0 -> null 1 -> finalizers[0] else -> { var step = finalizers[0].nextStep { finalizers[1] } for (i in 2 until finalizers.size) { step = step.nextStep { finalizers[i] } } step } } } override fun setupUI(builder: Panel) { for (step in finalizers) { step.setupUI(builder) } if (finalizers.isNotEmpty()) { builder.row { cell(JPanel()) .validationRequestor(WHEN_GRAPH_PROPAGATION_FINISHED(propertyGraph)) .validation( DialogValidation { finalizers.mapFirstNotNull(ProjectSetupFinalizer::validate)?.let(::ValidationInfo) } ) } } } override fun setupProject(project: Project) { for (step in finalizers) { step.setupProject(project) } } } /** * A step applied after all other steps for all Minecraft project creators. These steps can also block project creation * by providing extra validations. * * To add custom project setup finalizers, register a [Factory] to the * `com.demonwav.minecraft-dev.projectSetupFinalizer` extension point. */ interface ProjectSetupFinalizer : NewProjectWizardStep { companion object { val EP_NAME = ExtensionPointName<Factory>("com.demonwav.minecraft-dev.projectSetupFinalizer") } /** * Validates the existing settings of this wizard. * * @return `null` if the settings are valid, or an error message if they are invalid. */ fun validate(): String? = null interface Factory { fun create(parent: NewProjectWizardStep): ProjectSetupFinalizer } } class JdkProjectSetupFinalizer( parent: NewProjectWizardStep, ) : AbstractNewProjectWizardStep(parent), ProjectSetupFinalizer { private val sdkProperty: GraphProperty<Sdk?> = propertyGraph.property(null) private var sdk by sdkProperty private var sdkComboBox: JdkComboBoxWithPreference? = null private var preferredJdkLabel: Placeholder? = null private var preferredJdkReason = MCDevBundle("creator.validation.jdk_preferred_default_reason") val preferredJdkProperty = propertyGraph.property(JavaSdkVersion.JDK_17) var preferredJdk: JavaSdkVersion by preferredJdkProperty private set fun setPreferredJdk(value: JavaSdkVersion, reason: String) { preferredJdk = value preferredJdkReason = reason sdkComboBox?.setPreferredJdk(value) updatePreferredJdkLabel() } init { storeToData() sdkProperty.afterChange { updatePreferredJdkLabel() } } private fun updatePreferredJdkLabel() { val sdk = this.sdk ?: return val version = JavaSdk.getInstance().getVersion(sdk) ?: return if (version == preferredJdk) { preferredJdkLabel?.component = null } else { preferredJdkLabel?.component = JLabel(MCDevBundle("creator.validation.jdk_preferred", preferredJdk.description, preferredJdkReason)) .also { it.foreground = JBColor.YELLOW } } } override fun setupUI(builder: Panel) { with(builder) { row("JDK:") { val sdkComboBox = jdkComboBoxWithPreference(context, sdkProperty, "${javaClass.name}.sdk") this@JdkProjectSetupFinalizer.sdkComboBox = sdkComboBox.component this@JdkProjectSetupFinalizer.preferredJdkLabel = placeholder() updatePreferredJdkLabel() } } } class Factory : ProjectSetupFinalizer.Factory { override fun create(parent: NewProjectWizardStep) = JdkProjectSetupFinalizer(parent) } }

Add build comment

Mute test

Server communication failure

Run Custom Build

TODO

Responsibility

Edit tags

Loading...

Are you sure?