1.1.25

feat(generateCommitMessageFromGitDiff.ts): split file diffs into changes in files if they exceed the maximum token count
The mergeStrings function was renamed to mergeDiffs to better reflect its purpose. The function now takes an additional parameter, maxDiffLength, which is used to split file diffs into changes in files if they exceed the maximum token count. This change improves the efficiency of the function and reduces the number of tokens used.

.github/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contribution Guidelines
 
-Thank you for considering contributing to the project. Let's shake it baby.
+Thanks for considering contributing to the project.
 
 ## How to contribute
 
@@ -9,7 +9,7 @@ Thank you for considering contributing to the project. Let's shake it baby.
 3. Create a new branch for your changes.
 4. Make your changes and commit them with descriptive commit messages.
 5. Push your changes to your forked repository.
-6. Create a pull request from your branch to the `master` branch.
+6. Create a pull request from your branch to the `dev` branch.
 
 ## Getting started
 
@@ -28,9 +28,9 @@ Use the library to generate commits, stage the files and run `npm run dev` :)
 
 If you encounter any issues while using the project, please report them on the GitHub issue tracker. When reporting issues, please include as much information as possible, such as steps to reproduce the issue, expected behavior, and actual behavior.
 
-## Contact us
+## Contacts
 
-If you have any questions about contributing to the project, please contact us by [creating an issue](https://github.com/di-sukharev/open-commit/issues) on the GitHub issue tracker.
+If you have any questions about contributing to the project, please contact by [creating an issue](https://github.com/di-sukharev/open-commit/issues) on the GitHub issue tracker.
 
 ## License
 

.gitignore

@@ -11,4 +11,5 @@ logfile.log
 uncaughtExceptions.log
 .vscode
 src/*.json
-.idea
+.idea
+test.ts

package-lock.json

@@ -1,15 +1,16 @@
 {
   "name": "opencommit",
-  "version": "1.1.22",
+  "version": "1.1.25",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "opencommit",
-      "version": "1.1.22",
-      "license": "ISC",
+      "version": "1.1.25",
+      "license": "MIT",
       "dependencies": {
         "@clack/prompts": "^0.6.1",
+        "@dqbd/tiktoken": "^1.0.2",
         "axios": "^1.3.4",
         "chalk": "^5.2.0",
         "cleye": "^1.3.2",
@@ -83,6 +84,11 @@
         "node": ">=12"
       }
     },
+    "node_modules/@dqbd/tiktoken": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/@dqbd/tiktoken/-/tiktoken-1.0.2.tgz",
+      "integrity": "sha512-AjGTBRWsMoVmVeN55NLyupyM8TNamOUBl6tj5t/leLDVup3CFGO9tVagNL1jf3GyZLkWZSTmYVbPQ/M2LEcNzw=="
+    },
     "node_modules/@esbuild/android-arm": {
       "version": "0.15.18",
       "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.15.18.tgz",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencommit",
-  "version": "1.1.22",
+  "version": "1.1.25",
   "description": "GPT CLI to auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
   "keywords": [
     "git",
@@ -24,7 +24,7 @@
   },
   "type": "module",
   "author": "https://github.com/di-sukharev",
-  "license": "ISC",
+  "license": "MIT",
   "files": [
     "out/**/*"
   ],
@@ -60,6 +60,7 @@
   },
   "dependencies": {
     "@clack/prompts": "^0.6.1",
+    "@dqbd/tiktoken": "^1.0.2",
     "axios": "^1.3.4",
     "chalk": "^5.2.0",
     "cleye": "^1.3.2",

src/CommandsEnum.ts

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

src/commands/commit.ts

@@ -63,7 +63,7 @@ ${chalk.grey('——————————————————')}`
   );
 
   const isCommitConfirmedByUser = await confirm({
-    message: 'Confirm the commit message'
+    message: 'Confirm the commit message?'
   });
 
   if (isCommitConfirmedByUser && !isCancel(isCommitConfirmedByUser)) {
@@ -86,11 +86,19 @@ ${chalk.grey('——————————————————')}`
 
       if (isPushConfirmedByUser && !isCancel(isPushConfirmedByUser)) {
         const pushSpinner = spinner();
+
         pushSpinner.start(`Running \`git push ${remotes[0]}\``);
-        const { stdout } = await execa('git', ['push', remotes[0]]);
+
+        const { stdout } = await execa('git', [
+          'push',
+          '--verbose',
+          remotes[0]
+        ]);
+
         pushSpinner.stop(
           `${chalk.green('✔')} successfully pushed all commits to ${remotes[0]}`
         );
+
         if (stdout) outro(stdout);
       }
     } else {
@@ -101,8 +109,11 @@ ${chalk.grey('——————————————————')}`
 
       if (!isCancel(selectedRemote)) {
         const pushSpinner = spinner();
+
         pushSpinner.start(`Running \`git push ${selectedRemote}\``);
+
         const { stdout } = await execa('git', ['push', selectedRemote]);
+
         pushSpinner.stop(
           `${chalk.green(
             '✔'
@@ -196,6 +207,5 @@ export async function commit(
     outro(`${chalk.red('✖')} ${generateCommitError}`);
     process.exit(1);
   }
-
   process.exit(0);
 }

src/commands/config.ts

@@ -29,6 +29,7 @@ const validateConfig = (
     outro(
       `${chalk.red('✖')} Unsupported config key ${key}: ${validationMessage}`
     );
+
     process.exit(1);
   }
 };
@@ -49,6 +50,7 @@ export const configValidators = {
 
     return value;
   },
+
   [CONFIG_KEYS.description](value: any) {
     validateConfig(
       CONFIG_KEYS.description,
@@ -58,6 +60,7 @@ export const configValidators = {
 
     return value;
   },
+
   [CONFIG_KEYS.emoji](value: any) {
     validateConfig(
       CONFIG_KEYS.emoji,
@@ -67,6 +70,7 @@ export const configValidators = {
 
     return value;
   },
+
   [CONFIG_KEYS.language](value: any) {
     validateConfig(
       CONFIG_KEYS.language,

src/commands/githook.ts

@@ -55,18 +55,18 @@ export const hookCommand = command(
       }
 
       if (mode === 'unset') {
-        intro(`unsetting opencommit as '${HOOK_NAME}' hook`);
+        intro(`unsetting OpenCommit as '${HOOK_NAME}' hook`);
 
         if (!isHookExists) {
           return outro(
-            `opencommit wasn't previously set as '${HOOK_NAME}' hook, nothing to remove`
+            `OpenCommit wasn't previously set as '${HOOK_NAME}' hook, nothing to remove`
           );
         }
 
         const realpath = await fs.realpath(SYMLINK_URL);
         if (realpath !== HOOK_URL) {
           return outro(
-            `opencommit wasn't previously set as '${HOOK_NAME}' hook, but different hook was, if you want to remove it — do it manually`
+            `OpenCommit wasn't previously set as '${HOOK_NAME}' hook, but different hook was, if you want to remove it — do it manually`
           );
         }
 

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

@@ -1,6 +1,6 @@
 import fs from 'fs/promises';
 import chalk from 'chalk';
-import { intro, outro } from '@clack/prompts';
+import { intro, outro, spinner } from '@clack/prompts';
 import { getChangedFiles, getDiff, getStagedFiles, gitAdd } from '../utils/git';
 import { getConfig } from './config';
 import { generateCommitMessageWithChatCompletion } from '../generateCommitMessageFromGitDiff';
@@ -17,11 +17,13 @@ export const prepareCommitMessageHook = async () => {
 
     if (commitSource) return;
 
+    const stagedFiles = await getStagedFiles();
     const changedFiles = await getChangedFiles();
-    if (changedFiles) await gitAdd({ files: changedFiles });
+
+    if (!stagedFiles && changedFiles) await gitAdd({ files: changedFiles });
     else {
-        outro("No changes detected, write some code and run `oc` again");
-        process.exit(1);
+      outro('No changes detected, write some code and run `oc` again');
+      process.exit(1);
     }
 
     const staged = await getStagedFiles();
@@ -38,11 +40,15 @@ export const prepareCommitMessageHook = async () => {
       );
     }
 
+    const spin = spinner();
+    spin.start('Generating commit message');
     const commitMessage = await generateCommitMessageWithChatCompletion(
       await getDiff({ files: staged })
     );
-
-    if (typeof commitMessage !== 'string') throw new Error(commitMessage.error);
+    if (typeof commitMessage !== 'string') {
+      spin.stop('Error');
+      throw new Error(commitMessage.error);
+    } else spin.stop('Done');
 
     const fileContent = await fs.readFile(messageFilePath);
 

src/generateCommitMessageFromGitDiff.ts

@@ -4,49 +4,48 @@ import {
 } from 'openai';
 import { api } from './api';
 import { getConfig } from './commands/config';
-import { mergeStrings } from './utils/mergeStrings';
+import { mergeDiffs } from './utils/mergeDiffs';
 import { i18n, I18nLocals } from './i18n';
+import { tokenCount } from './utils/tokenCount';
 
 const config = getConfig();
-const translation = i18n[config?.language as I18nLocals || 'en']
+const translation = i18n[(config?.language as I18nLocals) || 'en'];
 
 const INIT_MESSAGES_PROMPT: Array<ChatCompletionRequestMessage> = [
   {
     role: ChatCompletionRequestMessageRoleEnum.System,
-    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. I'll send you an output of 'git diff --staged' command, and you convert it into a commit message. ${
-      config?.emoji
-        ? 'Use Gitmoji convention to preface the commit'
-        : 'Do not preface the commit with anything'
-    }, use the present tense. ${
-      config?.description
-        ? 'Add a short description of what commit is about 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 ${translation.localLanguage} to answer.`
+    // 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 why a change was done. I'll send you an output of 'git diff --staged' command, and you convert it into a commit message.
+${config?.emoji? 'Use Gitmoji convention to preface the commit.': 'Do not preface the commit with anything.'}
+${config?.description  ? 'Add a short description of why the commit is 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
-  index ad4db42..f3b18a9 100644
-  --- a/src/server.ts
-  +++ b/src/server.ts
-  @@ -10,7 +10,7 @@ import {
-    initWinstonLogger();
-    
-    const app = express();
-  -const port = 7799;
-  +const PORT = 7799;
-    
-    app.use(express.json());
-    
-  @@ -34,6 +34,6 @@ app.use((_, res, next) => {
-    // ROUTES
-    app.use(PROTECTED_ROUTER_URL, protectedRouter);
-    
-  -app.listen(port, () => {
-  -  console.log(\`Server listening on port \${port}\`);
-  +app.listen(process.env.PORT || PORT, () => {
-  +  console.log(\`Server listening on port \${PORT}\`);
-    });`
+index ad4db42..f3b18a9 100644
+--- a/src/server.ts
++++ b/src/server.ts
+@@ -10,7 +10,7 @@
+import {
+  initWinstonLogger();
+  
+  const app = express();
+ -const port = 7799;
+ +const PORT = 7799;
+  
+  app.use(express.json());
+  
+@@ -34,6 +34,6 @@
+app.use((_, res, next) => {
+  // ROUTES
+  app.use(PROTECTED_ROUTER_URL, protectedRouter);
+  
+ -app.listen(port, () => {
+ -  console.log(\`Server listening on port \${port}\`);
+ +app.listen(process.env.PORT || PORT, () => {
+ +  console.log(\`Server listening on port \${PORT}\`);
+  });`
   },
   {
     role: ChatCompletionRequestMessageRoleEnum.Assistant,
@@ -80,8 +79,8 @@ interface GenerateCommitMessageError {
 }
 
 const INIT_MESSAGES_PROMPT_LENGTH = INIT_MESSAGES_PROMPT.map(
-  (msg) => msg.content
-).join('').length;
+  (msg) => tokenCount(msg.content) + 4
+).reduce((a, b) => a + b, 0);
 
 const MAX_REQ_TOKENS = 3900 - INIT_MESSAGES_PROMPT_LENGTH;
 
@@ -89,8 +88,11 @@ export const generateCommitMessageWithChatCompletion = async (
   diff: string
 ): Promise<string | GenerateCommitMessageError> => {
   try {
-    if (diff.length >= MAX_REQ_TOKENS) {
-      const commitMessagePromises = getCommitMsgsPromisesFromFileDiffs(diff);
+    if (tokenCount(diff) >= MAX_REQ_TOKENS) {
+      const commitMessagePromises = getCommitMsgsPromisesFromFileDiffs(
+        diff,
+        MAX_REQ_TOKENS
+      );
 
       const commitMessages = await Promise.all(commitMessagePromises);
 
@@ -110,22 +112,28 @@ export const generateCommitMessageWithChatCompletion = async (
   }
 };
 
-function getMessagesPromisesByLines(fileDiff: string, separator: string) {
-  const lineSeparator = '\n@@';
-  const [fileHeader, ...fileDiffByLines] = fileDiff.split(lineSeparator);
+function getMessagesPromisesByChangesInFile(
+  fileDiff: string,
+  separator: string,
+  maxChangeLength: number
+) {
+  const hunkHeaderSeparator = '@@ ';
+  const [fileHeader, ...fileDiffByLines] = fileDiff.split(hunkHeaderSeparator);
 
   // merge multiple line-diffs into 1 to save tokens
-  const mergedLines = mergeStrings(
-    fileDiffByLines.map((line) => lineSeparator + line),
-    MAX_REQ_TOKENS
+  const mergedChanges = mergeDiffs(
+    fileDiffByLines.map((line) => hunkHeaderSeparator + line),
+    maxChangeLength
   );
 
-  const lineDiffsWithHeader = mergedLines.map(
-    (d) => fileHeader + lineSeparator + d
+  const lineDiffsWithHeader = mergedChanges.map(
+    (change) => fileHeader + change
   );
 
-  const commitMsgsFromFileLineDiffs = lineDiffsWithHeader.map((d) => {
-    const messages = generateCommitMessageChatCompletionPrompt(separator + d);
+  const commitMsgsFromFileLineDiffs = lineDiffsWithHeader.map((lineDiff) => {
+    const messages = generateCommitMessageChatCompletionPrompt(
+      separator + lineDiff
+    );
 
     return api.generateCommitMessage(messages);
   });
@@ -133,20 +141,27 @@ function getMessagesPromisesByLines(fileDiff: string, separator: string) {
   return commitMsgsFromFileLineDiffs;
 }
 
-function getCommitMsgsPromisesFromFileDiffs(diff: string) {
+export function getCommitMsgsPromisesFromFileDiffs(
+  diff: string,
+  maxDiffLength: number
+) {
   const separator = 'diff --git ';
 
   const diffByFiles = diff.split(separator).slice(1);
 
   // merge multiple files-diffs into 1 prompt to save tokens
-  const mergedFilesDiffs = mergeStrings(diffByFiles, MAX_REQ_TOKENS);
+  const mergedFilesDiffs = mergeDiffs(diffByFiles, maxDiffLength);
 
   const commitMessagePromises = [];
 
   for (const fileDiff of mergedFilesDiffs) {
-    if (fileDiff.length >= MAX_REQ_TOKENS) {
+    if (tokenCount(fileDiff) >= maxDiffLength) {
       // if file-diff is bigger than gpt context — split fileDiff into lineDiff
-      const messagesPromises = getMessagesPromisesByLines(fileDiff, separator);
+      const messagesPromises = getMessagesPromisesByChangesInFile(
+        fileDiff,
+        separator,
+        maxDiffLength
+      );
 
       commitMessagePromises.push(...messagesPromises);
     } else {

src/i18n/es_ES.json

@@ -0,0 +1,7 @@
+{
+    "localLanguage": "spanish",
+    "commitFix": "fix(server.ts): cambiar la variable port de minúsculas a mayúsculas PORT",
+    "commitFeat": "feat(server.ts): añadir soporte para la variable de entorno process.env.PORT",
+    "commitDescription": "La variable port ahora se llama PORT, lo que mejora la coherencia con las convenciones de nomenclatura, ya que PORT es una constante. El soporte para una variable de entorno permite que la aplicación sea más flexible, ya que ahora puede ejecutarse en cualquier puerto disponible especificado a través de la variable de entorno process.env.PORT."
+  }
+  

src/i18n/index.ts

@@ -7,6 +7,9 @@ import zh_CN from '../i18n/zh_CN.json' assert { type: 'json' };
 import zh_TW from '../i18n/zh_TW.json' assert { type: 'json' };
 import ja from '../i18n/ja.json' assert { type: 'json' };
 import pt_br from '../i18n/pt_br.json' assert { type: 'json' };
+import vi_VN from '../i18n/vi_VN.json' assert { type: 'json' };
+import es_ES from '../i18n/es_ES.json' assert { type: 'json' };
+import sv from '../i18n/sv.json' assert { type: 'json' };
 
 export enum I18nLocals {
   'en' = 'en',
@@ -17,7 +20,9 @@ export enum I18nLocals {
   'fr' = 'fr',
   'it' = 'it',
   'ko' = 'ko',
-  'pt_br' = 'pt_br'
+  'pt_br' = 'pt_br',
+  'es_ES' = 'es_ES',
+  'sv' = 'sv',
 };
 
 export const i18n = {
@@ -29,7 +34,10 @@ export const i18n = {
   fr,
   it,
   ko,
-  pt_br
+  pt_br,
+  vi_VN,
+  es_ES,
+  sv
 };
 
 export const I18N_CONFIG_ALIAS: { [key: string]: string[] } = {
@@ -41,7 +49,10 @@ export const I18N_CONFIG_ALIAS: { [key: string]: string[] } = {
   fr: ['fr', 'French', 'française'],
   it: ['it', 'Italian', 'italiano'],
   pt_br: ['pt_br', 'Portuguese', 'português'],
+  vi_VN: ['vi_VN', 'Vietnamese', 'tiếng Việt'],
   en: ['en', 'English', 'english'],
+  es_ES: ['es_ES', 'Spanish', 'español'],
+  sv: ['sv', 'Swedish', 'Svenska'],
 };
 
 export function getI18nLocal(value: string): string | boolean {

src/i18n/sv.json

@@ -0,0 +1,6 @@
+{
+"localLanguage": "svenska",
+"commitFix": "fixa(server.ts): ändra variabelnamnet för port från små bokstäver till stora bokstäver PORT",
+"commitFeat": "nyhet(server.ts): lägg till stöd för process.env.PORT miljövariabel",
+"commitDescription": "Variabeln som innehåller portnumret heter nu PORT vilket förbättrar konsekvensen med namngivningskonventionerna eftersom PORT är en konstant. Stöd för en miljövariabel gör att applikationen kan vara mer flexibel då den nu kan köras på vilken port som helst som specificeras via miljövariabeln process.env.PORT."
+}

src/i18n/vi_VN.json

@@ -0,0 +1,6 @@
+{
+  "localLanguage": "vietnamese",
+  "commitFix": "fix(server.ts): thay đổi chữ viết thường của biến port thành chữ viết hoa PORT",
+  "commitFeat": "feat(server.ts): thêm hỗ trợ cho biến môi trường process.env.PORT",
+  "commitDescription": "Biến port đã được đổi tên thành PORT, giúp cải thiện tính nhất quán trong việc đặt tên theo quy ước vì PORT là một hằng số. Hỗ trợ cho biến môi trường cho phép ứng dụng linh hoạt hơn khi có thể chạy trên bất kỳ cổng nào được chỉ định thông qua biến môi trường process.env.PORT."
+}

src/utils/git.ts

@@ -26,11 +26,17 @@ export const getOpenCommitIgnore = (): Ignore => {
 };
 
 export const getStagedFiles = async (): Promise<string[]> => {
-  const { stdout: files } = await execa('git', [
-    'diff',
-    '--name-only',
-    '--cached',
-    '--relative'
+  const { stdout: gitDir } = await execa("git", [
+      "rev-parse",
+      "--show-toplevel"
+  ]);
+
+  const { stdout: files } = await execa("git", [
+    "diff",
+    "--name-only",
+    "--cached",
+    "--relative",
+    gitDir
   ]);
 
   if (!files) return [];

src/utils/mergeDiffs.ts

@@ -1,8 +1,9 @@
-export function mergeStrings(arr: string[], maxStringLength: number): string[] {
+import { tokenCount } from './tokenCount';
+export function mergeDiffs(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) {
+    if (tokenCount(currentItem + item) <= maxStringLength) {
       currentItem += item;
     } else {
       mergedArr.push(currentItem);

src/utils/tokenCount.ts

@@ -0,0 +1,14 @@
+import { Tiktoken } from "@dqbd/tiktoken/lite"
+import cl100k_base from "@dqbd/tiktoken/encoders/cl100k_base.json" assert{type: "json"}
+
+export function tokenCount(content: string): number {
+    const encoding = new Tiktoken(
+        cl100k_base.bpe_ranks,
+        cl100k_base.special_tokens,
+        cl100k_base.pat_str
+    );
+    const tokens = encoding.encode(content);
+    encoding.free();
+
+    return tokens.length;
+}