feat: Add support for hints in commit message generation

This commit adds support for hints in the commit message generation process. If the current commit message starts with a colon, it is treated as a hint and passed to the OpenAI API to generate a more accurate commit message. The hint is displayed in the notification to the user.

Changes Made:
- Added a new parameter to the `generateCommitMessage` function in `OpenAIService.kt` to accept a hint
- Updated the `AICommitAction.kt` file to extract the hint from the commit message field and pass it to the `generateCommitMessage` function
- Updated the `AppSettings.kt` file to update the default prompt message to include a placeholder for hints
- Added a new notification message to display the prompt message with the hint if provided

Author: Marc-R2

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

@@ -12,6 +12,7 @@ import com.intellij.openapi.project.DumbAware
 import com.intellij.openapi.project.Project
 import com.intellij.openapi.vcs.VcsDataKeys
 import com.intellij.openapi.vcs.changes.Change
+import com.intellij.openapi.vcs.ui.CommitMessage
 import com.intellij.vcs.commit.AbstractCommitWorkflowHandler
 import git4idea.repo.GitRepositoryManager
 import kotlinx.coroutines.DelicateCoroutinesApi
@@ -33,6 +34,16 @@ class AICommitAction : AnAction(), DumbAware {
         runBackgroundableTask(message("action.background"), project) {
             val diff = computeDiff(includedChanges, project)
 
+            val hintMessageField = VcsDataKeys.COMMIT_MESSAGE_CONTROL.getData(e.dataContext) as CommitMessage
+            val currentCommitMessage = hintMessageField.text
+
+            // if currentCommitMessage starts with : then it is a hint
+            val hint = if (currentCommitMessage.startsWith("!")) {
+                currentCommitMessage.substring(1)
+            } else {
+                null
+            }
+
             if (diff.isBlank()) {
                 sendNotification(Notification.emptyDiff())
                 return@runBackgroundableTask
@@ -47,7 +58,7 @@ class AICommitAction : AnAction(), DumbAware {
             GlobalScope.launch(Dispatchers.Main) {
                 commitMessageField.setCommitMessage("Generating commit message...")
                 try {
-                    val generatedCommitMessage = openAIService.generateCommitMessage(diff, 1)
+                    val generatedCommitMessage = openAIService.generateCommitMessage(diff, hint, 1)
                     commitMessageField.setCommitMessage(generatedCommitMessage)
                 } catch (e: Exception) {
                     commitMessageField.setCommitMessage("Error generating commit message")

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

@@ -2,9 +2,10 @@ package com.github.blarc.ai.commits.intellij.plugin
 
 import com.aallam.openai.api.BetaOpenAI
 import com.aallam.openai.api.chat.*
-import com.aallam.openai.api.completion.CompletionRequest
 import com.aallam.openai.api.model.ModelId
 import com.aallam.openai.client.OpenAI
+import com.github.blarc.ai.commits.intellij.plugin.notifications.Notification
+import com.github.blarc.ai.commits.intellij.plugin.notifications.sendNotification
 import com.github.blarc.ai.commits.intellij.plugin.settings.AppSettings
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.components.Service
@@ -18,12 +19,15 @@ class OpenAIService {
     }
 
     @OptIn(BetaOpenAI::class)
-    suspend fun generateCommitMessage(diff: String, completions: Int): String {
+    suspend fun generateCommitMessage(diff: String, hint: String?, completions: Int): String {
         val openAiToken = AppSettings.instance.getOpenAIToken() ?: throw Exception("OpenAI Token is not set")
 
         val openAI = OpenAI(openAiToken)
 
         val prompt = AppSettings.instance.getPrompt().replace("{diffs}", diff)
+            .replace("{hint}", hint ?: "No hint provided")
+
+        sendNotification(Notification.usedPrompt(prompt))
 
         val chatCompletionRequest = ChatCompletionRequest(
             ModelId(model),

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

@@ -46,6 +46,10 @@ data class Notification(
         fun unsuccessfulRequest(message: String) = Notification(message = message("notifications.unsuccessful-request", message))
 
         fun unableToSaveToken() = Notification(message = message("notifications.unable-to-save-token"))
+
+        fun usedPrompt(diff: String) = Notification (
+            message = message("notifications.uses-prompt", diff)
+        )
     }
 
     fun isTransient() = type == Type.TRANSIENT

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

@@ -22,7 +22,7 @@ class AppSettings : PersistentStateComponent<AppSettings> {
     private val openAITokenTitle = "OpenAIToken"
     private val openAIPromptTitle = "OpenAIPrompt"
 
-    private var defaultPrompt = "As a professional developer working with a Git repository, it's important to maintain clear and concise commit messages that follow the standard format. Please create a commit message for the following changes: {diffs}. Remember to label everything logically and keep it short. Please use the following format <type>(<scope>): <short> \n\n [...]'. Thank you very much!" // And here's a helpful hint to remember: {hint}.
+    private var defaultPrompt = "As a professional developer working with a Git repository, it's important to maintain clear and concise commit messages that follow the standard format. Please create a commit message for the following changes: {diffs}. Remember to label everything logically and keep it short. Please use the following format <type>(<scope>): <short> \n\n [...]'. And here's a helpful hint from another developer: {hint}. Maybe you can use it to help you write your commit message."
 
     var requestSupport = true
 

src/main/resources/messages/MyBundle.properties

@@ -30,4 +30,5 @@ 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.
 settings.promptValidation=Need to include: {diffs}
+notifications.uses-prompt=Prompt:\n{0}