git-aicommit 7.6.0 → 7.7.0

package/README.md

@@ -43,6 +43,7 @@ export default {
     autocommit: true,
     openCommitTextEditor: false,
     language: 'english',
+    projectInstruction: null,
     systemMessagePromptTemplate: '' +
         'You are expert software developer, your job is to write clear and concise Git commit messages. ' +
         'Your responsibility is to ensure that these messages accurately describe the changes made in each commit,' +
@@ -50,19 +51,39 @@ export default {
         'Write 1-2 sentences. Output only the commit message without comments or other text.',
     humanPromptTemplate: '' +
         'Read the following git diff for a multiple files and ' +
-        'write 1-2 sentences commit message in {language}' +
-        'without mentioning lines or files.' +
-        'If the reason behind the changed can be deducted from the changed, provide this reason:\n' +
+        'write 1-2 sentences commit message in {language} ' +
+        'without mentioning lines or files. ' +
+        'If the reason behind the changed can be deducted from the changed, provide this reason.\n' +
+        'Current branch: {branch}\n' +
+        '{projectInstruction}\n' +
+        '{customInstruction}\n' +
+        'Git diff:\n' +
         '{diff}',
     excludeFromDiff: [
         '*.lock', '*.lockb', '*-lock.json', '*-lock.yaml'
     ],
     diffFilter: 'ACMRTUXB',
     modelName: "gpt-4.1-mini",
-    temperature: 0.0,
-    maxTokens: 2000,
+    completionPromptParams: {
+        maxTokens: 2000,
+    },
 }
+```
+
+### Prompt Template Variables
+
+The `humanPromptTemplate` supports the following variables:
 
+- `{diff}` - The git diff of staged changes
+- `{language}` - The language for the commit message (default: 'english')
+- `{branch}` - Current git branch name
+- `{projectInstruction}` - Project-level instructions (configurable via config file)
+- `{customInstruction}` - Custom instruction passed via command line
+
+Example usage with custom instruction:
+
+```bash
+git-aicommit added fix for issue #123
 ```
 
 ### Command line arguments

package/autocommit.js

@@ -15,6 +15,9 @@ const config = rc(
     },
 );
 
+// Parse command-line arguments (everything after the script name)
+const customInstruction = process.argv.slice(2).join(' ');
+
 try {
     execSync(
         'git rev-parse --is-inside-work-tree',
@@ -25,6 +28,9 @@ try {
     process.exit(1);
 }
 
+// Get current git branch name
+const branch = execSync('git rev-parse --abbrev-ref HEAD', {encoding: 'utf8'}).trim();
+
 if (!config.openAiKey && !config.azureOpenAiKey) {
     console.error("Please set OPENAI_API_KEY or AZURE_OPENAI_API_KEY");
     process.exit(1);
@@ -73,7 +79,14 @@ async function getChatCompletion(messages) {
 }
 
 const systemMessage = { role: "system", content: config.systemMessagePromptTemplate };
-const userMessage = { role: "user", content: config.humanPromptTemplate.replace("{diff}", diff).replace("{language}", config.language) };
+const userPrompt = config.humanPromptTemplate
+    .replace("{diff}", diff)
+    .replace("{language}", config.language)
+    .replace("{branch}", branch)
+    .replace("{projectInstruction}", config.projectInstruction || '')
+    .replace("{customInstruction}", customInstruction || '');
+
+const userMessage = { role: "user", content: userPrompt };
 
 const tokenCount = await calculateMaxTokens({
     prompt: diff,

package/config.js

@@ -7,6 +7,7 @@ export default {
     autocommit: true,
     openCommitTextEditor: false,
     language: 'english',
+    projectInstruction: null,
     systemMessagePromptTemplate: '' +
         'You are expert software developer, your job is to write clear and concise Git commit messages. ' +
         'Your responsibility is to ensure that these messages accurately describe the changes made in each commit,' +
@@ -14,14 +15,20 @@ export default {
         'Write 1-2 sentences. Output only the commit message without comments or other text.',
     humanPromptTemplate: '' +
         'Read the following git diff for a multiple files and ' +
-        'write 1-2 sentences commit message in {language}' +
-        'without mentioning lines or files.' +
-        'If the reason behind the changed can be deducted from the changed, provide this reason:\n' +
+        'write 1-2 sentences commit message in {language} ' +
+        'without mentioning lines or files. ' +
+        'If the reason behind the changed can be deducted from the changed, provide this reason.\n' +
+        'Current branch: {branch}\n' +
+        '{projectInstruction}\n' +
+        '{customInstruction}\n' +
+        'Git diff:\n' +
         '{diff}',
     excludeFromDiff: [
         '*.lock', '*.lockb', '*-lock.json', '*-lock.yaml'
     ],
     diffFilter: 'ACMRTUXB',
     modelName: "gpt-4.1-mini",
-    maxTokens: 2000,
+    completionPromptParams: {
+        maxTokens: 2000,
+    },
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "git-aicommit",
-  "version": "7.6.0",
-  "description": "Generates auto commit messages with OpenAI GPT3 model",
+  "version": "7.7.0",
+  "description": "Generates auto commit messages with OpenAI models",
   "main": "autocommit.js",
   "repository": "https://github.com/shanginn/autocommit",
   "author": "shanginn@gmail.com",