✨ Preview settings (#171)

Co-authored-by: Patrice de Saint Steban <pdesaintsteban@maisonsdumonde.com>

Author: patou

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 - ⬆️ Update versions of dependencies
 - ✨ Configuration global or per project
+- ✨ Preview gitmoji in the configuration
 - ✨ Customize the set of gitmojis available in the plugin : Gitmoji, Conventional Gitmoji, or a custom source (thanks to @glazrtom)
 - ⬆️ Update gitmoji.json to the last version
 - 🌐 Add translation for last gitmojis

src/main/kotlin/com/github/patou/gitmoji/GitMojiConfig.kt

@@ -9,18 +9,25 @@ import com.intellij.openapi.options.SearchableConfigurable
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.ui.ComboBox
 import com.intellij.openapi.util.Comparing
-import java.awt.Color
+import com.intellij.ui.JBColor
+import com.intellij.ui.SeparatorFactory
+import com.intellij.util.ui.JBImageIcon
 import java.awt.Cursor
 import java.awt.Desktop
 import java.awt.FlowLayout
 import java.awt.GridLayout
 import java.awt.event.MouseAdapter
 import java.awt.event.MouseEvent
 import java.net.URI
+import java.util.Locale
+import javax.imageio.ImageIO
+import javax.swing.BorderFactory
+import javax.swing.BoxLayout
 import javax.swing.JCheckBox
 import javax.swing.JComponent
 import javax.swing.JLabel
 import javax.swing.JPanel
+import javax.swing.JTextArea
 import javax.swing.JTextField
 
 class GitMojiConfig(private val project: Project) : SearchableConfigurable {
@@ -42,6 +49,7 @@ class GitMojiConfig(private val project: Project) : SearchableConfigurable {
     private val languages = ComboBox(languageOptions)
     private var textAfterUnicodeConfig: String = " "
     private var languagesConfig:String = "auto"
+    private val previewArea = JTextArea(2, 30)
 
     private val gitmojiSourceField = ComboBox(GitmojiSourceType.OPTIONS)
     private val gitmojiJsonUrlField = JTextField(40)
@@ -81,7 +89,7 @@ class GitMojiConfig(private val project: Project) : SearchableConfigurable {
         val flow = GridLayout(20, 2)
         mainPanel = JPanel(flow)
         mainPanel.add(useProjectSettings, null)
-        mainPanel.add(JPanel(), null) // empty cell
+        mainPanel.add(SeparatorFactory.createSeparator(GitmojiBundle.message("config.settings"), null), null)
         mainPanel.add(displayEmoji, null)
         mainPanel.add(useUnicode, null)
         mainPanel.add(insertInCursorPosition, null)
@@ -103,7 +111,7 @@ class GitMojiConfig(private val project: Project) : SearchableConfigurable {
 
         sourceTooltipLabel.text = gitmojiSourceConfig.tooltipText
         sourceTooltipLabel.font = sourceTooltipLabel.font.deriveFont((sourceTooltipLabel.font.size - 2).toFloat())
-        sourceTooltipLabel.foreground = Color(120, 120, 120)
+        sourceTooltipLabel.foreground = JBColor.GRAY
         sourceTooltipLabel.toolTipText = gitmojiSourceConfig.tooltipUrl
         sourceTooltipLabel.cursor = Cursor.getPredefinedCursor(Cursor.HAND_CURSOR)
         sourceTooltipLabel.addMouseListener(object : MouseAdapter() {
@@ -124,7 +132,11 @@ class GitMojiConfig(private val project: Project) : SearchableConfigurable {
 
         gitmojiSourceField.addItemListener {
             val selectedId = getCurrentGitmojiSourceId()
-            val type = GitmojiSourceTypeMapper.fromId(selectedId, gitmojiJsonUrlField.text.trim(), localizationUrlField.text.trim())
+            val type = GitmojiSourceTypeMapper.fromId(
+                selectedId,
+                gitmojiJsonUrlField.text.trim(),
+                localizationUrlField.text.trim()
+            )
             setGitmojiSourceFieldsVisibility(type)
             updateSourceTooltip(type)
         }
@@ -140,6 +152,87 @@ class GitMojiConfig(private val project: Project) : SearchableConfigurable {
         localizationPanel.add(JLabel(GitmojiBundle.message("config.source.localizationUrl")))
         localizationPanel.add(localizationUrlField, null)
         mainPanel.add(localizationPanel)
+
+        mainPanel.add(SeparatorFactory.createSeparator(GitmojiBundle.message("config.preview"), null), null)
+
+        val previewPanel = JPanel()
+        previewPanel.layout = BoxLayout(previewPanel, BoxLayout.Y_AXIS)
+        val iconUrl = javaClass.getResource("/icons/pluginIcon.png")
+        if (iconUrl != null) {
+            val image = ImageIO.read(iconUrl)
+            val imageIcon = JBImageIcon(image)
+            val imageLabel = JLabel(imageIcon)
+            val iconPanel = JPanel(FlowLayout(FlowLayout.LEFT, 0, 0))
+            iconPanel.add(imageLabel)
+            previewPanel.add(iconPanel)
+        }
+
+        previewArea.isEditable = false
+        previewArea.lineWrap = true
+        previewArea.wrapStyleWord = true
+        previewArea.border = BorderFactory.createLineBorder(JBColor.border())
+        previewPanel.add(previewArea)
+
+        mainPanel.add(previewPanel, null)
+
+        useUnicode.addActionListener { updatePreview() }
+        insertInCursorPosition.addActionListener { updatePreview() }
+        includeGitMojiDescription.addActionListener { updatePreview() }
+        textAfterUnicode.addActionListener { updatePreview() }
+        languages.addActionListener { updatePreview() }
+    }
+
+    private fun updatePreview() {
+        val commitMessage = getTranslatedString("Commit message", languages.selectedItem as? String ?: "auto")
+        val newFeaturesMessage = getTranslatedString("Introduce new features.", languages.selectedItem as? String ?: "auto")
+
+        val messageBuilder = StringBuilder()
+        if (insertInCursorPosition.isSelected) {
+            messageBuilder.append("$commitMessage|")
+        }
+        if (useUnicode.isSelected) {
+            messageBuilder.append("✨")
+        } else {
+            messageBuilder.append(":sparkles:")
+        }
+        val separator = when (textAfterUnicode.selectedIndex) {
+            0 -> ""
+            1 -> " "
+            else -> textAfterUnicode.selectedItem as? String ?: " "
+        }
+        messageBuilder.append(separator)
+        val selectionStart = messageBuilder.length
+
+        if (includeGitMojiDescription.isSelected) {
+            messageBuilder.append(newFeaturesMessage)
+        } else if (!insertInCursorPosition.isSelected) {
+            messageBuilder.append(commitMessage)
+        }
+
+        val message = messageBuilder.toString()
+        previewArea.text = message
+        previewArea.select(selectionStart, message.length)
+    }
+
+    private fun getTranslatedString(key: String, language: String): String {
+        val lang = if (language == "auto") Locale.getDefault().toString() else language
+        return when (key) {
+            "Commit message" -> when (lang) {
+                "fr_FR" -> "Message de commit"
+                "pt_BR" -> "Mensagem do commit"
+                "ru_RU" -> "Сообщение коммита"
+                "zh_CN" -> "提交信息"
+                else -> "Commit message"
+            }
+            "Introduce new features." -> when (lang) {
+                "fr_FR" -> "Introduire de nouvelles fonctionnalités."
+                "pt_BR" -> "Introduzir novas funcionalidades."
+                "ru_RU" -> "Добавить новые функции."
+                "zh_CN" -> "引入新功能。"
+                else -> "Introduce new features."
+            }
+            else -> key
+        }
     }
 
     override fun apply() {
@@ -256,6 +349,7 @@ class GitMojiConfig(private val project: Project) : SearchableConfigurable {
         localizationUrlField.text = localizationUrlConfig
         setGitmojiSourceFieldsVisibility(gitmojiSourceConfig)
         updateSourceTooltip(gitmojiSourceConfig)
+        updatePreview()
     }
 
     private fun setGitmojiSourceFieldsVisibility(type: GitmojiSourceType) {

src/main/resources/messages/GitmojiBundle.properties

@@ -14,5 +14,7 @@ config.source.localizationUrl=Localization URL template (supports {locale})
 config.source.error.jsonUrl.empty=Gitmoji JSON URL must not be empty for custom source.
 config.source.error.jsonUrl.invalid=Gitmoji JSON URL is invalid. Use a full http(s) URL.
 config.source.error.localizationUrl.invalid=Localization URL is invalid. Use a full http(s) URL, or leave empty.
+config.settings=Settings
+config.preview=Preview
 action.Gitmoji.GitCommitAction.text=GitMoji
 action.Gitmoji.GitCommitAction.description=Add gitmoji button to commit dialog

src/main/resources/messages/GitmojiBundle_fr_FR.properties

@@ -15,5 +15,7 @@ config.source.localizationUrl=Mod
 config.source.error.jsonUrl.empty=L'URL JSON Gitmoji ne doit pas être vide pour une source personnalisée.
 config.source.error.jsonUrl.invalid=L'URL JSON Gitmoji est invalide. Utilisez une URL http(s) complète.
 config.source.error.localizationUrl.invalid=L'URL de localisation est invalide. Utilisez une URL http(s) complète ou laissez vide.
+config.settings=Paramètres
+config.preview=Aperçu
 action.Gitmoji.GitCommitAction.text=Ajoute un Gitmoji
 action.Gitmoji.GitCommitAction.description=Ajoute un gitmoji au message de commit

src/main/resources/messages/GitmojiBundle_zh_CN.properties

@@ -15,5 +15,7 @@ config.source.localizationUrl=??? URL ????? {locale}?
 config.source.error.jsonUrl.empty=????? Gitmoji JSON URL ?????
 config.source.error.jsonUrl.invalid=Gitmoji JSON URL ????????? http(s) URL?
 config.source.error.localizationUrl.invalid=Localization URL ????????? http(s) URL?????
+config.settings=??
+config.preview=??
 action.Gitmoji.GitCommitAction.text=GitMoji
 action.Gitmoji.GitCommitAction.description=?? gitmoji ????????