git-aicommit 1.3.1 → 2.0.2

package/.env.example

@@ -1,2 +1,2 @@
 OPENAI_API_KEY=
-GIT_AI_AUTOCOMMIT=
+GIT_AI_COMMIT_CONFIG_NAME=.git-ai-commit-config.js

package/README.md

@@ -4,7 +4,7 @@ Tired of writing commit messages? Let the computer do it for you!
 
 [![asciicast](demo.svg)](https://asciinema.org/a/fpL5Dkd74xO8yRTM15O49zOF9)
 
-> Not the best, but better than "WIP"!
+> It's shit, but better than "WIP"!
 
 ## Installation
 
@@ -12,42 +12,26 @@ Tired of writing commit messages? Let the computer do it for you!
 npm install -g git-aicommit
 ```
 
-## Usage
-
-For now this cli tool uses env variables to pass params, because this is simple PoC.
-- `OPENAI_API_KEY` - your OpenAI API key
-- `GIT_AI_AUTOCOMMIT` - If this env is present and not empty,
-  the commit will be made automatically.
-  Otherwise, you will just see the suggested commit.
-
-```bash 
+## Configuration
 
-```bash
-OPENAI_API_KEY=YOUR_OPEN_API_KEY GIT_AI_AUTOCOMMIT=1 git-aicommit
-```
+This cli tool uses configuration file located where `GIT_AI_COMMIT_CONFIG_NAME` points at,
+defaults to `~/.git-ai-commit-config.js`.
 
-Or make an alias:
+Or [default config](config.js) is used if no config file is found.
 
-```bash
-alias gai='OPENAI_API_KEY=YOUR_OPEN_API_KEY GIT_AI_AUTOCOMMIT=1 git-aicommit'
-```
-
-Or export envs first:
+## Usage
 
 ```bash
-export OPENAI_API_KEY=YOUR_OPEN_API_KEY
-export GIT_AI_AUTOCOMMIT=1
+export OPENAI_API_KEY=sk-YOUR_API_KEY
 git-aicommit
 ```
 
-Or even better: make an alias and export envs:
+Or make an alias:
 
 ```bash
 alias gai='git-aicommit'
-export OPENAI_API_KEY=YOUR_OPEN_API_KEY
-export GIT_AI_AUTOCOMMIT=1
 
-# And run it:
+## And run it:
 gai
 ```
 

package/autocommit.js

@@ -2,7 +2,23 @@
 
 require('dotenv').config();
 const {Configuration, OpenAIApi} = require("openai");
-const {execSync} = require("child_process");
+const {execSync, spawn} = require("child_process");
+
+const os = require('os');
+const fs = require('fs');
+
+const configFilename = process.env.GIT_AI_COMMIT_CONFIG_NAME || '.git-ai-commit-config.js';
+const configPath = os.homedir() + '/' + configFilename;
+
+// 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}`);
+// }
+
+const config = !fs.existsSync(configPath) ? require('./config.js') : require(configPath);
 
 try {
   execSync(
@@ -14,60 +30,67 @@ try {
   process.exit(1);
 }
 
-if (!process.env.OPENAI_API_KEY) {
+if (!config.openAiKey) {
   console.error("Please set OPENAI_API_KEY");
   process.exit(1);
 }
 
-const diff = execSync(
-    `git diff -- . ':(exclude)*.lock' 2>/dev/null`,
-    {encoding: 'utf8'}
-);
+const excludeFromDiff = config.excludeFromDiff || [];
+const diffFilter = config.diffFilter || 'ACMRTUXB';
+const diffCommand = `git diff \
+    --diff-filter=${diffFilter} \
+    ${excludeFromDiff.map((pattern) => `-- ':(exclude)${pattern}'`).join(' ')} \
+    2>/dev/null
+`;
+
+const diff = execSync(diffCommand, {encoding: 'utf8'});
 
 if (!diff) {
     console.error("Diff seems empty. Please commit manually.");
     process.exit(1);
 }
 
-
-const configuration = new Configuration({
-  apiKey: process.env.OPENAI_API_KEY,
-});
-
-const openai = new OpenAIApi(configuration);
+const openai = new OpenAIApi(new Configuration({
+    apiKey: config.openAiKey,
+}));
 
 // create a prompt
-const prompt = `Read the following git diff for a multiple files:
+const prompt = `${config.promptBeforeDiff}
 
 ${diff}
 
-Generate a commit message to explain diff in each file:
+${config.promptAfterDiff}
 
 `;
 
 openai
   .createCompletion({
     prompt,
-    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"],
+    ...config.completionPromptParams
   })
   .then((data) => {
     const commitMessage = data.data.choices[0].text;
-    const command = `git add --all && git commit -m "${commitMessage.replace(/"/g, '\\"')}"`;
 
-    if (!process.env.GIT_AI_AUTOCOMMIT) {
-      console.log(`Please set GIT_AI_AUTOCOMMIT to commit with following command:\n ${command}`);
+    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 command:\n ${command}`);
-      execSync(command, {encoding: 'utf8'});
+      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

@@ -0,0 +1,24 @@
+module.exports = {
+    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:',
+    excludeFromDiff: [
+        '*.lock'
+    ],
+    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"],
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-aicommit",
-  "version": "1.3.1",
+  "version": "2.0.2",
   "description": "Generates auto commit messages with OpenAI GPT3 model",
   "main": "autocommit.js",
   "repository": "https://github.com/shanginn/autocommit",

package/yarn-error.log

@@ -0,0 +1,36 @@
+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