feat: Improve about plugin dialog

Author: marcelkliemannel

CHANGELOG.md

@@ -16,6 +16,7 @@
 
 - All encoding/decoding, escaping/unescaping and text transformation tools now also support reading from and writing to files.
 - New "Escape Sequence" tool for escaping/unescaping line breaks, tabs, backslashes, and single/double quotes.
+- New "JSON Handling" settings that allow very fine-grained control over the features for reading and writing JSON in all tools. This makes it possible to handle certain non-standard JSON features, such as comments.
 - Added a setting to control the number of decimal places in the "Color Picker" tool.
 
 ### Changed

build.gradle.kts

@@ -158,24 +158,6 @@ changelog {
   groups.set(listOf("Added", "Changed", "Removed", "Fixed"))
 }
 
-val writeChangelogToFileTask =
-  tasks.register("writeChangelogToFile") {
-    val generatedResourcesDir = layout.buildDirectory.dir("generated-resources/changelog").get()
-    outputs.dir(generatedResourcesDir)
-
-    doLast {
-      val renderResult =
-        changelog.instance.get().releasedItems.joinToString("\n") {
-          changelog.renderItem(it, Changelog.OutputType.HTML)
-        }
-      val baseDir = generatedResourcesDir.dir("dev/turingcomplete/intellijdevelopertoolsplugin")
-      file(baseDir).mkdirs()
-      file(baseDir.file("changelog.html")).writeText(renderResult)
-    }
-  }
-
-sourceSets { main { resources { srcDir(writeChangelogToFileTask) } } }
-
 tasks {
   named("publishPlugin") {
     dependsOn("check")

gradle.properties

@@ -4,6 +4,7 @@ org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryErro
 pluginId=dev.turingcomplete.intellijdevelopertoolsplugins
 pluginGroup=dev.turingcomplete
 pluginVersion=7.0.0
+pluginName=Developer Tools
 pluginSinceBuild=243
 platform=IC
 # LATEST-EAP-SNAPSHOT

modules/common/build.gradle.kts

@@ -34,6 +34,7 @@ val generatePluginProperties by
         """
             pluginId=${project.property("pluginId")}
             pluginVersion=${project.property("pluginVersion")}
+            pluginName=${project.property("pluginName")}
             """
           .trimIndent()
       )

modules/common/src/main/kotlin/dev/turingcomplete/intellijdevelopertoolsplugin/common/PluginInfo.kt

@@ -14,6 +14,7 @@ object PluginInfo {
   val pluginVersion: PluginVersion by lazy {
     pluginProperties.getProperty("pluginVersion").toPluginVersion()
   }
+  val pluginName: String by lazy { pluginProperties.getProperty("pluginName") }
 
   // -- Initialization ------------------------------------------------------ //
   // -- Exported Methods ---------------------------------------------------- //

modules/tools/ui/build.gradle.kts

@@ -1,5 +1,8 @@
+import org.jetbrains.changelog.Changelog
+
 plugins {
   `java-test-fixtures`
+  alias(libs.plugins.changelog)
 }
 
 dependencies {
@@ -41,3 +44,32 @@ dependencies {
   testFixturesApi(project(":common"))
   testFixturesApi(project(":settings"))
 }
+
+changelog {
+  path.set(rootProject.file("CHANGELOG.md").path)
+}
+
+val writeChangelogToFileTask =
+  tasks.register("writeChangelogToFile") {
+    val generatedResourcesDir = layout.buildDirectory.dir("generated-resources/changelog").get()
+    outputs.dir(generatedResourcesDir)
+
+    doLast {
+      val renderResult =
+        changelog.instance.get().releasedItems.joinToString("\n") {
+          changelog.renderItem(it, Changelog.OutputType.HTML)
+        }
+      val baseDir = generatedResourcesDir.dir("dev/turingcomplete/intellijdevelopertoolsplugin")
+      file(baseDir).mkdirs()
+      file(baseDir.file("changelog.html")).writeText(renderResult)
+    }
+  }
+
+sourceSets { main { resources { srcDir(writeChangelogToFileTask.map { it.outputs.files }) } } }
+
+tasks.withType(org.jetbrains.changelog.tasks.InitializeChangelogTask::class).configureEach {
+  enabled = false
+}
+tasks.withType(org.jetbrains.changelog.tasks.PatchChangelogTask::class).configureEach {
+  enabled = false
+}

modules/tools/ui/src/main/kotlin/dev/turingcomplete/intellijdevelopertoolsplugin/tool/ui/frame/AboutPluginDialog.kt

@@ -0,0 +1,99 @@
+package dev.turingcomplete.intellijdevelopertoolsplugin.tool.ui.frame
+
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.ui.DialogWrapper
+import com.intellij.ui.ScrollPaneFactory
+import com.intellij.ui.components.JBTabbedPane
+import com.intellij.ui.dsl.builder.Align
+import com.intellij.ui.dsl.builder.BottomGap
+import com.intellij.ui.dsl.builder.RightGap
+import com.intellij.ui.dsl.builder.TopGap
+import com.intellij.ui.dsl.builder.panel
+import com.intellij.util.ui.JBEmptyBorder
+import dev.turingcomplete.intellijdevelopertoolsplugin.common.PluginInfo
+import java.awt.Dimension
+import javax.swing.Action
+import javax.swing.JComponent
+
+class AboutPluginDialog(project: Project?, parentComponent: JComponent) :
+  DialogWrapper(project, parentComponent, true, IdeModalityType.IDE) {
+  // -- Properties ---------------------------------------------------------- //
+  // -- Initialization ------------------------------------------------------ //
+
+  init {
+    title = "${PluginInfo.pluginName} - About Plugin"
+    isModal = true
+    init()
+  }
+
+  // -- Exported Methods ---------------------------------------------------- //
+
+  override fun createCenterPanel(): JComponent {
+    val panel = panel {
+      row {
+        val tabs =
+          mapOf("About" to createAboutPluginComponent(), "Changelog" to createChangelogComponent())
+
+        cell(
+            JBTabbedPane().apply {
+              tabs.forEach { (title, component) ->
+                // Create scroll panes with specific preferred size
+                val scrollPane = ScrollPaneFactory.createScrollPane(component, true)
+                scrollPane.preferredSize = Dimension(650, 500)
+                addTab(title, scrollPane)
+              }
+            }
+          )
+          .align(Align.FILL)
+      }
+    }
+
+    // Set preferred size on the entire panel
+    panel.preferredSize = Dimension(650, 500)
+    return panel
+  }
+
+  override fun createActions(): Array<Action> = arrayOf(myOKAction)
+
+  // -- Private Methods ----------------------------------------------------- //
+
+  private fun createAboutPluginComponent(): JComponent =
+    panel {
+        row { text("<b>Thanks for using the ${PluginInfo.pluginName} plugin! ❤</b>") }
+          .bottomGap(BottomGap.NONE)
+        row { text("Version: ${PluginInfo.pluginVersion}") }.bottomGap(BottomGap.MEDIUM)
+
+        row {
+            text(
+                "Spotted a bug or thought of a new feature? <a href='https://github.com/marcelkliemannel/intellij-developer-tools-plugin/issues'>Please create an issue on GitHub.</a>"
+              )
+              .gap(RightGap.SMALL)
+          }
+          .bottomGap(BottomGap.NONE)
+        row {
+            comment(
+              "(The plugin is intended for all JetBrains IDEs and will therefore not be extended with features that target a specific programming language or framework.)"
+            )
+          }
+          .topGap(TopGap.NONE)
+      }
+      .apply { this.border = JBEmptyBorder(12, 0, 0, 0) }
+
+  private fun createChangelogComponent(): JComponent = panel {
+    row {
+      text(
+        AboutPluginDialog::class.java.getResource(CHANGELOG_HTML_FILE)?.readText()
+          ?: "Couldn't find 'What's New' text"
+      )
+    }
+  }
+
+  // -- Inner Type ---------------------------------------------------------- //
+  // -- Companion Object ---------------------------------------------------- //
+
+  companion object {
+
+    private const val CHANGELOG_HTML_FILE =
+      "/dev/turingcomplete/intellijdevelopertoolsplugin/changelog.html"
+  }
+}

modules/tools/ui/src/main/kotlin/dev/turingcomplete/intellijdevelopertoolsplugin/tool/ui/frame/ChangelogDialog.kt

@@ -33,7 +33,7 @@ import dev.turingcomplete.intellijdevelopertoolsplugin.tool.ui.base.DeveloperUiT
 import dev.turingcomplete.intellijdevelopertoolsplugin.tool.ui.base.DeveloperUiToolFactory
 import dev.turingcomplete.intellijdevelopertoolsplugin.tool.ui.base.DeveloperUiToolFactoryEp
 import dev.turingcomplete.intellijdevelopertoolsplugin.tool.ui.base.DeveloperUiToolGroup
-import dev.turingcomplete.intellijdevelopertoolsplugin.tool.ui.frame.ChangelogDialog
+import dev.turingcomplete.intellijdevelopertoolsplugin.tool.ui.frame.AboutPluginDialog
 import dev.turingcomplete.intellijdevelopertoolsplugin.tool.ui.frame.instance.OpenSettingsAction
 import javax.swing.JComponent
 import javax.swing.JPanel
@@ -195,14 +195,14 @@ class ToolsMenuTree(
     }
 
   private fun createWhatsNewLink(parentComponent: JComponent) =
-    HyperlinkLabel("What's new").apply {
+    HyperlinkLabel("About").apply {
       icon = AllIcons.Actions.IntentionBulbGrey
       addHyperlinkListener(
         object : HyperlinkAdapter() {
 
           override fun hyperlinkActivated(e: HyperlinkEvent) {
             ApplicationManager.getApplication().invokeLater {
-              ChangelogDialog(project, parentComponent).show()
+              AboutPluginDialog(project, parentComponent).show()
             }
           }
         }