add file preview in main dialog (#69)

Author: j-roskopf

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Module Maker Changelog
 
+## [1.0.23]
+- Add file preview
+
 ## [1.0.22]
 - Don't specify pluginUntilBuild. This plugin will work forever ;)
 

gradle.properties

@@ -4,7 +4,7 @@ pluginGroup = com.joetr.modulemaker
 pluginName = ModuleMaker
 pluginRepositoryUrl = https://github.com/j-roskopf/ModuleMakerPlugin
 # SemVer format -> https://semver.org
-pluginVersion = 1.0.22
+pluginVersion = 1.0.23
 
 # Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 pluginSinceBuild = 222

src/main/kotlin/com/joetr/modulemaker/ModuleMakerDialogWrapper.kt

@@ -158,10 +158,19 @@ class ModuleMakerDialogWrapper(
                 "Cancel",
                 2
             ),
+            object : AbstractAction("Preview") {
+                override fun actionPerformed(e: ActionEvent?) {
+                    if (validateInput()) {
+                        displayPreviewDialog()
+                    } else {
+                        MessageDialogWrapper("Please fill out required values").show()
+                    }
+                }
+            },
             object : AbstractAction("Create") {
                 override fun actionPerformed(e: ActionEvent?) {
                     if (validateInput()) {
-                        create()
+                        create(previewMode = false)
                     } else {
                         MessageDialogWrapper("Please fill out required values").show()
                     }
@@ -170,6 +179,11 @@ class ModuleMakerDialogWrapper(
         )
     }
 
+    private fun displayPreviewDialog() {
+        val filesToBeCreated = create(previewMode = true)
+        PreviewDialogWrapper(filesToBeCreated = filesToBeCreated, root = rootFromPath(rootDirectoryString())).show()
+    }
+
     private fun validateInput(): Boolean {
         return packageName.value.isNotEmpty() && selectedSrcValue.value != DEFAULT_SRC_VALUE && moduleName.value.isNotEmpty() && moduleName.value != DEFAULT_MODULE_NAME
     }
@@ -359,7 +373,7 @@ class ModuleMakerDialogWrapper(
         }
     }
 
-    private fun create() {
+    private fun create(previewMode: Boolean): List<File> {
         val settingsGradleFile = getSettingsGradleFile()
         val moduleType = moduleTypeSelection.value
         val currentlySelectedFile = getCurrentlySelectedFile()
@@ -375,7 +389,7 @@ class ModuleMakerDialogWrapper(
                     useKts = useKtsExtension.value
                 )
             )
-            fileWriter.createModule(
+            val filesCreated = fileWriter.createModule(
                 // at this point, selectedSrcValue has a value of something like /root/module/module2/
                 // - we want to remove the root of the project to use as the file path in settings.gradle
                 rootPathString = removeRootFromPath(selectedSrcValue.value),
@@ -403,10 +417,14 @@ class ModuleMakerDialogWrapper(
                 gradleFileFollowModule = gradleFileNamedAfterModule.value,
                 packageName = packageName.value,
                 addReadme = addReadme.value,
-                addGitIgnore = addGitIgnore.value
+                addGitIgnore = addGitIgnore.value,
+                previewMode = previewMode
             )
+
+            return filesCreated
         } else {
             MessageDialogWrapper("Couldn't find settings.gradle(.kts)").show()
+            return emptyList()
         }
     }
 
@@ -451,4 +469,8 @@ class ModuleMakerDialogWrapper(
     private fun removeRootFromPath(path: String): String {
         return path.split(File.separator).drop(1).joinToString(File.separator)
     }
+
+    private fun rootFromPath(path: String): String {
+        return path.split(File.separator).last()
+    }
 }

src/main/kotlin/com/joetr/modulemaker/PreviewDialogWrapper.kt

@@ -0,0 +1,109 @@
+/*
+ * Copyrightest (c) 2024 Joseph Roskopf
+ */
+
+package com.joetr.modulemaker
+
+import androidx.compose.foundation.layout.height
+import androidx.compose.foundation.layout.width
+import androidx.compose.material.Surface
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.awt.ComposePanel
+import androidx.compose.ui.unit.dp
+import com.intellij.openapi.ui.DialogWrapper
+import com.intellij.openapi.util.io.FileUtilRt
+import com.joetr.modulemaker.data.toProjectFile
+import com.joetr.modulemaker.ui.file.FileTree
+import com.joetr.modulemaker.ui.file.FileTreeView
+import com.joetr.modulemaker.ui.theme.WidgetTheme
+import java.io.File
+import javax.swing.Action
+import javax.swing.JComponent
+
+private const val WINDOW_WIDTH = 400
+private const val WINDOW_HEIGHT = 600
+
+class PreviewDialogWrapper(val filesToBeCreated: List<File>, val root: String) : DialogWrapper(true) {
+
+    private var tempRoot: File
+
+    init {
+        title = "Preview"
+        init()
+
+        tempRoot = FileUtilRt.createTempDirectory(root, null, true)
+
+        createFileStructure(
+            tempRoot,
+            filesToBeCreated.map {
+                val pathToRoot = tempRoot.absolutePath
+                val split = it.absolutePath.split(root)
+
+                // splice together the files to have a root of our temp folder
+                File(pathToRoot, split.drop(1).joinToString(separator = ""))
+            }
+        )
+    }
+
+    override fun dispose() {
+        super.dispose()
+        tempRoot.parentFile.deleteRecursively()
+    }
+
+    override fun createCenterPanel(): JComponent {
+        return ComposePanel().apply {
+            setBounds(0, 0, WINDOW_WIDTH, WINDOW_HEIGHT)
+            setContent {
+                WidgetTheme {
+                    Surface {
+                        FileTreeJPanel(
+                            modifier = Modifier.height(WINDOW_HEIGHT.dp).width(WINDOW_WIDTH.dp)
+                        )
+                    }
+                }
+            }
+        }
+    }
+
+    @Composable
+    private fun FileTreeJPanel(
+        modifier: Modifier = Modifier
+    ) {
+        val height = remember { mutableStateOf(WINDOW_HEIGHT) }
+
+        FileTreeView(
+            modifier = modifier,
+            model = FileTree(root = tempRoot.toProjectFile()),
+            height = height.value.dp,
+            onClick = { }
+        )
+    }
+
+    private fun List<File>.root(): File {
+        return this.minBy { file ->
+            file.absolutePath.count { it.toString() == File.separator }
+        }
+    }
+
+    private fun createFileStructure(root: File, structure: List<File>) {
+        root.mkdirs()
+        structure.forEach {
+            it.mkdirs()
+            if (it.isDirectory.not() && it.extension.isEmpty().not()) {
+                it.writeText("")
+            }
+        }
+    }
+
+    override fun createActions(): Array<Action> {
+        return arrayOf(
+            DialogWrapperExitAction(
+                "Okay",
+                2
+            )
+        )
+    }
+}