git-aicommit 2.0.1 → 3.0.0

package/.env.example

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

package/README.md

@@ -12,40 +12,72 @@ Tired of writing commit messages? Let the computer do it for you!
 npm install -g git-aicommit
 ```
 
-## Usage
+## Configuration
+
+This cli tool uses [standard rc files](https://www.npmjs.com/package/rc#standards):
+
+- local `.git-aicommitrc`
+- `$HOME/.git-aicommitrc`
+- `$HOME/.git-aicommit/config`
+- `$HOME/.config/git-aicommit`
+- `$HOME/.config/git-aicommit/config`
+- `/etc/git-aicommitrc`
+- `/etc/git-aicommit/config`
 
-For now this cli tool uses env variables to pass params, because this is simple PoC.
-- `OPENAI_API_KEY` - your OpenAI API key (you can get one at [https://beta.openai.com/account/api-keys]())
-- `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.
+Or [default config](config.js) is used if no config file is found.
+
+To override default config, create a config file and export an object with the following properties:
 
 ```bash
-OPENAI_API_KEY=YOUR_OPEN_API_KEY GIT_AI_AUTOCOMMIT=1 git-aicommit
+touch $HOME/.git-aicommitrc
 ```
 
-Or make an alias:
+```js
+// $HOME/.git-aicommitrc
+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"],
+    }
+}
+```
+
+### Command line arguments
 
 ```bash
-alias gai='OPENAI_API_KEY=YOUR_OPEN_API_KEY GIT_AI_AUTOCOMMIT=1 git-aicommit'
+git-aicommit --openAiKey="sk-..." --completionPromptParams.temperature=0.3 --no-autocommit
 ```
-
-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

@@ -3,12 +3,9 @@
 require('dotenv').config();
 const {Configuration, OpenAIApi} = require("openai");
 const {execSync, spawn} = require("child_process");
+const rc = require('rc');
 
-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;
+const defaultConfig = require('./config.js');
 
 // if (!fs.existsSync(configPath)) {
 //     TODO: param to create default config file
@@ -18,7 +15,7 @@ const configPath = os.homedir() + '/' + configFilename;
 //     console.log(`Created default config file at ${configPath}`);
 // }
 
-const config = !fs.existsSync(configPath) ? require('./config.js') : require(configPath);
+const config = rc('git-aicommit', defaultConfig);
 
 try {
   execSync(

package/config.js

@@ -4,7 +4,7 @@ module.exports = {
     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:',
+    promptAfterDiff: 'Generate 1 to 3 paragraphs to explain this diff to a human without mentioning changes themselves:',
     excludeFromDiff: [
         '*.lock'
     ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-aicommit",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "description": "Generates auto commit messages with OpenAI GPT3 model",
   "main": "autocommit.js",
   "repository": "https://github.com/shanginn/autocommit",
@@ -8,7 +8,8 @@
   "license": "MIT",
   "dependencies": {
     "dotenv": "^16.0.2",
-    "openai": "^3.0.0"
+    "openai": "^3.0.0",
+    "rc": "1.2.8"
   },
   "preferGlobal": true,
   "bin": {