git-aicommit 7.6.0 → 8.0.3

package/README.md

@@ -36,13 +36,13 @@ touch $HOME/.git-aicommitrc
 // $HOME/.git-aicommitrc
 export default {
     openAiKey: process.env.OPENAI_API_KEY,
-    azureOpenAiKey: process.env.AZURE_OPENAI_API_KEY,
-    azureOpenAiInstanceName: process.env.AZURE_OPENAI_API_INSTANCE_NAME,
-    azureOpenAiDeploymentName: process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME,
-    azureOpenAiVersion: process.env.AZURE_OPENAI_API_VERSION,
+    baseURL: process.env.OPENAI_BASE_URL || null,
+    defaultHeaders: null,
+    defaultQuery: null,
     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 +50,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
@@ -86,4 +106,27 @@ alias gai="git add --all && git-aicommit && git push"
 gai
 ```
 
+## Azure OpenAI Integration
+
+To use Azure OpenAI instead of the official OpenAI API, set the following environment variables:
+
+```bash
+export OPENAI_API_KEY="your-azure-api-key"
+export OPENAI_BASE_URL="https://<your-instance>.openai.azure.com/openai/deployments/<your-deployment>"
+export OPENAI_DEFAULT_HEADERS='{"api-key": "your-azure-api-key"}'
+export OPENAI_DEFAULT_QUERY='{"api-version": "2024-02-15-preview"}'
+```
+
+Or add them to your config file:
+
+```js
+// $HOME/.git-aicommitrc
+export default {
+    openAiKey: process.env.AZURE_OPENAI_API_KEY,
+    baseURL: process.env.AZURE_OPENAI_BASE_URL,
+    defaultHeaders: { 'api-key': process.env.AZURE_OPENAI_API_KEY },
+    defaultQuery: { 'api-version': '2024-02-15-preview' },
+}
+```
+
 It's that simple!

package/autocommit.js

@@ -11,10 +11,15 @@ const config = rc(
     {
         ...defaultConfig,
         openAiKey: process.env.OPENAI_API_KEY,
-        azureOpenAIApiKey: process.env.AZURE_OPENAI_API_KEY
+        baseURL: process.env.OPENAI_BASE_URL,
+        defaultHeaders: process.env.OPENAI_DEFAULT_HEADERS ? JSON.parse(process.env.OPENAI_DEFAULT_HEADERS) : null,
+        defaultQuery: process.env.OPENAI_DEFAULT_QUERY ? JSON.parse(process.env.OPENAI_DEFAULT_QUERY) : null,
     },
 );
 
+// 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,16 +30,11 @@ try {
     process.exit(1);
 }
 
-if (!config.openAiKey && !config.azureOpenAiKey) {
-    console.error("Please set OPENAI_API_KEY or AZURE_OPENAI_API_KEY");
-    process.exit(1);
-}
+// Get current git branch name
+const branch = execSync('git rev-parse --abbrev-ref HEAD', {encoding: 'utf8'}).trim();
 
-// if any settings related to AZURE are set, if there are items that are not set, will error.
-if (config.azureOpenAiKey && !(
-    config.azureOpenAiInstanceName && config.azureOpenAiDeploymentName && config.azureOpenAiVersion
-)){
-    console.error("Please set AZURE_OPENAI_API_KEY, AZURE_OPENAI_API_INSTANCE_NAME, AZURE_OPENAI_API_DEPLOYMENT_NAME, AZURE_OPENAI_API_VERSION when Azure OpenAI Service.");
+if (!config.openAiKey) {
+    console.error("Please set OPENAI_API_KEY");
     process.exit(1);
 }
 
@@ -57,9 +57,9 @@ if (!diff) {
 
 const openai = new OpenAI({
     apiKey: config.openAiKey,
-    baseURL: config.azureOpenAiKey ? `https://${config.azureOpenAiInstanceName}.openai.azure.com/openai/deployments/${config.azureOpenAiDeploymentName}` : undefined,
-    defaultHeaders: config.azureOpenAiKey ? { 'api-key': config.azureOpenAiKey } : undefined,
-    defaultQuery: config.azureOpenAiKey ? { 'api-version': config.azureOpenAiVersion } : undefined, // defaultQuery for api-version as per OpenAI SDK v4+ for Azure
+    baseURL: config.baseURL || undefined,
+    defaultHeaders: config.defaultHeaders || undefined,
+    defaultQuery: config.defaultQuery || undefined,
 });
 
 async function getChatCompletion(messages) {
@@ -73,7 +73,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

@@ -1,12 +1,12 @@
 export default {
     openAiKey: process.env.OPENAI_API_KEY,
-    azureOpenAiKey: process.env.AZURE_OPENAI_API_KEY,
-    azureOpenAiInstanceName: process.env.AZURE_OPENAI_API_INSTANCE_NAME,
-    azureOpenAiDeploymentName: process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME,
-    azureOpenAiVersion: process.env.AZURE_OPENAI_API_VERSION,
+    baseURL: process.env.OPENAI_BASE_URL || null,
+    defaultHeaders: null,
+    defaultQuery: null,
     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 +14,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,9 +1,9 @@
 {
   "name": "git-aicommit",
-  "version": "7.6.0",
-  "description": "Generates auto commit messages with OpenAI GPT3 model",
+  "version": "8.0.3",
+  "description": "Generates auto commit messages with OpenAI models",
   "main": "autocommit.js",
-  "repository": "https://github.com/shanginn/autocommit",
+  "repository": "https://github.com/shanginn/git-aicommit",
   "author": "shanginn@gmail.com",
   "license": "MIT",
   "type": "module",