1.1.37

refactor(githook.ts): simplify switch statement by removing comments and adding inline comments

.gitignore

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

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "opencommit",
-  "version": "1.1.24",
+  "version": "1.1.37",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "opencommit",
-      "version": "1.1.24",
+      "version": "1.1.37",
       "license": "MIT",
       "dependencies": {
         "@clack/prompts": "^0.6.1",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencommit",
-  "version": "1.1.24",
+  "version": "1.1.37",
   "description": "GPT CLI to auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
   "keywords": [
     "git",

src/commands/commit.ts

@@ -22,10 +22,9 @@ import {
 import chalk from 'chalk';
 import { trytm } from '../utils/trytm';
 
-// Adding a function to get the list of remotes
 const getGitRemotes = async () => {
   const { stdout } = await execa('git', ['remote']);
-  return stdout.split('\n').filter((remote) => remote.trim() !== '');
+  return stdout.split('\n').filter((remote) => Boolean(remote.trim()));
 };
 
 const generateCommitMessageFromGitDiff = async (
@@ -77,8 +76,15 @@ ${chalk.grey('——————————————————')}`
     outro(`${chalk.green('✔')} successfully committed`);
 
     outro(stdout);
+
     const remotes = await getGitRemotes();
 
+    if (!remotes.length) {
+      const { stdout } = await execa('git', ['push']);
+      if (stdout) outro(stdout);
+      process.exit(0);
+    }
+
     if (remotes.length === 1) {
       const isPushConfirmedByUser = await confirm({
         message: 'Do you want to run `git push`?'
@@ -100,6 +106,9 @@ ${chalk.grey('——————————————————')}`
         );
 
         if (stdout) outro(stdout);
+      } else {
+        outro('`git push` aborted');
+        process.exit(0);
       }
     } else {
       const selectedRemote = (await select({
@@ -207,5 +216,6 @@ export async function commit(
     outro(`${chalk.red('✖')} ${generateCommitError}`);
     process.exit(1);
   }
+
   process.exit(0);
 }

src/commands/githook.ts

@@ -7,10 +7,27 @@ import chalk from 'chalk';
 import { intro, outro } from '@clack/prompts';
 import { COMMANDS } from '../CommandsEnum.js';
 
-const HOOK_NAME = 'prepare-commit-msg';
-const SYMLINK_URL = `.git/hooks/${HOOK_NAME}`;
+const platform = process.platform;
 
-export const isHookCalled = process.argv[1].endsWith(`/${SYMLINK_URL}`);
+let separator = '';
+switch (platform) {
+  case 'win32': // Windows
+    separator = path.sep;
+    break;
+  case 'darwin': // macOS
+    separator = '';
+    break;
+  case 'linux': // Linux
+    separator = '';
+    break;
+  default:
+    throw new Error(`Unsupported platform: ${platform}`);
+}
+
+const HOOK_NAME = 'prepare-commit-msg';
+const SYMLINK_URL = path.join(separator, '.git', 'hooks', HOOK_NAME);
+
+export const isHookCalled = process.argv[1].endsWith(`${SYMLINK_URL}`);
 
 const isHookExists = existsSync(SYMLINK_URL);
 
@@ -28,7 +45,7 @@ export const hookCommand = command(
       const { setUnset: mode } = argv._;
 
       if (mode === 'set') {
-        intro(`setting opencommit as '${HOOK_NAME}' hook`);
+        intro(`setting OpenCommit as '${HOOK_NAME}' hook`);
 
         if (isHookExists) {
           let realPath;
@@ -40,7 +57,7 @@ export const hookCommand = command(
           }
 
           if (realPath === HOOK_URL)
-            return outro(`opencommit is already set as '${HOOK_NAME}'`);
+            return outro(`OpenCommit is already set as '${HOOK_NAME}'`);
 
           throw new Error(
             `Different ${HOOK_NAME} is already set. Remove it before setting opencommit as '${HOOK_NAME}' hook.`

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,13 +17,16 @@ export const prepareCommitMessageHook = async () => {
 
     if (commitSource) return;
 
+    const stagedFiles = await getStagedFiles();
     const changedFiles = await getChangedFiles();
-    if (changedFiles) await gitAdd({ files: changedFiles });
-    else {
-        outro("No changes detected, write some code and run `oc` again");
-        process.exit(1);
+
+    if (!stagedFiles && !changedFiles) {
+      outro('No changes detected, write some code and run `oc` again');
+      process.exit(1);
     }
 
+    if (!stagedFiles && changedFiles) await gitAdd({ files: changedFiles });
+
     const staged = await getStagedFiles();
 
     if (!staged) return;
@@ -38,11 +41,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,8 +4,9 @@ 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'];
@@ -13,40 +14,38 @@ 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 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
-  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

@@ -1,7 +1,6 @@
-{
-    "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."
-  }
-  
+{
+  "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/id_ID.json

@@ -0,0 +1,6 @@
+{
+  "localLanguage": "bahasa",
+  "commitFix": "fix(server.ts): mengubah huruf port variable dari huruf kecil ke huruf besar PORT",
+  "commitFeat": "feat(server.ts): menambahkan support di process.env.PORT environment variabel",
+  "commitDescription": "Port variabel bernama PORT, yang membantu konsistensi dengan memberi nama yaitu PORT yang konstan. Bantuan environment variabel membantu aplikasi lebih fleksibel, dan dapat di jalankan di port manapun yang tertulis pada process.env.PORT"
+}

src/i18n/index.ts

@@ -9,6 +9,10 @@ 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' };
+import nl from '../i18n/nl.json' assert { type: 'json' };
+import ru from '../i18n/ru.json' assert { type: 'json' };
+import id_ID from '../i18n/id_ID.json' assert { type: 'json' };
 
 export enum I18nLocals {
   'en' = 'en',
@@ -17,11 +21,15 @@ export enum I18nLocals {
   'ja' = 'ja',
   'de' = 'de',
   'fr' = 'fr',
+  'nl' = 'nl',
   'it' = 'it',
   'ko' = 'ko',
   'pt_br' = 'pt_br',
-  'es_ES' = 'es_ES'
-};
+  'es_ES' = 'es_ES',
+  'sv' = 'sv',
+  'ru' = 'ru',
+  'id_ID' = 'id_ID'
+}
 
 export const i18n = {
   en,
@@ -34,7 +42,11 @@ export const i18n = {
   ko,
   pt_br,
   vi_VN,
-  es_ES
+  es_ES,
+  sv,
+  id_ID,
+  nl,
+  ru
 };
 
 export const I18N_CONFIG_ALIAS: { [key: string]: string[] } = {
@@ -42,13 +54,17 @@ export const I18N_CONFIG_ALIAS: { [key: string]: string[] } = {
   zh_TW: ['zh_TW', '繁體中文', '繁體'],
   ja: ['ja', 'Japanese', 'にほんご'],
   ko: ['ko', 'Korean', '한국어'],
-  de: ['de', 'German' ,'Deutsch'],
+  de: ['de', 'German', 'Deutsch'],
   fr: ['fr', 'French', 'française'],
   it: ['it', 'Italian', 'italiano'],
+  nl: ['nl', 'Dutch', 'Nederlands'],
   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'],
+  ru: ['ru', 'Russian', 'русский'],
+  id_ID: ['id_ID', 'Bahasa', 'bahasa']
 };
 
 export function getI18nLocal(value: string): string | boolean {

src/i18n/nl.json

@@ -0,0 +1,6 @@
+{
+  "localLanguage": "Nederlands",
+  "commitFix": "fix(server.ts): verander poortvariabele van kleine letters poort naar hoofdletters PORT",
+  "commitFeat": "feat(server.ts): voeg ondersteuning toe voor process.env.PORT omgevingsvariabele",
+  "commitDescription": "De poortvariabele heet nu PORT, wat de consistentie met de naamgevingsconventies verbetert omdat PORT een constante is. Ondersteuning voor een omgevingsvariabele maakt de applicatie flexibeler, omdat deze nu kan draaien op elke beschikbare poort die is gespecificeerd via de process.env.PORT omgevingsvariabele."
+}

src/i18n/pt_br.json

@@ -1,7 +1,6 @@
 {
-    "localLanguage": "português",
-    "commitFix": "fix(server.ts): altera o caso da variável de porta de port minúscula para PORT maiúscula",
-    "commitFeat": "feat(server.ts): adiciona suporte para a variável de ambiente process.env.PORT",
-    "commitDescription": "A variável de porta agora é denominada PORT, o que melhora a consistência com as convenções de nomenclatura, pois PORT é uma constante. O suporte para uma variável de ambiente permite que o aplicativo seja mais flexível, pois agora pode ser executado em qualquer porta disponível especificada por meio da variável de ambiente process.env.PORT."
+  "localLanguage": "português",
+  "commitFix": "fix(server.ts): altera o caso da variável de porta de port minúscula para PORT maiúscula",
+  "commitFeat": "feat(server.ts): adiciona suporte para a variável de ambiente process.env.PORT",
+  "commitDescription": "A variável de porta agora é denominada PORT, o que melhora a consistência com as convenções de nomenclatura, pois PORT é uma constante. O suporte para uma variável de ambiente permite que o aplicativo seja mais flexível, pois agora pode ser executado em qualquer porta disponível especificada por meio da variável de ambiente process.env.PORT."
 }
-  

src/i18n/ru.json

@@ -0,0 +1,6 @@
+{
+  "localLanguage": "русский",
+  "commitFix": "fix(server.ts): изменение регистра переменной порта с нижнего регистра port на верхний регистр PORT",
+  "commitFeat": "feat(server.ts): добавлена поддержка переменной окружения process.env.PORT",
+  "commitDescription": "Переменная port теперь называется PORT, что улучшает согласованность с соглашениями об именовании констант. Поддержка переменной окружения позволяет приложению быть более гибким, запускаясь на любом доступном порту, указанном с помощью переменной окружения process.env.PORT."
+}

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/utils/git.ts

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

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 content.length / 2.7;
+}

tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "ES2020",
+    "target": "ESNext",
     "lib": ["ES5", "ES6"],
 
     "module": "ESNext",