feat(settings): add OpenAI token and prompt settings

Added the ability for users to set their OpenAI token and proxy in the plugin settings. Also added a prompt settings section where users can select a locale and manage their prompts. This will provide users with more flexibility and customization options for generating commit messages.

Author: Marc-R2

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

@@ -36,6 +36,4 @@ object AICommitsBundle : DynamicBundle(BUNDLE) {
     }
 
     fun plugin() = PluginManagerCore.getPlugin(PluginId.getId("com.github.marc-r2.commit_gpt-intellij-plugin"))
-
-
 }

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

@@ -38,6 +38,7 @@ class AppSettingsConfigurable : BoundConfigurable(message("settings.general.grou
     override fun createPanel() = panel {
 
         group(JBLabel("OpenAI")) {
+            // Set OpenAI token
             row {
                 cell(tokenPasswordField)
                     .label(message("settings.openAIToken"))
@@ -52,12 +53,16 @@ class AppSettingsConfigurable : BoundConfigurable(message("settings.general.grou
                     verifyToken()
                 }.align(AlignX.RIGHT)
             }
+
+            // Link to OpenAI API page
             row {
                 comment(message("settings.openAITokenComment"))
                     .align(AlignX.LEFT)
                 cell(verifyLabel)
                     .align(AlignX.RIGHT)
             }
+
+            // Set proxy
             row {
                 textField()
                     .label(message("settings.openAIProxy"))
@@ -68,16 +73,24 @@ class AppSettingsConfigurable : BoundConfigurable(message("settings.general.grou
         }
 
         group(JBLabel("Prompt")) {
+            // Set locale
             row {
-                comboBox(Locale.getAvailableLocales().toList().sortedBy { it.displayName }, AppSettingsListCellRenderer())
-                        .label(message("settings.locale"))
-                        .bindItem(AppSettings.instance::locale.toNullableProperty())
+                comboBox(
+                    Locale.getAvailableLocales().toList().sortedBy { it.displayName },
+                    AppSettingsListCellRenderer()
+                )
+                    .label(message("settings.locale"))
+                    .bindItem(AppSettings.instance::locale.toNullableProperty())
             }
+
+            /// Current Prompt selection
             row {
                 promptComboBox = comboBox(AppSettings.instance.prompts.values, AppSettingsListCellRenderer())
                     .label(message("settings.prompt"))
                     .bindItem(AppSettings.instance::currentPrompt.toNullableProperty())
             }
+
+            // Prompt table
             row {
                 toolbarDecorator = ToolbarDecorator.createDecorator(promptTable.table)
                     .setAddAction {

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

@@ -16,12 +16,8 @@ class AppSettingsListCellRenderer : DefaultListCellRenderer() {
         cellHasFocus: Boolean
     ): Component {
         val component = super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus)
-        if (value is Locale) {
-            text = value.displayName
-        }
-        if (value is Prompt) {
-            text = value.name
-        }
+        if (value is Locale) text = value.displayName
+        if (value is Prompt) text = value.name
         return component
     }
 }

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

@@ -4,5 +4,5 @@ data class Prompt(
     var name: String = "",
     var description: String = "",
     var content: String = "",
-    var canBeChanged: Boolean = true
+    var canBeChanged: Boolean = true,
 )

src/main/resources/META-INF/plugin.xml

@@ -78,6 +78,7 @@
     </extensions>
 
     <actions>
+        <!-- Button to generate commit message -->
         <action
                 id="AICommit.Button"
                 text="CommitGPT"

src/main/resources/messages/MyBundle.properties

@@ -1,5 +1,4 @@
 name=CommitGPT
-
 settings.title=Settings
 settings.general.group.title=CommitGPT
 settings.openAIToken=OpenAI token
@@ -13,35 +12,29 @@ settings.verify.valid=Open AI token is valid.
 settings.verify.invalid=Open AI token is not valid ({0}).
 settings.verify.running=Verifying Open AI token...
 settings.verify.token-is-empty=Open AI token is empty.
-
 action.background=Generating commit message
-action.error=Commit message could not be generated.
-action.unknown-error=Unknown error has occurred.
-
 notifications.title=CommitGPT
 notifications.welcome=Thanks for installing CommitGPT <strong>{0}</strong>
 notifications.unsuccessful-request=Error occurred: {0}
-notifications.internal-server-error=Internal server error ({0}) occurred.
-notifications.unknown-error=Unknown error ({0}).
 notification.group.important.name=CommitGPT important
 notification.group.general.name=CommitGPT general
 notifications.empty-diff=Git diff is empty.
 notifications.no-field=Missing commit field
-
-actions.do-not-ask-again = Do not ask me again.
-actions.take-me-there = Take me there.
+actions.do-not-ask-again=Do not ask me again.
+actions.take-me-there=Take me there.
 actions.sure-take-me-there=Sure, take me there.
 notifications.prompt-too-large=The diff is too large for the OpenAI API. Try reducing the number of staged changes, or write your own commit message.
 notifications.no-commit-message=Commit field has not been initialized correctly.
-settings.promptValidation=Need to include: {diffs}
 notifications.uses-prompt=Prompt:\n{0}
 notifications.unable-to-save-token=Token could not be saved.
-settings.addPrompt=Add prompt
 settings.prompt.name=Name
 settings.prompt.content=Content
 validation.required=This value is required.
 validation.number=Value is not a number.
-settings.prompt.comment=You can use {locale} and {diff} variables to customise your prompt.
+settings.prompt.comment=You can use {locale}, {diff} and {hint} variables to customise your prompt.\
+    \n{diff} will be replaced with the diff of the staged changes.\
+    \n{locale} will be replaced with the selected locale.\
+    \n{hint} will be replaced with the commit message hint, if you provided one.
 actions.update=Update
 actions.add=Add
 settings.prompt.edit.title=Edit Prompt