git-aicommit 3.1.0 → 4.0.1

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,19 @@
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/README.md

@@ -8,8 +8,10 @@ Tired of writing commit messages? Let the computer do it for you!
 
 ## Installation
 
+It's recommended to use [bun](https://bun.sh/)
+
 ```bash
-npm install -g git-aicommit
+bun install -g git-aicommit
 ```
 
 ## Configuration
@@ -34,28 +36,30 @@ touch $HOME/.git-aicommitrc
 
 ```js
 // $HOME/.git-aicommitrc
-module.exports = {
+export default {
     openAiKey: process.env.OPENAI_API_KEY,
     addAllChangesBeforeCommit: true,
     autocommit: true,
     openCommitTextEditor: false,
-    promptBeforeDiff: 'Read the following git diff for a multiple files:',
-    promptAfterDiff: 'Generate 1 to 3 paragraphs to explain this diff to a human without mentioning changes themselves:',
+    language: 'english',
+    systemMessagePromptTemplate: '' +
+        'You are expert AI, 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,' +
+        'follow established guidelines. Provide a clear history of changes to the codebase.' +
+        '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:\n' +
+        '{diff}',
     excludeFromDiff: [
-        '*.lock'
+        '*.lock', '*.lockb'
     ],
     diffFilter: 'ACMRTUXB',
     completionPromptParams: {
-        model: "text-davinci-002",
-        max_tokens: 500,
-        temperature: 0.2,
-        top_p: 1,
-        presence_penalty: 0,
-        frequency_penalty: 0,
-        best_of: 1,
-        n: 1,
-        stream: false,
-        stop: ["\n\n\n"],
+        model: "gpt-3.5-turbo",
+        temperature: 0.0,
+        maxTokens: 1000,
     }
 }
 ```

package/autocommit.js

@@ -1,31 +1,26 @@
-#!/usr/bin/env node
+#!/usr/bin/env bun
 
-require('dotenv').config();
-const {Configuration, OpenAIApi} = require("openai");
-const {execSync, spawn} = require("child_process");
-const rc = require('rc');
+import { execSync, spawn } from "child_process";
+import rc from 'rc';
+import { ChatOpenAI } from "langchain/chat_models";
+import {ChatPromptTemplate, HumanMessagePromptTemplate, SystemMessagePromptTemplate} from "langchain/prompts";
+import defaultConfig from './config.js';
+import dotenv from 'dotenv';
 
-const defaultConfig = require('./config.js');
-
-// if (!fs.existsSync(configPath)) {
-//     TODO: param to create default config file
-//     const { defaultConfig } = require('./config.js');
-//
-//     fs.writeFileSync(configPath, `module.exports = ${JSON.stringify(defaultConfig, null, 4)}`);
-//     console.log(`Created default config file at ${configPath}`);
-// }
+dotenv.config();
 
 const config = rc(
     'git-aicommit',
-    defaultConfig,
-    null,
-    (content) => eval(content) // not good. but is it different from require()?
+    {
+        ...defaultConfig,
+        openAiKey: process.env.OPENAI_API_KEY,
+    },
 );
 
 try {
   execSync(
-    'git rev-parse --is-inside-work-tree 2>/dev/null',
-    {encoding: 'utf8'}
+    'git rev-parse --is-inside-work-tree',
+    {encoding: 'utf8', stdio: 'ignore'}
   );
 } catch (e) {
   console.error("This is not a git repository");
@@ -39,10 +34,11 @@ if (!config.openAiKey) {
 
 const excludeFromDiff = config.excludeFromDiff || [];
 const diffFilter = config.diffFilter || 'ACMRTUXB';
-const diffCommand = `git diff \
+const diffCommand = `git diff --staged \
     --diff-filter=${diffFilter} \
-    ${excludeFromDiff.map((pattern) => `-- ':(exclude)${pattern}'`).join(' ')} \
-    2>/dev/null
+    -- "${excludeFromDiff.map(
+        (pattern) => `:(exclude)${pattern}`
+    ).join(' ')}"
 `;
 
 const diff = execSync(diffCommand, {encoding: 'utf8'});
@@ -52,47 +48,43 @@ if (!diff) {
     process.exit(1);
 }
 
-const openai = new OpenAIApi(new Configuration({
-    apiKey: config.openAiKey,
-}));
+const openai = new ChatOpenAI({
+    modelName: config.modelName,
+    openAIApiKey: config.openAiKey,
+    temperature: config.temperature,
+    maxTokens: config.maxTokens,
+});
 
-// create a prompt
-const prompt = `${config.promptBeforeDiff}
+const systemMessagePromptTemplate = SystemMessagePromptTemplate.fromTemplate(config.systemMessagePromptTemplate)
+const humanPromptTemplate = HumanMessagePromptTemplate.fromTemplate(config.humanPromptTemplate)
 
-${diff}
+const chatPrompt = ChatPromptTemplate.fromPromptMessages([
+    systemMessagePromptTemplate,
+    humanPromptTemplate,
+])
 
-${config.promptAfterDiff}
+const prompt = await chatPrompt.formatMessages({
+    diff: diff,
+    language: config.language,
+})
 
-`;
+const res = await openai.call(prompt)
+
+const commitMessage = res.text.trim();
 
-openai
-  .createCompletion({
-    prompt,
-    ...config.completionPromptParams
-  })
-  .then((data) => {
-    const commitMessage = data.data.choices[0].text;
-
-    if (!config.addAllChangesBeforeCommit) {
-        console.log('addAllChangesBeforeCommit is false. Skipping git add --all');
-    } else {
-        execSync('git add --all', {encoding: 'utf8'});
-    }
-
-    if (!config.autocommit) {
-      console.log(`Autocommit is disabled. Here is the message:\n ${commitMessage}`);
-    } else {
-      console.log(`Committing with following message:\n ${commitMessage}`);
-      execSync(
-          `git commit -m "${commitMessage.replace(/"/g, '')}"`,
-          {encoding: 'utf8'}
-      );
-
-        if (config.openCommitTextEditor) {
-            spawn('git', ['commit', '--amend'], {
-                stdio: 'inherit'
-            });
-        }
-    }
-  });
 
+if (!config.autocommit) {
+    console.log(`Autocommit is disabled. Here is the message:\n ${commitMessage}`);
+} else {
+    console.log(`Committing with following message:\n ${commitMessage}`);
+    execSync(
+        `git commit -m "${commitMessage.replace(/"/g, '')}"`,
+        {encoding: 'utf8'}
+    );
+}
+
+if (config.openCommitTextEditor) {
+    spawn('git', ['commit', '--amend'], {
+        stdio: 'inherit'
+    });
+}

package/config.js

@@ -1,24 +1,26 @@
-module.exports = {
+export default {
     openAiKey: process.env.OPENAI_API_KEY,
     addAllChangesBeforeCommit: true,
     autocommit: true,
     openCommitTextEditor: false,
-    promptBeforeDiff: 'Read the following git diff for a multiple files:',
-    promptAfterDiff: 'Generate 1 to 3 paragraphs to explain this diff to a human without mentioning changes themselves:',
+    language: 'english',
+    systemMessagePromptTemplate: '' +
+        'You are expert AI, 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,' +
+        'follow established guidelines. Provide a clear history of changes to the codebase.' +
+        '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:\n' +
+        '{diff}',
     excludeFromDiff: [
-        '*.lock'
+        '*.lock', '*.lockb'
     ],
     diffFilter: 'ACMRTUXB',
     completionPromptParams: {
-        model: "text-davinci-002",
-        max_tokens: 500,
-        temperature: 0.2,
-        top_p: 1,
-        presence_penalty: 0,
-        frequency_penalty: 0,
-        best_of: 1,
-        n: 1,
-        stream: false,
-        stop: ["\n\n\n"],
+        model: "gpt-3.5-turbo",
+        temperature: 0.0,
+        maxTokens: 1000,
     }
 }

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "git-aicommit",
-  "version": "3.1.0",
+  "version": "4.0.1",
   "description": "Generates auto commit messages with OpenAI GPT3 model",
   "main": "autocommit.js",
   "repository": "https://github.com/shanginn/autocommit",
   "author": "shanginn@gmail.com",
   "license": "MIT",
+  "type": "module",
   "dependencies": {
     "dotenv": "^16.0.2",
+    "langchain": "^0.0.47",
     "openai": "^3.0.0",
     "rc": "1.2.8"
   },

package/yarn-error.log

@@ -1,36 +0,0 @@
-Arguments: 
-  /Users/shanginn/.nvm/versions/node/v16.16.0/bin/node /usr/local/Cellar/yarn/1.22.19/libexec/bin/yarn.js init
-
-PATH: 
-  /Users/shanginn/.nvm/versions/node/v16.16.0/bin:/Users/shanginn/.bun/bin:/Users/shanginn/bin:/usr/local/bin:/Users/shanginn/go/bin:/Users/shanginn/.composer/vendor/bin/:/Users/shanginn/.local/share/solana/install/active_release/bin:/Users/shanginn/.bun/bin/:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Library/Apple/usr/bin:/Applications/Wireshark.app/Contents/MacOS:/Users/shanginn/.cargo/bin
-
-Yarn version: 
-  1.22.19
-
-Node version: 
-  16.16.0
-
-Platform: 
-  darwin x64
-
-Trace: 
-  Error: canceled
-      at Interface.<anonymous> (/usr/local/Cellar/yarn/1.22.19/libexec/lib/cli.js:137150:13)
-      at Interface.emit (node:events:527:28)
-      at Interface._ttyWrite (node:readline:1081:16)
-      at ReadStream.onkeypress (node:readline:288:10)
-      at ReadStream.emit (node:events:527:28)
-      at emitKeys (node:internal/readline/utils:358:14)
-      at emitKeys.next (<anonymous>)
-      at ReadStream.onData (node:internal/readline/emitKeypressEvents:61:36)
-      at ReadStream.emit (node:events:527:28)
-      at addChunk (node:internal/streams/readable:315:12)
-
-npm manifest: 
-  No manifest
-
-yarn manifest: 
-  No manifest
-
-Lockfile: 
-  No lockfile