2.2.9

* 2.0.18

* patch

* 2.0.19

* style(.prettierrc): reorder properties to follow alphabetical order and improve readability

* feat(generateCommitMessageFromGitDiff.ts): changing logic of MAX_REQ_TOKENS

fix(api.ts): add missing import for GenerateCommitMessageErrorEnum
The token count validation is added to prevent the request from exceeding the default model token limit. The validation is done by counting the tokens in each message and adding 4 to each count to account for the additional tokens added by the API. If the total token count exceeds the limit, an error is thrown. The missing import for GenerateCommitMessageErrorEnum is also added.

feat: add support for splitting long line-diffs into smaller pieces
This change adds support for splitting long line-diffs into smaller pieces to avoid exceeding the maximum commit message length. The `splitDiff` function splits a single line into multiple lines if it exceeds the maximum length. It also splits the diff into smaller pieces if adding the next line would exceed the maximum length. This change improves the readability of commit messages and makes them more consistent.

refactor: improve code readability by adding whitespace and reformatting code
This commit improves the readability of the code by adding whitespace and reformatting the code. The changes do not affect the functionality of the code. Additionally, a new function `delay` has been added to the file.

---------

Co-authored-by: di-sukharev <dim.sukharev@gmail.com>

README.md

@@ -37,6 +37,7 @@ on:
 
 jobs:
   opencommit:
+    timeout-minutes: 10
     name: OpenCommit
     runs-on: ubuntu-latest
     permissions: write-all
@@ -75,7 +76,7 @@ Interactive rebase (`rebase -i`) changes commit SHA, so commit history in remote
 
 ## Setup OpenCommit as a CLI
 
-You can use OpenCommit by simply running it via CLI like this `oc`. 2 seconds and your staged changes are committed with a meaningful message.
+You can use OpenCommit by simply running it via CLI like this `oco`. 2 seconds and your staged changes are committed with a meaningful message.
 
 1. Install OpenCommit globally to use in any repository:
 
@@ -102,7 +103,7 @@ git add <files...>
 opencommit
 ```
 
-You can also use the `oc` shortcut:
+You can also use the `oco` shortcut:
 
 ```sh
 git add <files...>
@@ -132,19 +133,19 @@ Local config still has more priority as Global config, but you may set `OCO_MODE
 Simply run any of the variable above like this:
 
 ```sh
-oc config set OCO_OPENAI_API_KEY=gpt-4
+oco config set OCO_OPENAI_API_KEY=gpt-4
 ```
 
 Configure [GitMoji](https://gitmoji.dev/) to preface a message.
 
 ```sh
-oc config set OCO_EMOJI=true
+oco config set OCO_EMOJI=true
 ```
 
 To remove preface emoji:
 
 ```sh
-oc config set OCO_EMOJI=false
+oco config set OCO_EMOJI=false
 ```
 
 ### Switch to GPT-4
@@ -154,7 +155,7 @@ By default OpenCommit uses GPT-3.5-turbo (ChatGPT).
 You may switch to GPT-4 which performs better, but costs ~x15 times more 🤠
 
 ```sh
-oc config set OCO_MODEL=gpt-4
+oco config set OCO_MODEL=gpt-4
 ```
 
 Make sure you do lowercase `gpt-4` and you have API access to the 4th model. Even if you have ChatGPT+ it doesn't necessarily mean that you have API access to GPT-4.
@@ -165,25 +166,25 @@ To globally specify the language used to generate commit messages:
 
 ```sh
 # de, German ,Deutsch
-oc config set OCO_LANGUAGE=de
-oc config set OCO_LANGUAGE=German
-oc config set OCO_LANGUAGE=Deutsch
+oco config set OCO_LANGUAGE=de
+oco config set OCO_LANGUAGE=German
+oco config set OCO_LANGUAGE=Deutsch
 
 # fr, French, française
-oc config set OCO_LANGUAGE=fr
-oc config set OCO_LANGUAGE=French
-oc config set OCO_LANGUAGE=française
+oco config set OCO_LANGUAGE=fr
+oco config set OCO_LANGUAGE=French
+oco config set OCO_LANGUAGE=française
 ```
 
-The default language set is **English**  
+The default language set is **English**
 All available languages are currently listed in the [i18n](https://github.com/di-sukharev/opencommit/tree/master/src/i18n) folder
 
 ### Git flags
 
-The `opencommit` or `oc` commands can be used in place of the `git commit -m "${generatedMessage}"` command. This means that any regular flags that are used with the `git commit` command will also be applied when using `opencommit` or `oc`.
+The `opencommit` or `oco` commands can be used in place of the `git commit -m "${generatedMessage}"` command. This means that any regular flags that are used with the `git commit` command will also be applied when using `opencommit` or `oco`.
 
 ```sh
-oc --no-verify
+oco --no-verify
 ```
 
 is translated to :
@@ -212,13 +213,13 @@ You can set OpenCommit as Git [`prepare-commit-msg`](https://git-scm.com/docs/gi
 To set the hook:
 
 ```sh
-oc hook set
+oco hook set
 ```
 
 To unset the hook:
 
 ```sh
-oc hook unset
+oco hook unset
 ```
 
 To use the hook:

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "opencommit",
-  "version": "2.0.19",
+  "version": "2.2.9",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "opencommit",
-      "version": "2.0.19",
+      "version": "2.2.9",
       "license": "MIT",
       "dependencies": {
         "@actions/core": "^1.10.0",
@@ -26,7 +26,6 @@
         "openai": "^3.2.1"
       },
       "bin": {
-        "oc": "out/cli.cjs",
         "oco": "out/cli.cjs",
         "opencommit": "out/cli.cjs"
       },

package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencommit",
-  "version": "2.0.19",
+  "version": "2.2.9",
   "description": "Auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
   "keywords": [
     "git",
@@ -17,7 +17,6 @@
   "main": "cli.js",
   "bin": {
     "opencommit": "./out/cli.cjs",
-    "oc": "./out/cli.cjs",
     "oco": "./out/cli.cjs"
   },
   "repository": {
@@ -42,7 +41,7 @@
     "start": "node ./out/cli.cjs",
     "dev": "ts-node ./src/cli.ts",
     "build": "rimraf out && node esbuild.config.js",
-    "deploy": "npm run build && npm version patch && npm publish --tag latest",
+    "deploy": "npm run build:push && git push --tags && npm publish --tag latest",
     "build:push": "npm run build && git add . && git commit -m 'build' && git push",
     "lint": "eslint src --ext ts && tsc --noEmit",
     "format": "prettier --write src"

src/CommandsEnum.ts

@@ -1,4 +1,4 @@
 export enum COMMANDS {
-  hook = 'hook',
-  config = 'config'
+  config = 'config',
+  hook = 'hook'
 }

src/api.ts

@@ -7,7 +7,9 @@ import {
   OpenAIApi
 } from 'openai';
 
-import { CONFIG_MODES, getConfig } from './commands/config';
+import {CONFIG_MODES, DEFAULT_MODEL_TOKEN_LIMIT, getConfig} from './commands/config';
+import {tokenCount} from './utils/tokenCount';
+import {GenerateCommitMessageErrorEnum} from './generateCommitMessageFromGitDiff';
 
 const config = getConfig();
 
@@ -21,7 +23,7 @@ if (!apiKey && command !== 'config' && mode !== CONFIG_MODES.set) {
   intro('opencommit');
 
   outro(
-    'OCO_OPENAI_API_KEY is not set, please run `oc config set OCO_OPENAI_API_KEY=<your token>. Make sure you add payment details, so API works.`'
+    'OCO_OPENAI_API_KEY is not set, please run `oco config set OCO_OPENAI_API_KEY=<your token>. Make sure you add payment details, so API works.`'
   );
   outro(
     'For help look into README https://github.com/di-sukharev/opencommit#setup'
@@ -56,6 +58,14 @@ class OpenAi {
       max_tokens: maxTokens || 500
     };
     try {
+      const REQUEST_TOKENS = messages.map(
+          (msg) => tokenCount(msg.content) + 4
+      ).reduce((a, b) => a + b, 0);
+
+      if (REQUEST_TOKENS > (DEFAULT_MODEL_TOKEN_LIMIT - maxTokens)) {
+        throw new Error(GenerateCommitMessageErrorEnum.tooMuchTokens);
+      }
+
       const { data } = await this.openAI.createChatCompletion(params);
 
       const message = data.choices[0].message;

src/cli.ts

@@ -7,7 +7,7 @@ import { configCommand } from './commands/config';
 import { hookCommand, isHookCalled } from './commands/githook.js';
 import { prepareCommitMessageHook } from './commands/prepare-commit-msg-hook';
 import { commit } from './commands/commit';
-// import { checkIsLatestVersion } from './utils/checkIsLatestVersion';
+import { checkIsLatestVersion } from './utils/checkIsLatestVersion';
 
 const extraArgs = process.argv.slice(2);
 
@@ -21,7 +21,7 @@ cli(
     help: { description: packageJSON.description }
   },
   async () => {
-    // await checkIsLatestVersion();
+    await checkIsLatestVersion();
 
     if (await isHookCalled()) {
       prepareCommitMessageHook();

src/commands/commit.ts

@@ -138,7 +138,7 @@ export async function commit(
 
     if (changedFiles) await gitAdd({ files: changedFiles });
     else {
-      outro('No changes detected, write some code and run `oc` again');
+      outro('No changes detected, write some code and run `oco` again');
       process.exit(1);
     }
   }

src/commands/config.ts

@@ -22,6 +22,8 @@ export enum CONFIG_KEYS {
   OCO_LANGUAGE = 'OCO_LANGUAGE'
 }
 
+export const DEFAULT_MODEL_TOKEN_LIMIT = 4096;
+
 export enum CONFIG_MODES {
   get = 'get',
   set = 'set'

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

@@ -24,7 +24,7 @@ export const prepareCommitMessageHook = async (
 
       if (changedFiles) await gitAdd({ files: changedFiles });
       else {
-        outro('No changes detected, write some code and run `oc` again');
+        outro('No changes detected, write some code and run `oco` again');
         process.exit(1);
       }
     }

src/generateCommitMessageFromGitDiff.ts

@@ -1,28 +1,28 @@
 import {
-  ChatCompletionRequestMessage,
-  ChatCompletionRequestMessageRoleEnum
+    ChatCompletionRequestMessage,
+    ChatCompletionRequestMessageRoleEnum
 } from 'openai';
-import { api } from './api';
-import { getConfig } from './commands/config';
-import { mergeDiffs } from './utils/mergeDiffs';
-import { i18n, I18nLocals } from './i18n';
-import { tokenCount } from './utils/tokenCount';
+import {api} from './api';
+import {DEFAULT_MODEL_TOKEN_LIMIT, getConfig} from './commands/config';
+import {mergeDiffs} from './utils/mergeDiffs';
+import {i18n, I18nLocals} from './i18n';
+import {tokenCount} from './utils/tokenCount';
 
 const config = getConfig();
 const translation = i18n[(config?.OCO_LANGUAGE as I18nLocals) || 'en'];
 
 const INIT_MESSAGES_PROMPT: Array<ChatCompletionRequestMessage> = [
-  {
-    role: ChatCompletionRequestMessageRoleEnum.System,
-    // prettier-ignore
-    content: `You are to act as the author of a commit message in git. Your mission is to create clean and comprehensive commit messages in the conventional commit convention and explain WHAT were the changes and WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you convert it into a commit message.
-${config?.OCO_EMOJI ? 'Use GitMoji convention to preface the commit.': 'Do not preface the commit with anything.'}
-${config?.OCO_DESCRIPTION  ? 'Add a short description of WHY the changes are done after the commit message. Don\'t start it with "This commit", just describe the changes.': "Don't add any descriptions to the commit, only commit message."}
+    {
+        role: ChatCompletionRequestMessageRoleEnum.System,
+        // prettier-ignore
+        content: `You are to act as the author of a commit message in git. Your mission is to create clean and comprehensive commit messages in the conventional commit convention and explain WHAT were the changes and WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you convert it into a commit message.
+${config?.OCO_EMOJI ? 'Use GitMoji convention to preface the commit.' : 'Do not preface the commit with anything.'}
+${config?.OCO_DESCRIPTION ? 'Add a short description of WHY the changes are done after the commit message. Don\'t start it with "This commit", just describe the changes.' : "Don't add any descriptions to the commit, only commit message."}
 Use the present tense. Lines must not be longer than 74 characters. Use ${translation.localLanguage} to answer.`
-  },
-  {
-    role: ChatCompletionRequestMessageRoleEnum.User,
-    content: `diff --git a/src/server.ts b/src/server.ts
+    },
+    {
+        role: ChatCompletionRequestMessageRoleEnum.User,
+        content: `diff --git a/src/server.ts b/src/server.ts
 index ad4db42..f3b18a9 100644
 --- a/src/server.ts
 +++ b/src/server.ts
@@ -46,128 +46,183 @@ app.use((_, res, next) => {
  +app.listen(process.env.PORT || PORT, () => {
  +  console.log(\`Server listening on port \${PORT}\`);
   });`
-  },
-  {
-    role: ChatCompletionRequestMessageRoleEnum.Assistant,
-    content: `${config?.OCO_EMOJI ? '🐛 ' : ''}${translation.commitFix}
+    },
+    {
+        role: ChatCompletionRequestMessageRoleEnum.Assistant,
+        content: `${config?.OCO_EMOJI ? '🐛 ' : ''}${translation.commitFix}
 ${config?.OCO_EMOJI ? '✨ ' : ''}${translation.commitFeat}
 ${config?.OCO_DESCRIPTION ? translation.commitDescription : ''}`
-  }
+    }
 ];
 
 const generateCommitMessageChatCompletionPrompt = (
-  diff: string
+    diff: string
 ): Array<ChatCompletionRequestMessage> => {
-  const chatContextAsCompletionRequest = [...INIT_MESSAGES_PROMPT];
+    const chatContextAsCompletionRequest = [...INIT_MESSAGES_PROMPT];
 
-  chatContextAsCompletionRequest.push({
-    role: ChatCompletionRequestMessageRoleEnum.User,
-    content: diff
-  });
+    chatContextAsCompletionRequest.push({
+        role: ChatCompletionRequestMessageRoleEnum.User,
+        content: diff
+    });
 
-  return chatContextAsCompletionRequest;
+    return chatContextAsCompletionRequest;
 };
 
 export enum GenerateCommitMessageErrorEnum {
-  tooMuchTokens = 'TOO_MUCH_TOKENS',
-  internalError = 'INTERNAL_ERROR',
-  emptyMessage = 'EMPTY_MESSAGE'
+    tooMuchTokens = 'TOO_MUCH_TOKENS',
+    internalError = 'INTERNAL_ERROR',
+    emptyMessage = 'EMPTY_MESSAGE'
 }
 
-
 const INIT_MESSAGES_PROMPT_LENGTH = INIT_MESSAGES_PROMPT.map(
-  (msg) => tokenCount(msg.content) + 4
+    (msg) => tokenCount(msg.content) + 4
 ).reduce((a, b) => a + b, 0);
 
-const MAX_REQ_TOKENS = 3000 - INIT_MESSAGES_PROMPT_LENGTH;
+const ADJUSTMENT_FACTOR = 20;
 
 export const generateCommitMessageByDiff = async (
-  diff: string
+    diff: string
 ): Promise<string> => {
-  try {
-    if (tokenCount(diff) >= MAX_REQ_TOKENS) {
-      const commitMessagePromises = getCommitMsgsPromisesFromFileDiffs(
-        diff,
-        MAX_REQ_TOKENS
-      );
+    try {
+        const MAX_REQUEST_TOKENS = DEFAULT_MODEL_TOKEN_LIMIT
+            - ADJUSTMENT_FACTOR
+            - INIT_MESSAGES_PROMPT_LENGTH
+            - config?.OCO_OPENAI_MAX_TOKENS;
 
-      const commitMessages = await Promise.all(commitMessagePromises);
+        if (tokenCount(diff) >= MAX_REQUEST_TOKENS) {
+            const commitMessagePromises = getCommitMsgsPromisesFromFileDiffs(
+                diff,
+                MAX_REQUEST_TOKENS
+            );
 
-      return commitMessages.join('\n\n');
-    } else {
-      const messages = generateCommitMessageChatCompletionPrompt(diff);
+            const commitMessages = [];
+            for (const promise of commitMessagePromises) {
+                commitMessages.push(await promise);
+                await delay(2000);
+            }
 
-      const commitMessage = await api.generateCommitMessage(messages);
+            return commitMessages.join('\n\n');
+        } else {
+            const messages = generateCommitMessageChatCompletionPrompt(diff);
 
-      if (!commitMessage)
-        throw new Error(GenerateCommitMessageErrorEnum.emptyMessage);
+            const commitMessage = await api.generateCommitMessage(messages);
 
-      return commitMessage;
+            if (!commitMessage)
+                throw new Error(GenerateCommitMessageErrorEnum.emptyMessage);
+
+            return commitMessage;
+        }
+    } catch (error) {
+        throw error;
     }
-  } catch (error) {
-    throw error;
-  }
 };
 
 function getMessagesPromisesByChangesInFile(
-  fileDiff: string,
-  separator: string,
-  maxChangeLength: number
+    fileDiff: string,
+    separator: string,
+    maxChangeLength: number
 ) {
-  const hunkHeaderSeparator = '@@ ';
-  const [fileHeader, ...fileDiffByLines] = fileDiff.split(hunkHeaderSeparator);
+    const hunkHeaderSeparator = '@@ ';
+    const [fileHeader, ...fileDiffByLines] = fileDiff.split(hunkHeaderSeparator);
 
-  // merge multiple line-diffs into 1 to save tokens
-  const mergedChanges = mergeDiffs(
-    fileDiffByLines.map((line) => hunkHeaderSeparator + line),
-    maxChangeLength
-  );
-
-  const lineDiffsWithHeader = mergedChanges.map(
-    (change) => fileHeader + change
-  );
-
-  const commitMsgsFromFileLineDiffs = lineDiffsWithHeader.map((lineDiff) => {
-    const messages = generateCommitMessageChatCompletionPrompt(
-      separator + lineDiff
+    // merge multiple line-diffs into 1 to save tokens
+    const mergedChanges = mergeDiffs(
+        fileDiffByLines.map((line) => hunkHeaderSeparator + line),
+        maxChangeLength
     );
 
-    return api.generateCommitMessage(messages);
-  });
+    const lineDiffsWithHeader = [];
+    for (const change of mergedChanges) {
+        const totalChange = fileHeader + change;
+        if (tokenCount(totalChange) > maxChangeLength) {
+            // If the totalChange is too large, split it into smaller pieces
+            const splitChanges = splitDiff(totalChange, maxChangeLength);
+            lineDiffsWithHeader.push(...splitChanges);
+        } else {
+            lineDiffsWithHeader.push(totalChange);
+        }
+    }
 
-  return commitMsgsFromFileLineDiffs;
+    const commitMsgsFromFileLineDiffs = lineDiffsWithHeader.map((lineDiff) => {
+        const messages = generateCommitMessageChatCompletionPrompt(
+            separator + lineDiff
+        );
+
+        return api.generateCommitMessage(messages);
+    });
+
+    return commitMsgsFromFileLineDiffs;
+}
+
+
+function splitDiff(diff: string, maxChangeLength: number) {
+    const lines = diff.split('\n');
+    const splitDiffs = [];
+    let currentDiff = '';
+
+    for (let line of lines) {
+        // If a single line exceeds maxChangeLength, split it into multiple lines
+        while (tokenCount(line) > maxChangeLength) {
+            const subLine = line.substring(0, maxChangeLength);
+            line = line.substring(maxChangeLength);
+            splitDiffs.push(subLine);
+        }
+
+        // Check the tokenCount of the currentDiff and the line separately
+        if (tokenCount(currentDiff) + tokenCount('\n' + line) > maxChangeLength) {
+            // If adding the next line would exceed the maxChangeLength, start a new diff
+            splitDiffs.push(currentDiff);
+            currentDiff = line;
+        } else {
+            // Otherwise, add the line to the current diff
+            currentDiff += '\n' + line;
+        }
+    }
+
+    // Add the last diff
+    if (currentDiff) {
+        splitDiffs.push(currentDiff);
+    }
+
+    return splitDiffs;
 }
 
 export function getCommitMsgsPromisesFromFileDiffs(
-  diff: string,
-  maxDiffLength: number
+    diff: string,
+    maxDiffLength: number
 ) {
-  const separator = 'diff --git ';
+    const separator = 'diff --git ';
 
-  const diffByFiles = diff.split(separator).slice(1);
+    const diffByFiles = diff.split(separator).slice(1);
 
-  // merge multiple files-diffs into 1 prompt to save tokens
-  const mergedFilesDiffs = mergeDiffs(diffByFiles, maxDiffLength);
+    // merge multiple files-diffs into 1 prompt to save tokens
+    const mergedFilesDiffs = mergeDiffs(diffByFiles, maxDiffLength);
 
-  const commitMessagePromises = [];
+    const commitMessagePromises = [];
 
-  for (const fileDiff of mergedFilesDiffs) {
-    if (tokenCount(fileDiff) >= maxDiffLength) {
-      // if file-diff is bigger than gpt context — split fileDiff into lineDiff
-      const messagesPromises = getMessagesPromisesByChangesInFile(
-        fileDiff,
-        separator,
-        maxDiffLength
-      );
+    for (const fileDiff of mergedFilesDiffs) {
+        if (tokenCount(fileDiff) >= maxDiffLength) {
+            // if file-diff is bigger than gpt context — split fileDiff into lineDiff
+            const messagesPromises = getMessagesPromisesByChangesInFile(
+                fileDiff,
+                separator,
+                maxDiffLength
+            );
 
-      commitMessagePromises.push(...messagesPromises);
-    } else {
-      const messages = generateCommitMessageChatCompletionPrompt(
-        separator + fileDiff
-      );
+            commitMessagePromises.push(...messagesPromises);
+        } else {
+            const messages = generateCommitMessageChatCompletionPrompt(
+                separator + fileDiff
+            );
 
-      commitMessagePromises.push(api.generateCommitMessage(messages));
+            commitMessagePromises.push(api.generateCommitMessage(messages));
+        }
     }
-  }
-  return commitMessagePromises;
+
+
+    return commitMessagePromises;
+}
+
+function delay(ms: number) {
+    return new Promise(resolve => setTimeout(resolve, ms));
 }

src/utils/checkIsLatestVersion.ts

@@ -1,6 +1,7 @@
 import { getOpenCommitLatestVersion } from '../api';
 import currentPackage from '../../package.json' assert { type: 'json' };
 import chalk from 'chalk';
+import { outro } from '@clack/prompts';
 
 export const checkIsLatestVersion = async () => {
   const latestVersion = await getOpenCommitLatestVersion();
@@ -9,7 +10,7 @@ export const checkIsLatestVersion = async () => {
     const currentVersion = currentPackage.version;
 
     if (currentVersion !== latestVersion) {
-      console.warn(
+      outro(
         chalk.yellow(
           `
 You are not using the latest stable version of OpenCommit with new features and bug fixes.