aicommits 1.0.4 → 1.0.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Hassan El Mghari
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,6 @@
 <div align="center">
   <div>
-    <img src="https://raw.githubusercontent.com/Nutlope/aicommits/main/screenshot.png" alt="AI Commits"/>
+    <img src=".github/screenshot.png" alt="AI Commits"/>
     <h1 align="center">AI Commits</h1>
   </div>
 	<p>A CLI that writes your git commit messages for you with AI. Never write a commit message again.</p>
@@ -17,7 +17,7 @@
 Install the CLI then grab your [OpenAI key](https://openai.com/api/) and add it as an env variable with the two commands below.
 
 1. `npm install -g aicommits`
-2. `export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxx`
+2. `export OPENAI_KEY=sk-xxxxxxxxxxxxxxxx`
 
 It's recommended to add the line in #2 to your `.zshrc` or `.bashrc` so it persists instead of having to define it in each terminal session.
 
@@ -45,6 +45,9 @@ The next version of the CLI, version 2, will address both of these limitations a
 - Add support for diffs greater than 200 lines by grabbing the diff per file
 - Add support for a flag that can auto-accept
 - Add ability to specify a commit message from inside aicommit
+- Solve latency issue (use a githook to asynchronously run gpt3 call on every git add, store the result in a temp file (or in the .git folder)
+- Use gpt-3-tokenizer
+- Add automated github releases
 - Add opt-in emoji flag
 - Add opt-in languages flag
 - Build landing page for the 2.0 launch

package/dist/cli.js

@@ -0,0 +1,98 @@
+#!/usr/bin/env node
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
+const chalk_1 = __importDefault(require("chalk"));
+const inquirer_1 = __importDefault(require("inquirer"));
+const openai_1 = require("openai");
+const OPENAI_KEY = (_a = process.env.OPENAI_KEY) !== null && _a !== void 0 ? _a : process.env.OPENAI_API_KEY;
+const generateCommitMessage = (apiKey, prompt) => __awaiter(void 0, void 0, void 0, function* () {
+    const openai = new openai_1.OpenAIApi(new openai_1.Configuration({ apiKey }));
+    try {
+        const completion = yield openai.createCompletion({
+            model: 'text-davinci-003',
+            prompt,
+            temperature: 0.7,
+            top_p: 1,
+            frequency_penalty: 0,
+            presence_penalty: 0,
+            max_tokens: 200,
+            stream: false,
+            n: 1,
+        });
+        return completion.data.choices[0].text.trim().replace(/[\n\r]/g, '');
+    }
+    catch (error) {
+        const errorAsAny = error;
+        errorAsAny.message = `OpenAI API Error: ${errorAsAny.message} - ${errorAsAny.response.statusText}`;
+        throw errorAsAny;
+    }
+});
+(() => __awaiter(void 0, void 0, void 0, function* () {
+    console.log(chalk_1.default.white('▲ ') + chalk_1.default.green('Welcome to AICommits!'));
+    if (!OPENAI_KEY) {
+        console.error(`${chalk_1.default.white('▲ ')}Please save your OpenAI API key as an env variable by doing 'export OPENAI_KEY=YOUR_API_KEY'`);
+        process.exit(1);
+    }
+    try {
+        (0, child_process_1.execSync)('git rev-parse --is-inside-work-tree', {
+            encoding: 'utf8',
+            stdio: 'ignore',
+        });
+    }
+    catch (_b) {
+        console.error(`${chalk_1.default.white('▲ ')}This is not a git repository`);
+        process.exit(1);
+    }
+    const diff = (0, child_process_1.execSync)('git diff --cached . ":(exclude)package-lock.json" ":(exclude)yarn.lock" ":(exclude)pnpm-lock.yaml"', {
+        encoding: 'utf8',
+    });
+    if (!diff) {
+        console.log(`${chalk_1.default.white('▲ ')}No staged changes found. Make sure there are changes and run \`git add .\``);
+        process.exit(1);
+    }
+    // Accounting for GPT-3's input req of 4k tokens (approx 8k chars)
+    if (diff.length > 8000) {
+        console.log(`${chalk_1.default.white('▲ ')}The diff is too large to write a commit message.`);
+        process.exit(1);
+    }
+    const prompt = `I want you to act like a git commit message writer. I will input a git diff and your job is to convert it into a useful commit message. Do not preface the commit with anything, use the present tense, return a complete sentence, and do not repeat yourself: ${diff}`;
+    console.log(chalk_1.default.white('▲ ') + chalk_1.default.gray('Generating your AI commit message...\n'));
+    try {
+        const aiCommitMessage = yield generateCommitMessage(OPENAI_KEY, prompt);
+        console.log(`${chalk_1.default.white('▲ ') + chalk_1.default.bold('Commit message: ') + aiCommitMessage}\n`);
+        const confirmationMessage = yield inquirer_1.default.prompt([
+            {
+                name: 'useCommitMessage',
+                message: 'Would you like to use this commit message? (Y / n)',
+                choices: ['Y', 'y', 'n'],
+                default: 'y',
+            },
+        ]);
+        if (confirmationMessage.useCommitMessage === 'n') {
+            console.log(`${chalk_1.default.white('▲ ')}Commit message has not been commited.`);
+            process.exit(1);
+        }
+        (0, child_process_1.execSync)(`git commit -m "${aiCommitMessage}"`, {
+            stdio: 'inherit',
+            encoding: 'utf8',
+        });
+    }
+    catch (error) {
+        console.error(chalk_1.default.white('▲ ') + chalk_1.default.red(error.message));
+        process.exit(1);
+    }
+}))();

package/package.json

@@ -1,29 +1,35 @@
 {
-  "name": "aicommits",
-  "version": "1.0.4",
-  "description": "Writes your git commit messages for you with AI",
-  "files": [
-    "bin"
-  ],
-  "bin": "bin/index.js",
-  "repository": "https://github.com/Nutlope/aicommits",
-  "author": "Hassan El Mghari (@nutlope)",
-  "license": "MIT",
-  "devDependencies": {
-    "@types/node": "^18.13.0",
-    "typescript": "^4.9.5"
-  },
-  "scripts": {
-    "build": "tsc"
-  },
-  "dependencies": {
-    "chalk": "^4.1.2",
-    "inquirer": "^8.0.0",
-    "node-fetch": "^2.6.9"
-  },
-  "keywords": [
-    "ai",
-    "git",
-    "commit"
-  ]
+	"name": "aicommits",
+	"version": "1.0.6",
+	"description": "Writes your git commit messages for you with AI",
+	"keywords": [
+		"ai",
+		"git",
+		"commit"
+	],
+	"license": "MIT",
+	"repository": "https://github.com/Nutlope/aicommits",
+	"author": "Hassan El Mghari (@nutlope)",
+	"files": [
+		"dist"
+	],
+	"bin": "dist/cli.js",
+	"scripts": {
+		"build": "tsc",
+		"lint": "eslint --cache ."
+	},
+	"dependencies": {
+		"chalk": "^4.1.2",
+		"inquirer": "^8.0.0",
+		"openai": "^3.1.0"
+	},
+	"devDependencies": {
+		"@pvtnbr/eslint-config": "^0.33.0",
+		"@types/node": "^18.13.0",
+		"eslint": "^8.34.0",
+		"typescript": "^4.9.5"
+	},
+	"eslintConfig": {
+		"extends": "@pvtnbr"
+	}
 }

package/bin/aicommits.js

@@ -1,101 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = void 0;
-const chalk_1 = __importDefault(require("chalk"));
-const child_process_1 = require("child_process");
-const inquirer_1 = __importDefault(require("inquirer"));
-const node_fetch_1 = __importDefault(require("node-fetch"));
-let OPENAI_API_KEY = process.env.OPENAI_API_KEY;
-function main() {
-    return __awaiter(this, void 0, void 0, function* () {
-        console.log(chalk_1.default.white("▲ ") + chalk_1.default.green("Welcome to AICommits!"));
-        if (!OPENAI_API_KEY) {
-            console.error(chalk_1.default.white("▲ ") +
-                "Please save your OpenAI API key as an env variable by doing 'export OPENAI_API_KEY=YOUR_API_KEY'");
-            process.exit(1);
-        }
-        try {
-            (0, child_process_1.execSync)("git rev-parse --is-inside-work-tree", {
-                encoding: "utf8",
-                stdio: "ignore",
-            });
-        }
-        catch (e) {
-            console.error(chalk_1.default.white("▲ ") + "This is not a git repository");
-            process.exit(1);
-        }
-        const diff = (0, child_process_1.execSync)(`git diff --cached . ":(exclude)package-lock.json" ":(exclude)yarn.lock" ":(exclude)pnpm-lock.yaml"`, {
-            encoding: "utf8",
-        });
-        if (!diff) {
-            console.log(chalk_1.default.white("▲ ") +
-                "No staged changes found. Make sure there are changes and run `git add .`");
-            process.exit(1);
-        }
-        // Accounting for GPT-3's input req of 4k tokens (approx 8k chars)
-        if (diff.length > 8000) {
-            console.log(chalk_1.default.white("▲ ") + "The diff is too large to write a commit message.");
-            process.exit(1);
-        }
-        let prompt = `I want you to act like a git commit message writer. I will input a git diff and your job is to convert it into a useful commit message. Do not preface the commit with anything, use the present tense, return a complete sentence, and do not repeat yourself: ${diff}`;
-        console.log(chalk_1.default.white("▲ ") + chalk_1.default.gray("Generating your AI commit message...\n"));
-        const aiCommitMessage = yield generateCommitMessage(prompt);
-        console.log(chalk_1.default.white("▲ ") + chalk_1.default.bold("Commit message: ") + aiCommitMessage + "\n");
-        const confirmationMessage = yield inquirer_1.default.prompt([
-            {
-                name: "useCommitMessage",
-                message: "Would you like to use this commit message? (Y / n)",
-                choices: ["Y", "y", "n"],
-                default: "y",
-            },
-        ]);
-        if (confirmationMessage.useCommitMessage === "n") {
-            console.log(chalk_1.default.white("▲ ") + "Commit message has not been commited.");
-            process.exit(1);
-        }
-        (0, child_process_1.execSync)(`git commit -m "${aiCommitMessage}"`, {
-            stdio: "inherit",
-            encoding: "utf8",
-        });
-    });
-}
-exports.main = main;
-function generateCommitMessage(prompt) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const payload = {
-            model: "text-davinci-003",
-            prompt,
-            temperature: 0.7,
-            top_p: 1,
-            frequency_penalty: 0,
-            presence_penalty: 0,
-            max_tokens: 200,
-            stream: false,
-            n: 1,
-        };
-        const response = yield (0, node_fetch_1.default)("https://api.openai.com/v1/completions", {
-            headers: {
-                "Content-Type": "application/json",
-                Authorization: `Bearer ${OPENAI_API_KEY !== null && OPENAI_API_KEY !== void 0 ? OPENAI_API_KEY : ""}`,
-            },
-            method: "POST",
-            body: JSON.stringify(payload),
-        });
-        const json = yield response.json();
-        const aiCommit = json.choices[0].text;
-        return aiCommit.replace(/(\r\n|\n|\r)/gm, "");
-    });
-}

package/bin/index.js

@@ -1,16 +0,0 @@
-#! /usr/bin/env node
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const aicommits_1 = require("./aicommits");
-(() => __awaiter(void 0, void 0, void 0, function* () {
-    yield (0, aicommits_1.main)();
-}))();