aicommits 1.0.3 → 1.0.5

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

@@ -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.
 
@@ -36,11 +36,17 @@ Video coming soon where I rebuild it from scratch to show you how to easily buil
 - Only supports git diffs of up to 200 lines of code for now
 - Does not support conventional commits
 
-The next version of the CLI, version 2, will address both of these limitations!
+The next version of the CLI, version 2, will address both of these limitations as well as the tasks below!
 
 ## Future tasks
 
+- Add a debugging flag to troubleshoot OpenAI responses
 - Add support for conventional commits as a flag that users can enable
 - 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
+- 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/bin/aicommits.js

@@ -12,19 +12,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+var _a;
 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;
+let OPENAI_KEY = (_a = process.env.OPENAI_KEY) !== null && _a !== void 0 ? _a : 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) {
+        if (!OPENAI_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'");
+                "Please save your OpenAI API key as an env variable by doing 'export OPENAI_KEY=YOUR_API_KEY'");
             process.exit(1);
         }
         try {
@@ -37,7 +38,7 @@ function main() {
             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'", {
+        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) {
@@ -50,30 +51,38 @@ function main() {
             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, return a complete sentence, and do not repeat yourself: ${diff}`;
+        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.");
+        try {
+            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",
+            });
+        }
+        catch (e) {
+            console.error(chalk_1.default.white("▲ ") + chalk_1.default.red(e.message));
             process.exit(1);
         }
-        (0, child_process_1.execSync)(`git commit -m "${aiCommitMessage}"`, {
-            stdio: "inherit",
-            encoding: "utf8",
-        });
     });
 }
 exports.main = main;
 function generateCommitMessage(prompt) {
+    var _a;
     return __awaiter(this, void 0, void 0, function* () {
         const payload = {
             model: "text-davinci-003",
@@ -89,11 +98,15 @@ function generateCommitMessage(prompt) {
         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 : ""}`,
+                Authorization: `Bearer ${OPENAI_KEY !== null && OPENAI_KEY !== void 0 ? OPENAI_KEY : ""}`,
             },
             method: "POST",
             body: JSON.stringify(payload),
         });
+        if (response.status !== 200) {
+            const errorJson = yield response.json();
+            throw new Error(`OpenAI API failed while processing the request '${(_a = errorJson === null || errorJson === void 0 ? void 0 : errorJson.error) === null || _a === void 0 ? void 0 : _a.message}'`);
+        }
         const json = yield response.json();
         const aiCommit = json.choices[0].text;
         return aiCommit.replace(/(\r\n|\n|\r)/gm, "");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aicommits",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Writes your git commit messages for you with AI",
   "files": [
     "bin"