aicommits 0.0.3 → 0.0.4

package/README.md

@@ -1,34 +1,33 @@
-# AI Commit
+# AI Commits - work in progress
 
-Have AI Commit write your git commit messages for you so you never have to write a commit message again.
+AI Commits is a tool that writes your git commit messages for you. Never write a commit message again.
 
-[![AI Commit Screenshot](./screenshot.png)](https://twitter.com/nutlope/status/1624646872890589184)
+[![AI Commit Screenshot](https://github.com/Nutlope/aicommits/blob/main/screenshot.png)](https://twitter.com/nutlope/status/1624646872890589184)
 
-## How to install
+## Installation and usage
 
-`npm install -g autocommit`
-
-**Note:** The process to install this will get vastly simplified when I rewrite this CLI and publish it as an npm package to be run with `npx`.
+1. `npm install -g autocommit` to install the CLI
+2. `export OPENAI_KEY=sk-xxxxxxxxxxxxxxxx` to specify your OpenAI API Key
+3. `autocommit` after you run `git add .` to generate your commit
 
 ## How it works
 
-This project uses a command line interface tool called zx that's developed by google. In the script, it runs a `git diff` command to grab all the latest changes, sends this to OpenAI's GPT-3, then returns the AI generated commit message. Video coming soon where I rebuild it from scratch to show you how to easily build your own CLI tools powered by AI. Fully privacy friendly as commands only run on your local machine using your OpenAI account.
+This CLI tool runs a `git diff` command to grab all the latest changes, sends this to OpenAI's GPT-3, then returns the AI generated commit message. Video coming soon where I rebuild it from scratch to show you how to easily build your own CLI tools powered by AI.
+
+## Limitations
 
-This CLI also supports conventional commits. If you want conventional commits, simply set the `conventionalCommit` variable at the top of the script to `true`.
+It currently can only support git diffs of up to 200 lines of code. I'm working on version 2.0 which will be TypeScript-first, support conventional commits, and support long diffs.
 
 ## Remaining tasks
 
 Now:
 
-- [ ] Rewrite this in node to publish as an npm package
-  - [ ] Figure out how to fail gracefully instead of exit 1
-  - [ ] Try openai curie And/OR codex
-
-After:
+- Rewrite this in node to publish as an npm package
 
-- [ ] Rewrite in TypeScript
-- [ ] Look into better conventional commit support, look at other CLIs
-- [ ] Try supporting more than 200 lines by grabbing the diff per file
-- [ ] Build landing page
+Future tasks:
 
-# How to run new version
+- Experiment with openai curie and/or codex
+- Add conventional commit support
+- Try supporting more than 200 lines by grabbing the diff per file
+- Rewrite in TypeScript
+- Build landing page for the 2.0 launch

package/aicommit.js

@@ -3,8 +3,6 @@
 void (async function () {
   $.verbose = false;
 
-  // TODO: Figure out how to fail gracefully instead of exit 1
-
   let conventionalCommit = false;
 
   console.log(chalk.white("▲ ") + chalk.green("Welcome to AICommit!"));

package/cli.js

@@ -0,0 +1,6 @@
+#! /usr/bin/env node
+import { main } from "./lib";
+
+(async () => {
+  await main(process.cwd());
+})();

package/lib.js

@@ -0,0 +1,93 @@
+#!/usr/bin/env node
+const { execSync, spawn } = require("child_process");
+let OPENAI_API_KEY = process.env.OPENAI_API_KEY;
+import inquirer from "inquirer";
+
+export async function main() {
+  console.log("Welcome to AICommit!");
+  if (!OPENAI_API_KEY) {
+    console.error(
+      "Please specify an OpenAI key using export OPEN_AI_KEY='YOUR_API_KEY'"
+    );
+    process.exit(1);
+  }
+  // Check to see if the user is in a git repo
+  try {
+    execSync("git rev-parse --is-inside-work-tree", {
+      encoding: "utf8",
+      stdio: "ignore",
+    });
+  } catch (e) {
+    console.error("This is not a git repository");
+    process.exit(1);
+  }
+
+  let conventionalCommit = false;
+
+  const diff = execSync("git diff --cached", { encoding: "utf8" });
+
+  if (!diff) {
+    console.log(
+      "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("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. ${
+    conventionalCommit
+      ? "Preface the commit with 'feat:' if it is a feature or 'fix:' if it is a bug."
+      : "Do not preface the commit with anything."
+  } Return a complete sentence and do not repeat yourself: ${diff}`;
+
+  const aiCommitMessage = await generateCommitMessage(prompt);
+
+  console.log(aiCommitMessage);
+
+  const confirmationMessage = await inquirer.prompt([
+    {
+      name: "useCommitMessage",
+      message: "Would you like to use this commit message? (Y / n)",
+      choices: ["Y", "y", "n"],
+      default: "y",
+    },
+  ]);
+
+  if (confirmationMessage !== "n") {
+    execSync(`git commit -m "${cleanedUpAiCommit}"`, {
+      encoding: "utf8",
+    });
+  }
+}
+
+async function generateCommitMessage(prompt) {
+  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 = await fetch("https://api.openai.com/v1/completions", {
+    headers: {
+      "Content-Type": "application/json",
+      Authorization: `Bearer ${OPENAI_API_KEY ?? ""}`,
+    },
+    method: "POST",
+    body: JSON.stringify(payload),
+  });
+
+  const json = await response.json();
+  const aiCommit = json.choices[0].text;
+
+  return aiCommit.replace(/(\r\n|\n|\r)/gm, "");
+}

package/package.json

@@ -1,20 +1,15 @@
 {
   "name": "aicommits",
-  "version": "0.0.3",
-  "description": "generates ai commit",
-  "main": "aicommit.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "start": "./aicommit.js"
-  },
+  "version": "0.0.4",
+  "description": "Writes your git commit messages for you with AI",
+  "main": "cli.js",
   "bin": {
-    "gpt-commit": "./aicommit.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Nutlope/ai-commit.git"
+    "gpt-commit": "./cli.js"
   },
-  "author": "hassan",
-  "license": "ISC",
-  "homepage": "https://github.com/Nutlope/ai-commit#readme"
+  "repository": "https://github.com/Nutlope/aicommits",
+  "author": "Hassan El Mghari (@nutlope)",
+  "license": "MIT",
+  "dependencies": {
+    "inquirer": "^9.1.4"
+  }
 }