feat(settings): example OpenAI token value

Author: Blarc

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## [Unreleased]
 
+### Added
+- Show example OpenAI token value when field is empty.
+
 ## [1.3.0] - 2023-11-11
 
 ### Changed

src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/AICommitsExtensions.kt

@@ -2,8 +2,11 @@ package com.github.blarc.ai.commits.intellij.plugin
 
 import com.github.blarc.ai.commits.intellij.plugin.AICommitsBundle.message
 import com.intellij.openapi.ui.ValidationInfo
+import com.intellij.ui.dsl.builder.Cell
 import com.intellij.ui.layout.ValidationInfoBuilder
 import com.intellij.util.ui.ColumnInfo
+import com.intellij.util.ui.ComponentWithEmptyText
+import javax.swing.JComponent
 
 fun <T> createColumn(name: String, formatter: (T) -> String) : ColumnInfo<T, String> {
     return object : ColumnInfo<T, String>(name) {
@@ -44,3 +47,9 @@ fun ValidationInfoBuilder.isLong(value: String): ValidationInfo? {
         }
     }
 }
+
+// Adds emptyText method to all cells that contain a component that implements ComponentWithEmptyText class
+fun <T>Cell<T>.emptyText(emptyText: String) : Cell<T> where T : JComponent, T : ComponentWithEmptyText {
+    this.component.emptyText.text = emptyText
+    return this
+}

src/main/kotlin/com/github/blarc/ai/commits/intellij/plugin/settings/AppSettingsConfigurable.kt

@@ -4,6 +4,7 @@ import com.aallam.openai.api.exception.OpenAIAPIException
 import com.github.blarc.ai.commits.intellij.plugin.AICommitsBundle
 import com.github.blarc.ai.commits.intellij.plugin.AICommitsBundle.message
 import com.github.blarc.ai.commits.intellij.plugin.OpenAIService
+import com.github.blarc.ai.commits.intellij.plugin.emptyText
 import com.github.blarc.ai.commits.intellij.plugin.settings.prompt.Prompt
 import com.github.blarc.ai.commits.intellij.plugin.settings.prompt.PromptTable
 import com.github.blarc.ai.commits.intellij.plugin.temperatureValid
@@ -15,18 +16,18 @@ import com.intellij.openapi.ui.naturalSorted
 import com.intellij.ui.CommonActionsPanel
 import com.intellij.ui.ToolbarDecorator
 import com.intellij.ui.components.JBLabel
+import com.intellij.ui.components.JBPasswordField
 import com.intellij.ui.components.JBTextField
 import com.intellij.ui.dsl.builder.*
 import com.intellij.ui.util.minimumWidth
 import kotlinx.coroutines.*
 import java.util.*
 import javax.swing.DefaultComboBoxModel
-import javax.swing.JPasswordField
 
 class AppSettingsConfigurable : BoundConfigurable(message("settings.general.group.title")) {
 
     private val hostComboBox = ComboBox<String>()
-    private val tokenPasswordField = JPasswordField()
+    private val tokenPasswordField = JBPasswordField()
     private val verifyLabel = JBLabel()
     private val proxyTextField = JBTextField()
     private var modelComboBox = ComboBox<String>()
@@ -71,6 +72,7 @@ class AppSettingsConfigurable : BoundConfigurable(message("settings.general.grou
                                 { AppSettings.instance.getOpenAIToken().orEmpty() },
                                 { AppSettings.instance.saveOpenAIToken(it) }
                         )
+                        .emptyText(message("settings.openAITokenExample"))
                         .align(Align.FILL)
                         .resizableColumn()
                         .focused()
@@ -231,4 +233,4 @@ class AppSettingsConfigurable : BoundConfigurable(message("settings.general.grou
         }
 
     }
-}
+}

src/main/resources/messages/MyBundle.properties

@@ -3,6 +3,7 @@ name=AI Commits
 settings.title=Settings
 settings.general.group.title=AI Commits
 settings.openAIToken=OpenAI token
+settings.openAITokenExample=sk-ABCdefgHIjKlxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 settings.locale=Locale
 settings.prompt=Prompt
 settings.openAIModel=OpenAI model