1.0.10

* chore: update README with new package description and title

README.md

@@ -5,15 +5,18 @@
     <h4 align="center">Author <a href="https://github.com/di-sukharev">@di-sukharev</a> <a href="https://twitter.com/io_Y_oi"><img src="https://img.shields.io/twitter/follow/io_Y_oi?style=flat&label=io_Y_oi&logo=twitter&color=0bf&logoColor=fff" align="center"></a>
     </h4>
   </div>
-	<p>AI generates conventional commits with mind-blowing accuracy</p>
+	<h2>GPT CLI to auto-generate impressive commits in 1 second</h2>
+	<p>Killing lame commits with AI 🤯🔫</p>
 	<a href="https://www.npmjs.com/package/opencommit"><img src="https://img.shields.io/npm/v/opencommit" alt="Current version"></a>
 </div>
 
 ---
 
-## Examples
+<div align="center">
+    <img src=".github/opencommit-example.png" alt="OpenCommit example"/>
+</div>
 
-Look into [the commits](https://github.com/di-sukharev/opencommit/commit/eae7618d575ee8d2e9fff5de56da79d40c4bc5fc) to see how OpenCommit works. Emoji and long commit description text is configurable.
+All the commits in this repo are done with OpenCommit — look into [the commits](https://github.com/di-sukharev/opencommit/commit/eae7618d575ee8d2e9fff5de56da79d40c4bc5fc) to see how OpenCommit works. Emoji and long commit description text is configurable.
 
 ## Setup
 
@@ -30,10 +33,10 @@ Look into [the commits](https://github.com/di-sukharev/opencommit/commit/eae7618
 3. Set the key to opencommit config:
 
    ```sh
-   opencommit config set OPENAI_API_KEY=<your token>
+   opencommit config set OPENAI_API_KEY=<your_api_key>
    ```
 
-   Your token isn't sent to anyone, it's saved in `~/.opencommit` config file.
+   Your api key is stored locally in `~/.opencommit` config file.
 
 ## Usage
 

di.txt

@@ -1,120 +0,0 @@
-diff --git a/src/generateCommitMessageFromGitDiff.ts b/src/generateCommitMessageFromGitDiff.ts
-index c3fb638..82b8bde 100644
---- a/src/generateCommitMessageFromGitDiff.ts
-+++ b/src/generateCommitMessageFromGitDiff.ts
-@@ -4,6 +4,7 @@ import {
- } from 'openai';
- import { api } from './api';
- import { getConfig } from './commands/config';
-+import { mergeStrings } from './utils/mergeStrings';
- 
- const config = getConfig();
- 
-@@ -88,37 +89,64 @@ export const generateCommitMessageWithChatCompletion = async (
- ): Promise<string | GenerateCommitMessageError> => {
-   try {
-     if (diff.length >= MAX_REQ_TOKENS) {
--      const separator = 'diff --git ';
--
--      const diffByFiles = diff.split(separator).slice(1);
--
--      const commitMessagePromises = diffByFiles
--        .map((fileDiff) => {
--          // TODO: split by files
--          if (fileDiff.length >= MAX_REQ_TOKENS) return null;
--
--          const messages = generateCommitMessageChatCompletionPrompt(
--            separator + fileDiff
--          );
--
--          return api.generateCommitMessage(messages);
--        })
--        .filter(Boolean);
-+      const commitMessagePromises = getCommitMsgsPromisesFromFileDiffs(diff);
- 
-       const commitMessages = await Promise.all(commitMessagePromises);
- 
-       return commitMessages.join('\n\n');
--    }
--
--    const messages = generateCommitMessageChatCompletionPrompt(diff);
-+    } else {
-+      const messages = generateCommitMessageChatCompletionPrompt(diff);
- 
--    const commitMessage = await api.generateCommitMessage(messages);
-+      const commitMessage = await api.generateCommitMessage(messages);
- 
--    if (!commitMessage)
--      return { error: GenerateCommitMessageErrorEnum.emptyMessage };
-+      if (!commitMessage)
-+        return { error: GenerateCommitMessageErrorEnum.emptyMessage };
- 
--    return commitMessage;
-+      return commitMessage;
-+    }
-   } catch (error) {
-     return { error: GenerateCommitMessageErrorEnum.internalError };
-   }
- };
-+
-+function getMessagesPromisesByLines(fileDiff: string, separator: string) {
-+  const [fileHeader, ...fileDiffByLines] = fileDiff.split('@@');
-+  const lineDiffsWithHeader = fileDiffByLines.map((d) => fileHeader + '@@' + d);
-+
-+  const mergedLines = mergeStrings(lineDiffsWithHeader, MAX_REQ_TOKENS);
-+
-+  const commitMsgsFromFileLineDiffs = mergedLines.map((d) => {
-+    const messages = generateCommitMessageChatCompletionPrompt(separator + d);
-+
-+    return api.generateCommitMessage(messages);
-+  });
-+
-+  return commitMsgsFromFileLineDiffs;
-+}
-+
-+function getCommitMsgsPromisesFromFileDiffs(diff: string) {
-+  const separator = 'diff --git ';
-+
-+  const diffByFiles = diff.split(separator).slice(1);
-+
-+  const mergedDiffs = mergeStrings(diffByFiles, MAX_REQ_TOKENS);
-+
-+  const commitMessagePromises = [];
-+
-+  for (const fileDiff of mergedDiffs) {
-+    if (fileDiff.length >= MAX_REQ_TOKENS) {
-+      // split fileDiff into lineDiff
-+      const messagesPromises = getMessagesPromisesByLines(fileDiff, separator);
-+
-+      commitMessagePromises.push(...messagesPromises);
-+    } else {
-+      // generate commits for files
-+      const messages = generateCommitMessageChatCompletionPrompt(
-+        separator + fileDiff
-+      );
-+
-+      commitMessagePromises.push(api.generateCommitMessage(messages));
-+    }
-+  }
-+  return commitMessagePromises;
-+}
-diff --git a/src/utils/mergeStrings.ts b/src/utils/mergeStrings.ts
-new file mode 100644
-index 0000000..a8beb37
---- /dev/null
-+++ b/src/utils/mergeStrings.ts
-@@ -0,0 +1,14 @@
-+export function mergeStrings(arr: string[], maxStringLength: number): string[] {
-+  const mergedArr: string[] = [];
-+  let currentItem: string = arr[0];
-+  for (const item of arr.slice(1)) {
-+    if (currentItem.length + item.length <= maxStringLength) {
-+      currentItem += item;
-+    } else {
-+      mergedArr.push(currentItem);
-+      currentItem = item;
-+    }
-+  }
-+  mergedArr.push(currentItem);
-+  return mergedArr;
-+}

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "open-commit",
-  "version": "1.0.2",
+  "version": "1.0.10",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "open-commit",
-      "version": "1.0.2",
+      "version": "1.0.10",
       "license": "ISC",
       "dependencies": {
         "@clack/prompts": "^0.6.1",

package.json

@@ -1,13 +1,17 @@
 {
   "name": "opencommit",
-  "version": "1.0.2",
-  "description": "AI generates conventional commits with mind-blowing accuracy.",
+  "version": "1.0.10",
+  "description": "GPT CLI to auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
   "keywords": [
     "git",
     "chatgpt",
     "gpt",
     "ai",
     "openai",
+    "opencommit",
+    "aicommit",
+    "aicommits",
+    "gptcommit",
     "commit"
   ],
   "main": "cli.js",

src/api.ts

@@ -20,6 +20,7 @@ if (!apiKey) {
   outro(
     'For help Look into README https://github.com/di-sukharev/opencommit#setup'
   );
+  process.exit(1);
 }
 
 // if (!apiKey) {

src/commands/commit.ts

@@ -44,8 +44,22 @@ ${chalk.grey('——————————————————')}`
   });
 
   if (isCommitConfirmedByUser && !isCancel(isCommitConfirmedByUser)) {
-    await execa('git', ['commit', '-m', commitMessage]);
+    const { stdout } = await execa('git', ['commit', '-m', commitMessage]);
     outro(`${chalk.green('✔')} successfully committed`);
+    outro(stdout);
+    const isPushConfirmedByUser = await confirm({
+      message: 'Do you want to run `git push`?'
+    });
+
+    if (isPushConfirmedByUser && !isCancel(isPushConfirmedByUser)) {
+      const pushSpinner = spinner();
+
+      pushSpinner.start('Running `git push`');
+      const { stdout } = await execa('git', ['push']);
+      pushSpinner.stop(`${chalk.green('✔')} successfully pushed all commits`);
+
+      if (stdout) outro(stdout);
+    }
   } else outro(`${chalk.gray('✖')} process cancelled`);
 };
 
@@ -79,7 +93,7 @@ export async function commit(isStageAllFlag = false) {
         .bold('`oc`')} command.`
     );
 
-    stagedFilesSpinner.stop('Counting staged files');
+    stagedFilesSpinner.stop('No files are staged');
     const isStageAllAndCommitConfirmedByUser = await confirm({
       message: 'Do you want to stage all files and generate commit message?'
     });

src/commands/prepare-commit-msg-hook.ts

@@ -37,10 +37,12 @@ export const prepareCommitMessageHook = async () => {
 
     if (typeof commitMessage !== 'string') throw new Error(commitMessage.error);
 
-    // TODO: change to read file > write file with commitMessage
-    await fs.appendFile(messageFilePath, commitMessage);
+    const fileContent = await fs.readFile(messageFilePath);
 
-    outro(`${chalk.green('✔')} commit done`);
+    await fs.writeFile(
+      messageFilePath,
+      commitMessage + '\n' + fileContent.toString()
+    );
   } catch (error) {
     outro(`${chalk.red('✖')} ${error}`);
     process.exit(1);

src/generateCommitMessageFromGitDiff.ts

@@ -110,14 +110,20 @@ export const generateCommitMessageWithChatCompletion = async (
 };
 
 function getMessagesPromisesByLines(fileDiff: string, separator: string) {
-  const [fileHeader, ...fileDiffByLines] = fileDiff.split('\n@@');
-  const lineDiffsWithHeader = fileDiffByLines.map(
-    (d) => fileHeader + '\n@@' + d
+  const lineSeparator = '\n@@';
+  const [fileHeader, ...fileDiffByLines] = fileDiff.split(lineSeparator);
+
+  // merge multiple line-diffs into 1 to save tokens
+  const mergedLines = mergeStrings(
+    fileDiffByLines.map((line) => lineSeparator + line),
+    MAX_REQ_TOKENS
   );
 
-  const mergedLines = mergeStrings(lineDiffsWithHeader, MAX_REQ_TOKENS);
+  const lineDiffsWithHeader = mergedLines.map(
+    (d) => fileHeader + lineSeparator + d
+  );
 
-  const commitMsgsFromFileLineDiffs = mergedLines.map((d) => {
+  const commitMsgsFromFileLineDiffs = lineDiffsWithHeader.map((d) => {
     const messages = generateCommitMessageChatCompletionPrompt(separator + d);
 
     return api.generateCommitMessage(messages);
@@ -131,18 +137,18 @@ function getCommitMsgsPromisesFromFileDiffs(diff: string) {
 
   const diffByFiles = diff.split(separator).slice(1);
 
-  const mergedDiffs = mergeStrings(diffByFiles, MAX_REQ_TOKENS);
+  // merge multiple files-diffs into 1 prompt to save tokens
+  const mergedFilesDiffs = mergeStrings(diffByFiles, MAX_REQ_TOKENS);
 
   const commitMessagePromises = [];
 
-  for (const fileDiff of mergedDiffs) {
+  for (const fileDiff of mergedFilesDiffs) {
     if (fileDiff.length >= MAX_REQ_TOKENS) {
-      // split fileDiff into lineDiff
+      // if file-diff is bigger than gpt context — split fileDiff into lineDiff
       const messagesPromises = getMessagesPromisesByLines(fileDiff, separator);
 
       commitMessagePromises.push(...messagesPromises);
     } else {
-      // generate commits for files
       const messages = generateCommitMessageChatCompletionPrompt(
         separator + fileDiff
       );