Merge pull request #4 from Abizrh/feat/mapping-msg

🔥 feat (prompt): add scopes and adjusting prompt generation

Author: Abizrh

lua/commit-ai/commit.lua

@@ -9,6 +9,7 @@ local action_state = require("telescope.actions.state")
 local previewers = require("telescope.previewers")
 local telescope = require("telescope.builtin")
 local backends = require("commit-ai.backends.gemini")
+local Prompt = require("commit-ai.prompt")
 
 local function query_ai(prompt, cb)
   backends.call_ai(prompt, function(response)
@@ -41,38 +42,11 @@ local function generate_commit_suggestions(cb)
   local git_conventions = config.git_conventions
   local format_lines = {}
   for _, convention in pairs(git_conventions) do
-    table.insert(format_lines, string.format("- %s %s: %s", convention.icon, convention.prefix, convention.type))
+    table.insert(format_lines, string.format("- %s %s (scope): %s", convention.icon, convention.prefix, convention.type))
   end
 
-  local prompt = string.format(
-    "Analyze this git diff and generate commit messages in plain text.\n" ..
-    "Use exactly this format without additional explanation:\n\n" ..
-    "- <icon> <prefix>: <commit message>\n\n" ..
-    "Options:\n%s\n\nGit diff:\n%s",
-    table.concat(format_lines, "\n"),
-    diff
-  )
+  local prompt = Prompt.default_prompt(diff, format_lines)
 
-  -- local prompt = string.format(
-  --   "Analyze this git diff and generate multiple commit messages using exactly one of these formats:\n" ..
-  --   "Format:\n" ..
-  --   "- <icon> <prefix>: <commit message>\n\n" ..
-  --   "Only respond with the commit messages, without any explanations.\n\n" ..
-  --   "- %s %s: Documentation changes\n" ..
-  --   "- %s %s: Bug fix\n" ..
-  --   "- %s %s: New feature\n" ..
-  --   "- %s %s: Chore\n" ..
-  --   "- %s %s: Breaking change\n" ..
-  --   "- %s %s: Enhancement\n\n" ..
-  --   "Git diff:\n%s",
-  --   git_conventions.docs.icon, git_conventions.docs.prefix,
-  --   git_conventions.fix.icon, git_conventions.fix.prefix,
-  --   git_conventions.feat.icon, git_conventions.feat.prefix,
-  --   git_conventions.chore.icon, git_conventions.chore.prefix,
-  --   git_conventions.refactor.icon, git_conventions.refactor.prefix,
-  --   git_conventions.enhance.icon, git_conventions.enhance.prefix,
-  --   diff
-  -- )
   query_ai(prompt, cb)
 end
 

lua/commit-ai/prompt.lua

@@ -0,0 +1,34 @@
+local M = {}
+
+function M.default_prompt(diff, format_lines)
+  return string.format(
+    [[
+Analyze the following Git diff and suggest commit messages.
+
+Follow this format exactly:
+- <icon> <prefix> (<scope>): <commit message>
+
+Use one of the options below for <icon> and <prefix>, depending on the change type:
+
+%s
+
+Rules:
+1. Only use the above icons and prefixes.
+2. Use "chore" for configuration files (*.yml, *.json, *.env), CI/CD changes, build systems, or general non-code tasks.
+3. Use "fix" for bug fixes.
+4. Use "feat" ONLY for user-facing features or newly introduced functionality.
+5. Use "docs" for documentation-only changes, including README.md and LICENSE.
+6. Use "refactor" for breaking internal code changes that don’t affect functionality.
+7. Use "enhance" for performance improvements or minor internal enhancements.
+8. The scope in parentheses should reflect the affected module or file group (e.g., doctor, config, auth).
+9. Keep commit message short and imperative (e.g., "add config for <context>
+
+Git diff:
+%s
+]],
+    table.concat(format_lines, "\n"),
+    diff
+  )
+end
+
+return M