3.0.12

style(git.ts): add line breaks for better code readability

README.md

@@ -4,7 +4,7 @@
     <h1 align="center">OpenCommit</h1>
     <h4 align="center">Follow the bird <a href="https://twitter.com/_sukharev_"><img src="https://img.shields.io/twitter/follow/_sukharev_?style=flat&label=_sukharev_&logo=twitter&color=0bf&logoColor=fff" align="center"></a>
   </div>
-	<h2>Auto-generate meaningful commits in 1 second</h2>
+	<h2>Auto-generate meaningful commits in a 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>
   <h4 align="center">🪩 Winner of <a href="https://twitter.com/_sukharev_/status/1683448136973582336">GitHub 2023 hackathon</a> 🪩</h4>
@@ -58,6 +58,8 @@ git add <files...>
 oco
 ```
 
+Link to the GitMoji specification: https://gitmoji.dev/
+
 You can also run it with local model through ollama:
 
 - install and start ollama
@@ -66,7 +68,20 @@ You can also run it with local model through ollama:
 
 ```sh
 git add <files...>
-AI_PROVIDER='ollama' opencommit
+OCO_AI_PROVIDER='ollama' opencommit
+```
+
+### Flags
+
+There are multiple optional flags that can be used with the `oco` command:
+
+#### Use Full GitMoji Specification
+
+This flag can only be used if the `OCO_EMOJI` configuration item is set to `true`. This flag allows users to use all emojis in the GitMoji specification, By default, the GitMoji full specification is set to `false`, which only includes 10 emojis (🐛✨📝🚀✅♻️⬆️🔧🌐💡).
+This is due to limit the number of tokens sent in each request. However, if you would like to use the full GitMoji specification, you can use the `--fgm` flag.
+
+```
+oco --fgm
 ```
 
 ## Configuration
@@ -77,14 +92,16 @@ Create a `.env` file and add OpenCommit config variables there like this:
 
 ```env
 OCO_OPENAI_API_KEY=<your OpenAI API token>
-OCO_OPENAI_MAX_TOKENS=<max response tokens from OpenAI API>
+OCO_TOKENS_MAX_INPUT=<max model token limit (default: 4096)>
+OCO_TOKENS_MAX_OUTPUT=<max response tokens (default: 500)>
 OCO_OPENAI_BASE_PATH=<may be used to set proxy path to OpenAI api>
 OCO_DESCRIPTION=<postface a message with ~3 sentences description of the changes>
 OCO_EMOJI=<boolean, add GitMoji>
-OCO_MODEL=<either 'gpt-4', 'gpt-3.5-turbo-16k' (default), 'gpt-3.5-turbo-0613' or 'gpt-3.5-turbo'>
+OCO_MODEL=<either 'gpt-4', 'gpt-3.5-turbo' (default), 'gpt-3.5-turbo-0125', 'gpt-4-1106-preview', 'gpt-4-turbo-preview' or 'gpt-4-0125-preview'>
 OCO_LANGUAGE=<locale, scroll to the bottom to see options>
 OCO_MESSAGE_TEMPLATE_PLACEHOLDER=<message template placeholder, default: '$msg'>
 OCO_PROMPT_MODULE=<either conventional-commit or @commitlint, default: conventional-commit>
+OCO_ONE_LINE_COMMIT=<one line commit message, default: false>
 ```
 
 ### Global config for all repos
@@ -111,7 +128,7 @@ oco config set OCO_EMOJI=false
 
 ### Switch to GPT-4 or other models
 
-By default, OpenCommit uses `gpt-3.5-turbo-16k` model.
+By default, OpenCommit uses `gpt-3.5-turbo` model.
 
 You may switch to GPT-4 which performs better, but costs ~x15 times more 🤠
 
@@ -128,7 +145,7 @@ oco config set OCO_MODEL=gpt-3.5-turbo
 or for GPT-4 Turbo (Preview) which is more capable, has knowledge of world events up to April 2023, a 128k context window and 2-3x cheaper vs GPT-4:
 
 ```sh
-oco config set OCO_MODEL=gpt-4-1106-preview
+oco config set OCO_MODEL=gpt-4-0125-preview
 ```
 
 Make sure that you spell it `gpt-4` (lowercase) and that you have API access to the 4th model. Even if you have ChatGPT+, that doesn't necessarily mean that you have API access to GPT-4.
@@ -329,11 +346,12 @@ jobs:
           OCO_OPENAI_API_KEY: ${{ secrets.OCO_OPENAI_API_KEY }}
 
           # customization
-          OCO_OPENAI_MAX_TOKENS: 500
+          OCO_TOKENS_MAX_INPUT: 4096
+          OCO_TOKENS_MAX_OUTPUT: 500
           OCO_OPENAI_BASE_PATH: ''
           OCO_DESCRIPTION: false
           OCO_EMOJI: false
-          OCO_MODEL: gpt-3.5-turbo-16k
+          OCO_MODEL: gpt-3.5-turbo
           OCO_LANGUAGE: en
           OCO_PROMPT_MODULE: conventional-commit
 ```
@@ -350,6 +368,6 @@ You pay for your requests to OpenAI API on your own.
 
 OpenCommit stores your key locally.
 
-OpenCommit by default uses 3.5-turbo-16k model, it should not exceed $0.10 per casual working day.
+OpenCommit by default uses 3.5-turbo model, it should not exceed $0.10 per casual working day.
 
 You may switch to gpt-4, it's better, but more expensive.

out/cli.cjs

@@ -16384,7 +16384,7 @@ function G3(t, e2) {
 // package.json
 var package_default = {
   name: "opencommit",
-  version: "3.0.8",
+  version: "3.0.11",
   description: "Auto-generate impressive commits in 1 second. Killing lame commits with AI \u{1F92F}\u{1F52B}",
   keywords: [
     "git",
@@ -18650,7 +18650,6 @@ function getI18nLocal(value) {
 
 // src/commands/config.ts
 dotenv.config();
-var DEFAULT_MODEL_TOKEN_LIMIT = 4096;
 var validateConfig = (key, condition, validationMessage) => {
   if (!condition) {
     ce(
@@ -18661,7 +18660,11 @@ var validateConfig = (key, condition, validationMessage) => {
 };
 var configValidators = {
   ["OCO_OPENAI_API_KEY" /* OCO_OPENAI_API_KEY */](value, config8 = {}) {
-    validateConfig("API_KEY", value || config8.OCO_AI_PROVIDER == "ollama", "You need to provide an API key");
+    validateConfig(
+      "API_KEY",
+      value || config8.OCO_AI_PROVIDER == "ollama",
+      "You need to provide an API key"
+    );
     validateConfig(
       "OCO_OPENAI_API_KEY" /* OCO_OPENAI_API_KEY */,
       value.startsWith("sk-"),
@@ -18682,17 +18685,33 @@ var configValidators = {
     );
     return value;
   },
-  ["OCO_OPENAI_MAX_TOKENS" /* OCO_OPENAI_MAX_TOKENS */](value) {
+  ["OCO_TOKENS_MAX_INPUT" /* OCO_TOKENS_MAX_INPUT */](value) {
     if (typeof value === "string") {
       value = parseInt(value);
       validateConfig(
-        "OCO_OPENAI_MAX_TOKENS" /* OCO_OPENAI_MAX_TOKENS */,
+        "OCO_TOKENS_MAX_INPUT" /* OCO_TOKENS_MAX_INPUT */,
         !isNaN(value),
         "Must be a number"
       );
     }
     validateConfig(
-      "OCO_OPENAI_MAX_TOKENS" /* OCO_OPENAI_MAX_TOKENS */,
+      "OCO_TOKENS_MAX_INPUT" /* OCO_TOKENS_MAX_INPUT */,
+      value ? typeof value === "number" : void 0,
+      "Must be a number"
+    );
+    return value;
+  },
+  ["OCO_TOKENS_MAX_OUTPUT" /* OCO_TOKENS_MAX_OUTPUT */](value) {
+    if (typeof value === "string") {
+      value = parseInt(value);
+      validateConfig(
+        "OCO_TOKENS_MAX_OUTPUT" /* OCO_TOKENS_MAX_OUTPUT */,
+        !isNaN(value),
+        "Must be a number"
+      );
+    }
+    validateConfig(
+      "OCO_TOKENS_MAX_OUTPUT" /* OCO_TOKENS_MAX_OUTPUT */,
       value ? typeof value === "number" : void 0,
       "Must be a number"
     );
@@ -18727,12 +18746,13 @@ var configValidators = {
       "OCO_MODEL" /* OCO_MODEL */,
       [
         "gpt-3.5-turbo",
+        "gpt-3.5-turbo-0125",
         "gpt-4",
-        "gpt-3.5-turbo-16k",
-        "gpt-3.5-turbo-0613",
-        "gpt-4-1106-preview"
+        "gpt-4-1106-preview",
+        "gpt-4-turbo-preview",
+        "gpt-4-0125-preview"
       ].includes(value),
-      `${value} is not supported yet, use 'gpt-4', 'gpt-3.5-turbo-16k' (default), 'gpt-3.5-turbo-0613', 'gpt-3.5-turbo' or 'gpt-4-1106-preview'`
+      `${value} is not supported yet, use 'gpt-4', 'gpt-3.5-turbo' (default), 'gpt-3.5-turbo-0125', 'gpt-4-1106-preview', 'gpt-4-turbo-preview' or 'gpt-4-0125-preview'`
     );
     return value;
   },
@@ -18763,21 +18783,31 @@ var configValidators = {
       `${value} is not supported yet, use 'ollama' or 'openai' (default)`
     );
     return value;
+  },
+  ["OCO_ONE_LINE_COMMIT" /* OCO_ONE_LINE_COMMIT */](value) {
+    validateConfig(
+      "OCO_ONE_LINE_COMMIT" /* OCO_ONE_LINE_COMMIT */,
+      typeof value === "boolean",
+      "Must be true or false"
+    );
+    return value;
   }
 };
 var configPath = (0, import_path.join)((0, import_os.homedir)(), ".opencommit");
 var getConfig = () => {
   const configFromEnv = {
     OCO_OPENAI_API_KEY: process.env.OCO_OPENAI_API_KEY,
-    OCO_OPENAI_MAX_TOKENS: process.env.OCO_OPENAI_MAX_TOKENS ? Number(process.env.OCO_OPENAI_MAX_TOKENS) : void 0,
+    OCO_TOKENS_MAX_INPUT: process.env.OCO_TOKENS_MAX_INPUT ? Number(process.env.OCO_TOKENS_MAX_INPUT) : void 0,
+    OCO_TOKENS_MAX_OUTPUT: process.env.OCO_TOKENS_MAX_OUTPUT ? Number(process.env.OCO_TOKENS_MAX_OUTPUT) : void 0,
     OCO_OPENAI_BASE_PATH: process.env.OCO_OPENAI_BASE_PATH,
     OCO_DESCRIPTION: process.env.OCO_DESCRIPTION === "true" ? true : false,
     OCO_EMOJI: process.env.OCO_EMOJI === "true" ? true : false,
-    OCO_MODEL: process.env.OCO_MODEL || "gpt-3.5-turbo-16k",
+    OCO_MODEL: process.env.OCO_MODEL || "gpt-3.5-turbo",
     OCO_LANGUAGE: process.env.OCO_LANGUAGE || "en",
     OCO_MESSAGE_TEMPLATE_PLACEHOLDER: process.env.OCO_MESSAGE_TEMPLATE_PLACEHOLDER || "$msg",
     OCO_PROMPT_MODULE: process.env.OCO_PROMPT_MODULE || "conventional-commit",
-    OCO_AI_PROVIDER: process.env.OCO_AI_PROVIDER || "openai"
+    OCO_AI_PROVIDER: process.env.OCO_AI_PROVIDER || "openai",
+    OCO_ONE_LINE_COMMIT: process.env.OCO_ONE_LINE_COMMIT === "true" ? true : false
   };
   const configExists = (0, import_fs.existsSync)(configPath);
   if (!configExists)
@@ -18997,6 +19027,7 @@ var INIT_MAIN_PROMPT = (language, prompts) => ({
 ${config2?.OCO_EMOJI ? "Use GitMoji convention to preface the commit." : "Do not preface the commit with anything."}
 ${config2?.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. Use ${language} to answer.
+${config2?.OCO_ONE_LINE_COMMIT ? "Craft a concise commit message that encapsulates all changes made, with an emphasis on the primary updates. If the modifications share a common theme or scope, mention it succinctly; otherwise, leave the scope out to maintain focus. The goal is to provide a clear and unified overview of the changes in a one single message, without diverging into a list of commit per file change." : ""}
     
 You will strictly follow the following conventions to generate the content of the commit message:
 - ${prompts.join("\n- ")}
@@ -19037,6 +19068,15 @@ var removeDoubleNewlines = (input) => {
   }
   return input;
 };
+var getJSONBlock = (input) => {
+  const jsonIndex = input.search("```json");
+  if (jsonIndex > -1) {
+    input = input.slice(jsonIndex + 8);
+    const endJsonIndex = consistency.search("```");
+    input = input.slice(0, endJsonIndex);
+  }
+  return input;
+};
 var commitlintLLMConfigExists = async () => {
   let exists;
   try {
@@ -21900,7 +21940,8 @@ function tokenCount(content) {
 
 // src/engine/openAi.ts
 var config3 = getConfig();
-var maxTokens = config3?.OCO_OPENAI_MAX_TOKENS;
+var MAX_TOKENS_OUTPUT = config3?.OCO_TOKENS_MAX_OUTPUT || 500 /* DEFAULT_MAX_TOKENS_OUTPUT */;
+var MAX_TOKENS_INPUT = config3?.OCO_TOKENS_MAX_INPUT || 4096 /* DEFAULT_MAX_TOKENS_INPUT */;
 var basePath = config3?.OCO_OPENAI_BASE_PATH;
 var apiKey = config3?.OCO_OPENAI_API_KEY;
 var [command, mode] = process.argv.slice(2);
@@ -21933,11 +21974,11 @@ var OpenAi = class {
       messages,
       temperature: 0,
       top_p: 0.1,
-      max_tokens: maxTokens || 500
+      max_tokens: MAX_TOKENS_OUTPUT
     };
     try {
       const REQUEST_TOKENS = messages.map((msg) => tokenCount(msg.content) + 4).reduce((a2, b6) => a2 + b6, 0);
-      if (REQUEST_TOKENS > DEFAULT_MODEL_TOKEN_LIMIT - maxTokens) {
+      if (REQUEST_TOKENS > MAX_TOKENS_INPUT - MAX_TOKENS_OUTPUT) {
         throw new Error("TOO_MUCH_TOKENS" /* tooMuchTokens */);
       }
       const { data } = await this.openAI.createChatCompletion(params);
@@ -21965,12 +22006,11 @@ var api = new OpenAi();
 var OllamaAi = class {
   async generateCommitMessage(messages) {
     const model = "mistral";
-    let prompt = messages.map((x4) => x4.content).join("\n");
-    prompt += "Summarize above git diff in 10 words or less";
-    const url3 = "http://localhost:11434/api/generate";
+    const url3 = "http://localhost:11434/api/chat";
     const p4 = {
       model,
-      prompt,
+      messages,
+      options: { temperature: 0, top_p: 0.1 },
       stream: false
     };
     try {
@@ -21979,8 +22019,8 @@ var OllamaAi = class {
           "Content-Type": "application/json"
         }
       });
-      const answer = response.data?.response;
-      return answer;
+      const message = response.data.message;
+      return message?.content;
     } catch (err) {
       const message = err.response?.data?.error ?? err.message;
       throw new Error("local model issues. details: " + message);
@@ -22021,15 +22061,16 @@ var configureCommitlintIntegration = async (force = false) => {
   const prompts = inferPromptsFromCommitlintConfig(commitLintConfig);
   const consistencyPrompts = commitlintPrompts.GEN_COMMITLINT_CONSISTENCY_PROMPT(prompts);
   const engine = getEngine();
-  let consistency = await engine.generateCommitMessage(consistencyPrompts) || "{}";
-  prompts.forEach((prompt) => consistency = consistency.replace(prompt, ""));
-  consistency = removeDoubleNewlines(consistency);
+  let consistency2 = await engine.generateCommitMessage(consistencyPrompts) || "{}";
+  prompts.forEach((prompt) => consistency2 = consistency2.replace(prompt, ""));
+  consistency2 = getJSONBlock(consistency2);
+  consistency2 = removeDoubleNewlines(consistency2);
   const commitlintLLMConfig = {
     hash,
     prompts,
     consistency: {
       [translation2.localLanguage]: {
-        ...JSON.parse(consistency)
+        ...JSON.parse(consistency2)
       }
     }
   };
@@ -22037,15 +22078,21 @@ var configureCommitlintIntegration = async (force = false) => {
   spin.stop(`Done - please review contents of ${COMMITLINT_LLM_CONFIG_PATH}`);
 };
 
+// src/utils/removeConventionalCommitWord.ts
+function removeConventionalCommitWord(message) {
+  return message.replace(/^(fix|feat)\((.+?)\):/, "($2):");
+}
+
 // src/prompts.ts
 var config5 = getConfig();
 var translation3 = i18n[config5?.OCO_LANGUAGE || "en"];
 var IDENTITY = "You are to act as the author of a commit message in git.";
-var INIT_MAIN_PROMPT2 = (language) => ({
+var INIT_MAIN_PROMPT2 = (language, fullGitMojiSpec) => ({
   role: import_openai3.ChatCompletionRequestMessageRoleEnum.System,
-  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages as per the conventional commit convention and explain WHAT were the changes and mainly WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you are to convert it into a commit message.
-    ${config5?.OCO_EMOJI ? "Use GitMoji convention to preface the commit." : "Do not preface the commit with anything."}
+  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages as per the ${fullGitMojiSpec ? "GitMoji specification" : "conventional commit convention"} and explain WHAT were the changes and mainly WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you are to convert it into a commit message.
+  ${config5?.OCO_EMOJI ? `Use GitMoji convention to preface the commit. Here are some help to choose the right emoji (emoji, description): \u{1F41B}, Fix a bug; \u2728, Introduce new features; \u{1F4DD}, Add or update documentation; \u{1F680}, Deploy stuff; \u2705, Add, update, or pass tests; \u267B\uFE0F, Refactor code; \u2B06\uFE0F, Upgrade dependencies; \u{1F527}, Add or update configuration files; \u{1F310}, Internationalization and localization; \u{1F4A1}, Add or update comments in source code; ${fullGitMojiSpec ? "\u{1F3A8}, Improve structure / format of the code; \u26A1\uFE0F, Improve performance; \u{1F525}, Remove code or files; \u{1F691}\uFE0F, Critical hotfix; \u{1F484}, Add or update the UI and style files; \u{1F389}, Begin a project; \u{1F512}\uFE0F, Fix security issues; \u{1F510}, Add or update secrets; \u{1F516}, Release / Version tags; \u{1F6A8}, Fix compiler / linter warnings; \u{1F6A7}, Work in progress; \u{1F49A}, Fix CI Build; \u2B07\uFE0F, Downgrade dependencies; \u{1F4CC}, Pin dependencies to specific versions; \u{1F477}, Add or update CI build system; \u{1F4C8}, Add or update analytics or track code; \u2795, Add a dependency; \u2796, Remove a dependency; \u{1F528}, Add or update development scripts; \u270F\uFE0F, Fix typos; \u{1F4A9}, Write bad code that needs to be improved; \u23EA\uFE0F, Revert changes; \u{1F500}, Merge branches; \u{1F4E6}\uFE0F, Add or update compiled files or packages; \u{1F47D}\uFE0F, Update code due to external API changes; \u{1F69A}, Move or rename resources (e.g.: files, paths, routes); \u{1F4C4}, Add or update license; \u{1F4A5}, Introduce breaking changes; \u{1F371}, Add or update assets; \u267F\uFE0F, Improve accessibility; \u{1F37B}, Write code drunkenly; \u{1F4AC}, Add or update text and literals; \u{1F5C3}\uFE0F, Perform database related changes; \u{1F50A}, Add or update logs; \u{1F507}, Remove logs; \u{1F465}, Add or update contributor(s); \u{1F6B8}, Improve user experience / usability; \u{1F3D7}\uFE0F, Make architectural changes; \u{1F4F1}, Work on responsive design; \u{1F921}, Mock things; \u{1F95A}, Add or update an easter egg; \u{1F648}, Add or update a .gitignore file; \u{1F4F8}, Add or update snapshots; \u2697\uFE0F, Perform experiments; \u{1F50D}\uFE0F, Improve SEO; \u{1F3F7}\uFE0F, Add or update types; \u{1F331}, Add or update seed files; \u{1F6A9}, Add, update, or remove feature flags; \u{1F945}, Catch errors; \u{1F4AB}, Add or update animations and transitions; \u{1F5D1}\uFE0F, Deprecate code that needs to be cleaned up; \u{1F6C2}, Work on code related to authorization, roles and permissions; \u{1FA79}, Simple fix for a non-critical issue; \u{1F9D0}, Data exploration/inspection; \u26B0\uFE0F, Remove dead code; \u{1F9EA}, Add a failing test; \u{1F454}, Add or update business logic; \u{1FA7A}, Add or update healthcheck; \u{1F9F1}, Infrastructure related changes; \u{1F9D1}\u200D\u{1F4BB}, Improve developer experience; \u{1F4B8}, Add sponsorships or money related infrastructure; \u{1F9F5}, Add or update code related to multithreading or concurrency; \u{1F9BA}, Add or update code related to validation." : ""}` : "Do not preface the commit with anything. Conventional commit keywords:fix, feat, build, chore, ci, docs, style, refactor, perf, test."}  
     ${config5?.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."}
+    ${config5?.OCO_ONE_LINE_COMMIT ? "Craft a concise commit message that encapsulates all changes made, with an emphasis on the primary updates. If the modifications share a common theme or scope, mention it succinctly; otherwise, leave the scope out to maintain focus. The goal is to provide a clear and unified overview of the changes in a one single message, without diverging into a list of commit per file change." : ""}
     Use the present tense. Lines must not be longer than 74 characters. Use ${language} for the commit message.`
 });
 var INIT_DIFF_PROMPT = {
@@ -22077,11 +22124,11 @@ var INIT_DIFF_PROMPT = {
 };
 var INIT_CONSISTENCY_PROMPT = (translation4) => ({
   role: import_openai3.ChatCompletionRequestMessageRoleEnum.Assistant,
-  content: `${config5?.OCO_EMOJI ? "\u{1F41B} " : ""}${translation4.commitFix}
-${config5?.OCO_EMOJI ? "\u2728 " : ""}${translation4.commitFeat}
+  content: `${config5?.OCO_EMOJI ? `\u{1F41B} ${removeConventionalCommitWord(translation4.commitFix)}` : translation4.commitFix}
+${config5?.OCO_EMOJI ? `\u2728 ${removeConventionalCommitWord(translation4.commitFeat)}` : translation4.commitFeat}
 ${config5?.OCO_DESCRIPTION ? translation4.commitDescription : ""}`
 });
-var getMainCommitPrompt = async () => {
+var getMainCommitPrompt = async (fullGitMojiSpec) => {
   switch (config5?.OCO_PROMPT_MODULE) {
     case "@commitlint":
       if (!await commitlintLLMConfigExists()) {
@@ -22103,7 +22150,7 @@ var getMainCommitPrompt = async () => {
       ];
     default:
       return [
-        INIT_MAIN_PROMPT2(translation3.localLanguage),
+        INIT_MAIN_PROMPT2(translation3.localLanguage, fullGitMojiSpec),
         INIT_DIFF_PROMPT,
         INIT_CONSISTENCY_PROMPT(translation3)
       ];
@@ -22128,8 +22175,10 @@ function mergeDiffs(arr, maxStringLength) {
 
 // src/generateCommitMessageFromGitDiff.ts
 var config6 = getConfig();
-var generateCommitMessageChatCompletionPrompt = async (diff) => {
-  const INIT_MESSAGES_PROMPT = await getMainCommitPrompt();
+var MAX_TOKENS_INPUT2 = config6?.OCO_TOKENS_MAX_INPUT || 4096 /* DEFAULT_MAX_TOKENS_INPUT */;
+var MAX_TOKENS_OUTPUT2 = config6?.OCO_TOKENS_MAX_OUTPUT || 500 /* DEFAULT_MAX_TOKENS_OUTPUT */;
+var generateCommitMessageChatCompletionPrompt = async (diff, fullGitMojiSpec) => {
+  const INIT_MESSAGES_PROMPT = await getMainCommitPrompt(fullGitMojiSpec);
   const chatContextAsCompletionRequest = [...INIT_MESSAGES_PROMPT];
   chatContextAsCompletionRequest.push({
     role: import_openai4.ChatCompletionRequestMessageRoleEnum.User,
@@ -22137,18 +22186,26 @@ var generateCommitMessageChatCompletionPrompt = async (diff) => {
   });
   return chatContextAsCompletionRequest;
 };
+var GenerateCommitMessageErrorEnum = ((GenerateCommitMessageErrorEnum2) => {
+  GenerateCommitMessageErrorEnum2["tooMuchTokens"] = "TOO_MUCH_TOKENS";
+  GenerateCommitMessageErrorEnum2["internalError"] = "INTERNAL_ERROR";
+  GenerateCommitMessageErrorEnum2["emptyMessage"] = "EMPTY_MESSAGE";
+  GenerateCommitMessageErrorEnum2[GenerateCommitMessageErrorEnum2["outputTokensTooHigh"] = `Token limit exceeded, OCO_TOKENS_MAX_OUTPUT must not be much higher than the default ${500 /* DEFAULT_MAX_TOKENS_OUTPUT */} tokens.`] = "outputTokensTooHigh";
+  return GenerateCommitMessageErrorEnum2;
+})(GenerateCommitMessageErrorEnum || {});
 var ADJUSTMENT_FACTOR = 20;
-var generateCommitMessageByDiff = async (diff) => {
+var generateCommitMessageByDiff = async (diff, fullGitMojiSpec) => {
   try {
-    const INIT_MESSAGES_PROMPT = await getMainCommitPrompt();
+    const INIT_MESSAGES_PROMPT = await getMainCommitPrompt(fullGitMojiSpec);
     const INIT_MESSAGES_PROMPT_LENGTH = INIT_MESSAGES_PROMPT.map(
       (msg) => tokenCount(msg.content) + 4
     ).reduce((a2, b6) => a2 + b6, 0);
-    const MAX_REQUEST_TOKENS = DEFAULT_MODEL_TOKEN_LIMIT - ADJUSTMENT_FACTOR - INIT_MESSAGES_PROMPT_LENGTH - config6?.OCO_OPENAI_MAX_TOKENS;
+    const MAX_REQUEST_TOKENS = MAX_TOKENS_INPUT2 - ADJUSTMENT_FACTOR - INIT_MESSAGES_PROMPT_LENGTH - MAX_TOKENS_OUTPUT2;
     if (tokenCount(diff) >= MAX_REQUEST_TOKENS) {
       const commitMessagePromises = await getCommitMsgsPromisesFromFileDiffs(
         diff,
-        MAX_REQUEST_TOKENS
+        MAX_REQUEST_TOKENS,
+        fullGitMojiSpec
       );
       const commitMessages = [];
       for (const promise of commitMessagePromises) {
@@ -22157,7 +22214,7 @@ var generateCommitMessageByDiff = async (diff) => {
       }
       return commitMessages.join("\n\n");
     }
-    const messages = await generateCommitMessageChatCompletionPrompt(diff);
+    const messages = await generateCommitMessageChatCompletionPrompt(diff, fullGitMojiSpec);
     const engine = getEngine();
     const commitMessage = await engine.generateCommitMessage(messages);
     if (!commitMessage)
@@ -22167,7 +22224,7 @@ var generateCommitMessageByDiff = async (diff) => {
     throw error;
   }
 };
-function getMessagesPromisesByChangesInFile(fileDiff, separator, maxChangeLength) {
+function getMessagesPromisesByChangesInFile(fileDiff, separator, maxChangeLength, fullGitMojiSpec) {
   const hunkHeaderSeparator = "@@ ";
   const [fileHeader, ...fileDiffByLines] = fileDiff.split(hunkHeaderSeparator);
   const mergedChanges = mergeDiffs(
@@ -22188,7 +22245,8 @@ function getMessagesPromisesByChangesInFile(fileDiff, separator, maxChangeLength
   const commitMsgsFromFileLineDiffs = lineDiffsWithHeader.map(
     async (lineDiff) => {
       const messages = await generateCommitMessageChatCompletionPrompt(
-        separator + lineDiff
+        separator + lineDiff,
+        fullGitMojiSpec
       );
       return engine.generateCommitMessage(messages);
     }
@@ -22199,6 +22257,9 @@ function splitDiff(diff, maxChangeLength) {
   const lines = diff.split("\n");
   const splitDiffs = [];
   let currentDiff = "";
+  if (maxChangeLength <= 0) {
+    throw new Error(GenerateCommitMessageErrorEnum.outputTokensTooHigh);
+  }
   for (let line of lines) {
     while (tokenCount(line) > maxChangeLength) {
       const subLine = line.substring(0, maxChangeLength);
@@ -22217,7 +22278,7 @@ function splitDiff(diff, maxChangeLength) {
   }
   return splitDiffs;
 }
-var getCommitMsgsPromisesFromFileDiffs = async (diff, maxDiffLength) => {
+var getCommitMsgsPromisesFromFileDiffs = async (diff, maxDiffLength, fullGitMojiSpec) => {
   const separator = "diff --git ";
   const diffByFiles = diff.split(separator).slice(1);
   const mergedFilesDiffs = mergeDiffs(diffByFiles, maxDiffLength);
@@ -22227,12 +22288,14 @@ var getCommitMsgsPromisesFromFileDiffs = async (diff, maxDiffLength) => {
       const messagesPromises = getMessagesPromisesByChangesInFile(
         fileDiff,
         separator,
-        maxDiffLength
+        maxDiffLength,
+        fullGitMojiSpec
       );
       commitMessagePromises.push(...messagesPromises);
     } else {
       const messages = await generateCommitMessageChatCompletionPrompt(
-        separator + fileDiff
+        separator + fileDiff,
+        fullGitMojiSpec
       );
       const engine = getEngine();
       commitMessagePromises.push(engine.generateCommitMessage(messages));
@@ -22354,14 +22417,19 @@ var checkMessageTemplate = (extraArgs2) => {
   }
   return false;
 };
-var generateCommitMessageFromGitDiff = async (diff, extraArgs2) => {
+var generateCommitMessageFromGitDiff = async (diff, extraArgs2, fullGitMojiSpec) => {
   await assertGitRepo();
   const commitSpinner = le();
   commitSpinner.start("Generating the commit message");
   try {
-    let commitMessage = await generateCommitMessageByDiff(diff);
+    let commitMessage = await generateCommitMessageByDiff(
+      diff,
+      fullGitMojiSpec
+    );
     const messageTemplate = checkMessageTemplate(extraArgs2);
     if (config7?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER && typeof messageTemplate === "string") {
+      const messageTemplateIndex = extraArgs2.indexOf(messageTemplate);
+      extraArgs2.splice(messageTemplateIndex, 1);
       commitMessage = messageTemplate.replace(
         config7?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER,
         commitMessage
@@ -22441,7 +22509,7 @@ ${source_default.grey("\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2014\u2
     process.exit(1);
   }
 };
-async function commit(extraArgs2 = [], isStageAllFlag = false) {
+async function commit(extraArgs2 = [], isStageAllFlag = false, fullGitMojiSpec = false) {
   if (isStageAllFlag) {
     const changedFiles2 = await getChangedFiles();
     if (changedFiles2)
@@ -22470,7 +22538,7 @@ async function commit(extraArgs2 = [], isStageAllFlag = false) {
       message: "Do you want to stage all files and generate commit message?"
     });
     if (isStageAllAndCommitConfirmedByUser && !eD2(isStageAllAndCommitConfirmedByUser)) {
-      await commit(extraArgs2, true);
+      await commit(extraArgs2, true, fullGitMojiSpec);
       process.exit(1);
     }
     if (stagedFiles.length === 0 && changedFiles.length > 0) {
@@ -22485,7 +22553,7 @@ async function commit(extraArgs2 = [], isStageAllFlag = false) {
         process.exit(1);
       await gitAdd({ files });
     }
-    await commit(extraArgs2, false);
+    await commit(extraArgs2, false, fullGitMojiSpec);
     process.exit(1);
   }
   stagedFilesSpinner.stop(
@@ -22495,7 +22563,8 @@ ${stagedFiles.map((file) => `  ${file}`).join("\n")}`
   const [, generateCommitError] = await trytm(
     generateCommitMessageFromGitDiff(
       await getDiff({ files: stagedFiles }),
-      extraArgs2
+      extraArgs2,
+      fullGitMojiSpec
     )
   );
   if (generateCommitError) {
@@ -22607,7 +22676,7 @@ var hookCommand = G3(
         return ce(`${source_default.green("\u2714")} Hook is removed`);
       }
       throw new Error(
-        `Unsupported mode: ${mode2}. Supported modes are: 'set' or 'unset'`
+        `Unsupported mode: ${mode2}. Supported modes are: 'set' or 'unset', do: \`oco hook set\``
       );
     } catch (error) {
       ce(`${source_default.red("\u2716")} ${error}`);
@@ -22701,16 +22770,18 @@ Z2(
     version: package_default.version,
     name: "opencommit",
     commands: [configCommand, hookCommand, commitlintConfigCommand],
-    flags: {},
+    flags: {
+      fgm: Boolean
+    },
     ignoreArgv: (type) => type === "unknown-flag" || type === "argument",
     help: { description: package_default.description }
   },
-  async () => {
+  async ({ flags }) => {
     await checkIsLatestVersion();
     if (await isHookCalled()) {
       prepareCommitMessageHook();
     } else {
-      commit(extraArgs);
+      commit(extraArgs, false, flags.fgm);
     }
   },
   extraArgs

out/github-action.cjs

@@ -24145,7 +24145,6 @@ function getI18nLocal(value) {
 
 // src/commands/config.ts
 dotenv.config();
-var DEFAULT_MODEL_TOKEN_LIMIT = 4096;
 var validateConfig = (key, condition, validationMessage) => {
   if (!condition) {
     ce(
@@ -24156,7 +24155,11 @@ var validateConfig = (key, condition, validationMessage) => {
 };
 var configValidators = {
   ["OCO_OPENAI_API_KEY" /* OCO_OPENAI_API_KEY */](value, config7 = {}) {
-    validateConfig("API_KEY", value || config7.OCO_AI_PROVIDER == "ollama", "You need to provide an API key");
+    validateConfig(
+      "API_KEY",
+      value || config7.OCO_AI_PROVIDER == "ollama",
+      "You need to provide an API key"
+    );
     validateConfig(
       "OCO_OPENAI_API_KEY" /* OCO_OPENAI_API_KEY */,
       value.startsWith("sk-"),
@@ -24177,17 +24180,33 @@ var configValidators = {
     );
     return value;
   },
-  ["OCO_OPENAI_MAX_TOKENS" /* OCO_OPENAI_MAX_TOKENS */](value) {
+  ["OCO_TOKENS_MAX_INPUT" /* OCO_TOKENS_MAX_INPUT */](value) {
     if (typeof value === "string") {
       value = parseInt(value);
       validateConfig(
-        "OCO_OPENAI_MAX_TOKENS" /* OCO_OPENAI_MAX_TOKENS */,
+        "OCO_TOKENS_MAX_INPUT" /* OCO_TOKENS_MAX_INPUT */,
         !isNaN(value),
         "Must be a number"
       );
     }
     validateConfig(
-      "OCO_OPENAI_MAX_TOKENS" /* OCO_OPENAI_MAX_TOKENS */,
+      "OCO_TOKENS_MAX_INPUT" /* OCO_TOKENS_MAX_INPUT */,
+      value ? typeof value === "number" : void 0,
+      "Must be a number"
+    );
+    return value;
+  },
+  ["OCO_TOKENS_MAX_OUTPUT" /* OCO_TOKENS_MAX_OUTPUT */](value) {
+    if (typeof value === "string") {
+      value = parseInt(value);
+      validateConfig(
+        "OCO_TOKENS_MAX_OUTPUT" /* OCO_TOKENS_MAX_OUTPUT */,
+        !isNaN(value),
+        "Must be a number"
+      );
+    }
+    validateConfig(
+      "OCO_TOKENS_MAX_OUTPUT" /* OCO_TOKENS_MAX_OUTPUT */,
       value ? typeof value === "number" : void 0,
       "Must be a number"
     );
@@ -24222,12 +24241,13 @@ var configValidators = {
       "OCO_MODEL" /* OCO_MODEL */,
       [
         "gpt-3.5-turbo",
+        "gpt-3.5-turbo-0125",
         "gpt-4",
-        "gpt-3.5-turbo-16k",
-        "gpt-3.5-turbo-0613",
-        "gpt-4-1106-preview"
+        "gpt-4-1106-preview",
+        "gpt-4-turbo-preview",
+        "gpt-4-0125-preview"
       ].includes(value),
-      `${value} is not supported yet, use 'gpt-4', 'gpt-3.5-turbo-16k' (default), 'gpt-3.5-turbo-0613', 'gpt-3.5-turbo' or 'gpt-4-1106-preview'`
+      `${value} is not supported yet, use 'gpt-4', 'gpt-3.5-turbo' (default), 'gpt-3.5-turbo-0125', 'gpt-4-1106-preview', 'gpt-4-turbo-preview' or 'gpt-4-0125-preview'`
     );
     return value;
   },
@@ -24258,21 +24278,31 @@ var configValidators = {
       `${value} is not supported yet, use 'ollama' or 'openai' (default)`
     );
     return value;
+  },
+  ["OCO_ONE_LINE_COMMIT" /* OCO_ONE_LINE_COMMIT */](value) {
+    validateConfig(
+      "OCO_ONE_LINE_COMMIT" /* OCO_ONE_LINE_COMMIT */,
+      typeof value === "boolean",
+      "Must be true or false"
+    );
+    return value;
   }
 };
 var configPath = (0, import_path.join)((0, import_os.homedir)(), ".opencommit");
 var getConfig = () => {
   const configFromEnv = {
     OCO_OPENAI_API_KEY: process.env.OCO_OPENAI_API_KEY,
-    OCO_OPENAI_MAX_TOKENS: process.env.OCO_OPENAI_MAX_TOKENS ? Number(process.env.OCO_OPENAI_MAX_TOKENS) : void 0,
+    OCO_TOKENS_MAX_INPUT: process.env.OCO_TOKENS_MAX_INPUT ? Number(process.env.OCO_TOKENS_MAX_INPUT) : void 0,
+    OCO_TOKENS_MAX_OUTPUT: process.env.OCO_TOKENS_MAX_OUTPUT ? Number(process.env.OCO_TOKENS_MAX_OUTPUT) : void 0,
     OCO_OPENAI_BASE_PATH: process.env.OCO_OPENAI_BASE_PATH,
     OCO_DESCRIPTION: process.env.OCO_DESCRIPTION === "true" ? true : false,
     OCO_EMOJI: process.env.OCO_EMOJI === "true" ? true : false,
-    OCO_MODEL: process.env.OCO_MODEL || "gpt-3.5-turbo-16k",
+    OCO_MODEL: process.env.OCO_MODEL || "gpt-3.5-turbo",
     OCO_LANGUAGE: process.env.OCO_LANGUAGE || "en",
     OCO_MESSAGE_TEMPLATE_PLACEHOLDER: process.env.OCO_MESSAGE_TEMPLATE_PLACEHOLDER || "$msg",
     OCO_PROMPT_MODULE: process.env.OCO_PROMPT_MODULE || "conventional-commit",
-    OCO_AI_PROVIDER: process.env.OCO_AI_PROVIDER || "openai"
+    OCO_AI_PROVIDER: process.env.OCO_AI_PROVIDER || "openai",
+    OCO_ONE_LINE_COMMIT: process.env.OCO_ONE_LINE_COMMIT === "true" ? true : false
   };
   const configExists = (0, import_fs.existsSync)(configPath);
   if (!configExists)
@@ -24492,6 +24522,7 @@ var INIT_MAIN_PROMPT = (language, prompts) => ({
 ${config2?.OCO_EMOJI ? "Use GitMoji convention to preface the commit." : "Do not preface the commit with anything."}
 ${config2?.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. Use ${language} to answer.
+${config2?.OCO_ONE_LINE_COMMIT ? "Craft a concise commit message that encapsulates all changes made, with an emphasis on the primary updates. If the modifications share a common theme or scope, mention it succinctly; otherwise, leave the scope out to maintain focus. The goal is to provide a clear and unified overview of the changes in a one single message, without diverging into a list of commit per file change." : ""}
     
 You will strictly follow the following conventions to generate the content of the commit message:
 - ${prompts.join("\n- ")}
@@ -24532,6 +24563,15 @@ var removeDoubleNewlines = (input) => {
   }
   return input;
 };
+var getJSONBlock = (input) => {
+  const jsonIndex = input.search("```json");
+  if (jsonIndex > -1) {
+    input = input.slice(jsonIndex + 8);
+    const endJsonIndex = consistency.search("```");
+    input = input.slice(0, endJsonIndex);
+  }
+  return input;
+};
 var commitlintLLMConfigExists = async () => {
   let exists;
   try {
@@ -27395,7 +27435,8 @@ function tokenCount(content) {
 
 // src/engine/openAi.ts
 var config3 = getConfig();
-var maxTokens = config3?.OCO_OPENAI_MAX_TOKENS;
+var MAX_TOKENS_OUTPUT = config3?.OCO_TOKENS_MAX_OUTPUT || 500 /* DEFAULT_MAX_TOKENS_OUTPUT */;
+var MAX_TOKENS_INPUT = config3?.OCO_TOKENS_MAX_INPUT || 4096 /* DEFAULT_MAX_TOKENS_INPUT */;
 var basePath = config3?.OCO_OPENAI_BASE_PATH;
 var apiKey = config3?.OCO_OPENAI_API_KEY;
 var [command, mode] = process.argv.slice(2);
@@ -27428,11 +27469,11 @@ var OpenAi = class {
       messages,
       temperature: 0,
       top_p: 0.1,
-      max_tokens: maxTokens || 500
+      max_tokens: MAX_TOKENS_OUTPUT
     };
     try {
       const REQUEST_TOKENS = messages.map((msg) => tokenCount(msg.content) + 4).reduce((a2, b2) => a2 + b2, 0);
-      if (REQUEST_TOKENS > DEFAULT_MODEL_TOKEN_LIMIT - maxTokens) {
+      if (REQUEST_TOKENS > MAX_TOKENS_INPUT - MAX_TOKENS_OUTPUT) {
         throw new Error("TOO_MUCH_TOKENS" /* tooMuchTokens */);
       }
       const { data } = await this.openAI.createChatCompletion(params);
@@ -27460,12 +27501,11 @@ var api = new OpenAi();
 var OllamaAi = class {
   async generateCommitMessage(messages) {
     const model = "mistral";
-    let prompt = messages.map((x2) => x2.content).join("\n");
-    prompt += "Summarize above git diff in 10 words or less";
-    const url2 = "http://localhost:11434/api/generate";
+    const url2 = "http://localhost:11434/api/chat";
     const p2 = {
       model,
-      prompt,
+      messages,
+      options: { temperature: 0, top_p: 0.1 },
       stream: false
     };
     try {
@@ -27474,8 +27514,8 @@ var OllamaAi = class {
           "Content-Type": "application/json"
         }
       });
-      const answer = response.data?.response;
-      return answer;
+      const message = response.data.message;
+      return message?.content;
     } catch (err) {
       const message = err.response?.data?.error ?? err.message;
       throw new Error("local model issues. details: " + message);
@@ -27516,15 +27556,16 @@ var configureCommitlintIntegration = async (force = false) => {
   const prompts = inferPromptsFromCommitlintConfig(commitLintConfig);
   const consistencyPrompts = commitlintPrompts.GEN_COMMITLINT_CONSISTENCY_PROMPT(prompts);
   const engine = getEngine();
-  let consistency = await engine.generateCommitMessage(consistencyPrompts) || "{}";
-  prompts.forEach((prompt) => consistency = consistency.replace(prompt, ""));
-  consistency = removeDoubleNewlines(consistency);
+  let consistency2 = await engine.generateCommitMessage(consistencyPrompts) || "{}";
+  prompts.forEach((prompt) => consistency2 = consistency2.replace(prompt, ""));
+  consistency2 = getJSONBlock(consistency2);
+  consistency2 = removeDoubleNewlines(consistency2);
   const commitlintLLMConfig = {
     hash,
     prompts,
     consistency: {
       [translation2.localLanguage]: {
-        ...JSON.parse(consistency)
+        ...JSON.parse(consistency2)
       }
     }
   };
@@ -27532,15 +27573,21 @@ var configureCommitlintIntegration = async (force = false) => {
   spin.stop(`Done - please review contents of ${COMMITLINT_LLM_CONFIG_PATH}`);
 };
 
+// src/utils/removeConventionalCommitWord.ts
+function removeConventionalCommitWord(message) {
+  return message.replace(/^(fix|feat)\((.+?)\):/, "($2):");
+}
+
 // src/prompts.ts
 var config5 = getConfig();
 var translation3 = i18n[config5?.OCO_LANGUAGE || "en"];
 var IDENTITY = "You are to act as the author of a commit message in git.";
-var INIT_MAIN_PROMPT2 = (language) => ({
+var INIT_MAIN_PROMPT2 = (language, fullGitMojiSpec) => ({
   role: import_openai3.ChatCompletionRequestMessageRoleEnum.System,
-  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages as per the conventional commit convention and explain WHAT were the changes and mainly WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you are to convert it into a commit message.
-    ${config5?.OCO_EMOJI ? "Use GitMoji convention to preface the commit." : "Do not preface the commit with anything."}
+  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages as per the ${fullGitMojiSpec ? "GitMoji specification" : "conventional commit convention"} and explain WHAT were the changes and mainly WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you are to convert it into a commit message.
+  ${config5?.OCO_EMOJI ? `Use GitMoji convention to preface the commit. Here are some help to choose the right emoji (emoji, description): \u{1F41B}, Fix a bug; \u2728, Introduce new features; \u{1F4DD}, Add or update documentation; \u{1F680}, Deploy stuff; \u2705, Add, update, or pass tests; \u267B\uFE0F, Refactor code; \u2B06\uFE0F, Upgrade dependencies; \u{1F527}, Add or update configuration files; \u{1F310}, Internationalization and localization; \u{1F4A1}, Add or update comments in source code; ${fullGitMojiSpec ? "\u{1F3A8}, Improve structure / format of the code; \u26A1\uFE0F, Improve performance; \u{1F525}, Remove code or files; \u{1F691}\uFE0F, Critical hotfix; \u{1F484}, Add or update the UI and style files; \u{1F389}, Begin a project; \u{1F512}\uFE0F, Fix security issues; \u{1F510}, Add or update secrets; \u{1F516}, Release / Version tags; \u{1F6A8}, Fix compiler / linter warnings; \u{1F6A7}, Work in progress; \u{1F49A}, Fix CI Build; \u2B07\uFE0F, Downgrade dependencies; \u{1F4CC}, Pin dependencies to specific versions; \u{1F477}, Add or update CI build system; \u{1F4C8}, Add or update analytics or track code; \u2795, Add a dependency; \u2796, Remove a dependency; \u{1F528}, Add or update development scripts; \u270F\uFE0F, Fix typos; \u{1F4A9}, Write bad code that needs to be improved; \u23EA\uFE0F, Revert changes; \u{1F500}, Merge branches; \u{1F4E6}\uFE0F, Add or update compiled files or packages; \u{1F47D}\uFE0F, Update code due to external API changes; \u{1F69A}, Move or rename resources (e.g.: files, paths, routes); \u{1F4C4}, Add or update license; \u{1F4A5}, Introduce breaking changes; \u{1F371}, Add or update assets; \u267F\uFE0F, Improve accessibility; \u{1F37B}, Write code drunkenly; \u{1F4AC}, Add or update text and literals; \u{1F5C3}\uFE0F, Perform database related changes; \u{1F50A}, Add or update logs; \u{1F507}, Remove logs; \u{1F465}, Add or update contributor(s); \u{1F6B8}, Improve user experience / usability; \u{1F3D7}\uFE0F, Make architectural changes; \u{1F4F1}, Work on responsive design; \u{1F921}, Mock things; \u{1F95A}, Add or update an easter egg; \u{1F648}, Add or update a .gitignore file; \u{1F4F8}, Add or update snapshots; \u2697\uFE0F, Perform experiments; \u{1F50D}\uFE0F, Improve SEO; \u{1F3F7}\uFE0F, Add or update types; \u{1F331}, Add or update seed files; \u{1F6A9}, Add, update, or remove feature flags; \u{1F945}, Catch errors; \u{1F4AB}, Add or update animations and transitions; \u{1F5D1}\uFE0F, Deprecate code that needs to be cleaned up; \u{1F6C2}, Work on code related to authorization, roles and permissions; \u{1FA79}, Simple fix for a non-critical issue; \u{1F9D0}, Data exploration/inspection; \u26B0\uFE0F, Remove dead code; \u{1F9EA}, Add a failing test; \u{1F454}, Add or update business logic; \u{1FA7A}, Add or update healthcheck; \u{1F9F1}, Infrastructure related changes; \u{1F9D1}\u200D\u{1F4BB}, Improve developer experience; \u{1F4B8}, Add sponsorships or money related infrastructure; \u{1F9F5}, Add or update code related to multithreading or concurrency; \u{1F9BA}, Add or update code related to validation." : ""}` : "Do not preface the commit with anything. Conventional commit keywords:fix, feat, build, chore, ci, docs, style, refactor, perf, test."}  
     ${config5?.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."}
+    ${config5?.OCO_ONE_LINE_COMMIT ? "Craft a concise commit message that encapsulates all changes made, with an emphasis on the primary updates. If the modifications share a common theme or scope, mention it succinctly; otherwise, leave the scope out to maintain focus. The goal is to provide a clear and unified overview of the changes in a one single message, without diverging into a list of commit per file change." : ""}
     Use the present tense. Lines must not be longer than 74 characters. Use ${language} for the commit message.`
 });
 var INIT_DIFF_PROMPT = {
@@ -27572,11 +27619,11 @@ var INIT_DIFF_PROMPT = {
 };
 var INIT_CONSISTENCY_PROMPT = (translation4) => ({
   role: import_openai3.ChatCompletionRequestMessageRoleEnum.Assistant,
-  content: `${config5?.OCO_EMOJI ? "\u{1F41B} " : ""}${translation4.commitFix}
-${config5?.OCO_EMOJI ? "\u2728 " : ""}${translation4.commitFeat}
+  content: `${config5?.OCO_EMOJI ? `\u{1F41B} ${removeConventionalCommitWord(translation4.commitFix)}` : translation4.commitFix}
+${config5?.OCO_EMOJI ? `\u2728 ${removeConventionalCommitWord(translation4.commitFeat)}` : translation4.commitFeat}
 ${config5?.OCO_DESCRIPTION ? translation4.commitDescription : ""}`
 });
-var getMainCommitPrompt = async () => {
+var getMainCommitPrompt = async (fullGitMojiSpec) => {
   switch (config5?.OCO_PROMPT_MODULE) {
     case "@commitlint":
       if (!await commitlintLLMConfigExists()) {
@@ -27598,7 +27645,7 @@ var getMainCommitPrompt = async () => {
       ];
     default:
       return [
-        INIT_MAIN_PROMPT2(translation3.localLanguage),
+        INIT_MAIN_PROMPT2(translation3.localLanguage, fullGitMojiSpec),
         INIT_DIFF_PROMPT,
         INIT_CONSISTENCY_PROMPT(translation3)
       ];
@@ -27623,8 +27670,10 @@ function mergeDiffs(arr, maxStringLength) {
 
 // src/generateCommitMessageFromGitDiff.ts
 var config6 = getConfig();
-var generateCommitMessageChatCompletionPrompt = async (diff) => {
-  const INIT_MESSAGES_PROMPT = await getMainCommitPrompt();
+var MAX_TOKENS_INPUT2 = config6?.OCO_TOKENS_MAX_INPUT || 4096 /* DEFAULT_MAX_TOKENS_INPUT */;
+var MAX_TOKENS_OUTPUT2 = config6?.OCO_TOKENS_MAX_OUTPUT || 500 /* DEFAULT_MAX_TOKENS_OUTPUT */;
+var generateCommitMessageChatCompletionPrompt = async (diff, fullGitMojiSpec) => {
+  const INIT_MESSAGES_PROMPT = await getMainCommitPrompt(fullGitMojiSpec);
   const chatContextAsCompletionRequest = [...INIT_MESSAGES_PROMPT];
   chatContextAsCompletionRequest.push({
     role: import_openai4.ChatCompletionRequestMessageRoleEnum.User,
@@ -27632,18 +27681,26 @@ var generateCommitMessageChatCompletionPrompt = async (diff) => {
   });
   return chatContextAsCompletionRequest;
 };
+var GenerateCommitMessageErrorEnum = ((GenerateCommitMessageErrorEnum2) => {
+  GenerateCommitMessageErrorEnum2["tooMuchTokens"] = "TOO_MUCH_TOKENS";
+  GenerateCommitMessageErrorEnum2["internalError"] = "INTERNAL_ERROR";
+  GenerateCommitMessageErrorEnum2["emptyMessage"] = "EMPTY_MESSAGE";
+  GenerateCommitMessageErrorEnum2[GenerateCommitMessageErrorEnum2["outputTokensTooHigh"] = `Token limit exceeded, OCO_TOKENS_MAX_OUTPUT must not be much higher than the default ${500 /* DEFAULT_MAX_TOKENS_OUTPUT */} tokens.`] = "outputTokensTooHigh";
+  return GenerateCommitMessageErrorEnum2;
+})(GenerateCommitMessageErrorEnum || {});
 var ADJUSTMENT_FACTOR = 20;
-var generateCommitMessageByDiff = async (diff) => {
+var generateCommitMessageByDiff = async (diff, fullGitMojiSpec) => {
   try {
-    const INIT_MESSAGES_PROMPT = await getMainCommitPrompt();
+    const INIT_MESSAGES_PROMPT = await getMainCommitPrompt(fullGitMojiSpec);
     const INIT_MESSAGES_PROMPT_LENGTH = INIT_MESSAGES_PROMPT.map(
       (msg) => tokenCount(msg.content) + 4
     ).reduce((a2, b2) => a2 + b2, 0);
-    const MAX_REQUEST_TOKENS = DEFAULT_MODEL_TOKEN_LIMIT - ADJUSTMENT_FACTOR - INIT_MESSAGES_PROMPT_LENGTH - config6?.OCO_OPENAI_MAX_TOKENS;
+    const MAX_REQUEST_TOKENS = MAX_TOKENS_INPUT2 - ADJUSTMENT_FACTOR - INIT_MESSAGES_PROMPT_LENGTH - MAX_TOKENS_OUTPUT2;
     if (tokenCount(diff) >= MAX_REQUEST_TOKENS) {
       const commitMessagePromises = await getCommitMsgsPromisesFromFileDiffs(
         diff,
-        MAX_REQUEST_TOKENS
+        MAX_REQUEST_TOKENS,
+        fullGitMojiSpec
       );
       const commitMessages = [];
       for (const promise of commitMessagePromises) {
@@ -27652,7 +27709,7 @@ var generateCommitMessageByDiff = async (diff) => {
       }
       return commitMessages.join("\n\n");
     }
-    const messages = await generateCommitMessageChatCompletionPrompt(diff);
+    const messages = await generateCommitMessageChatCompletionPrompt(diff, fullGitMojiSpec);
     const engine = getEngine();
     const commitMessage = await engine.generateCommitMessage(messages);
     if (!commitMessage)
@@ -27662,7 +27719,7 @@ var generateCommitMessageByDiff = async (diff) => {
     throw error;
   }
 };
-function getMessagesPromisesByChangesInFile(fileDiff, separator, maxChangeLength) {
+function getMessagesPromisesByChangesInFile(fileDiff, separator, maxChangeLength, fullGitMojiSpec) {
   const hunkHeaderSeparator = "@@ ";
   const [fileHeader, ...fileDiffByLines] = fileDiff.split(hunkHeaderSeparator);
   const mergedChanges = mergeDiffs(
@@ -27683,7 +27740,8 @@ function getMessagesPromisesByChangesInFile(fileDiff, separator, maxChangeLength
   const commitMsgsFromFileLineDiffs = lineDiffsWithHeader.map(
     async (lineDiff) => {
       const messages = await generateCommitMessageChatCompletionPrompt(
-        separator + lineDiff
+        separator + lineDiff,
+        fullGitMojiSpec
       );
       return engine.generateCommitMessage(messages);
     }
@@ -27694,6 +27752,9 @@ function splitDiff(diff, maxChangeLength) {
   const lines = diff.split("\n");
   const splitDiffs = [];
   let currentDiff = "";
+  if (maxChangeLength <= 0) {
+    throw new Error(GenerateCommitMessageErrorEnum.outputTokensTooHigh);
+  }
   for (let line of lines) {
     while (tokenCount(line) > maxChangeLength) {
       const subLine = line.substring(0, maxChangeLength);
@@ -27712,7 +27773,7 @@ function splitDiff(diff, maxChangeLength) {
   }
   return splitDiffs;
 }
-var getCommitMsgsPromisesFromFileDiffs = async (diff, maxDiffLength) => {
+var getCommitMsgsPromisesFromFileDiffs = async (diff, maxDiffLength, fullGitMojiSpec) => {
   const separator = "diff --git ";
   const diffByFiles = diff.split(separator).slice(1);
   const mergedFilesDiffs = mergeDiffs(diffByFiles, maxDiffLength);
@@ -27722,12 +27783,14 @@ var getCommitMsgsPromisesFromFileDiffs = async (diff, maxDiffLength) => {
       const messagesPromises = getMessagesPromisesByChangesInFile(
         fileDiff,
         separator,
-        maxDiffLength
+        maxDiffLength,
+        fullGitMojiSpec
       );
       commitMessagePromises.push(...messagesPromises);
     } else {
       const messages = await generateCommitMessageChatCompletionPrompt(
-        separator + fileDiff
+        separator + fileDiff,
+        fullGitMojiSpec
       );
       const engine = getEngine();
       commitMessagePromises.push(engine.generateCommitMessage(messages));

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "opencommit",
-  "version": "3.0.9",
+  "version": "3.0.12",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "opencommit",
-      "version": "3.0.9",
+      "version": "3.0.12",
       "license": "MIT",
       "dependencies": {
         "@actions/core": "^1.10.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencommit",
-  "version": "3.0.9",
+  "version": "3.0.12",
   "description": "Auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
   "keywords": [
     "git",

src/cli.ts

@@ -17,17 +17,19 @@ cli(
     version: packageJSON.version,
     name: 'opencommit',
     commands: [configCommand, hookCommand, commitlintConfigCommand],
-    flags: {},
+    flags: {
+      fgm: Boolean
+    },
     ignoreArgv: (type) => type === 'unknown-flag' || type === 'argument',
     help: { description: packageJSON.description }
   },
-  async () => {
+  async ({ flags }) => {
     await checkIsLatestVersion();
 
     if (await isHookCalled()) {
       prepareCommitMessageHook();
     } else {
-      commit(extraArgs);
+      commit(extraArgs, false, flags.fgm);
     }
   },
   extraArgs

src/commands/commit.ts

@@ -40,20 +40,27 @@ const checkMessageTemplate = (extraArgs: string[]): string | false => {
 
 const generateCommitMessageFromGitDiff = async (
   diff: string,
-  extraArgs: string[]
+  extraArgs: string[],
+  fullGitMojiSpec: boolean
 ): Promise<void> => {
   await assertGitRepo();
   const commitSpinner = spinner();
   commitSpinner.start('Generating the commit message');
 
   try {
-    let commitMessage = await generateCommitMessageByDiff(diff);
+    let commitMessage = await generateCommitMessageByDiff(
+      diff,
+      fullGitMojiSpec
+    );
 
     const messageTemplate = checkMessageTemplate(extraArgs);
     if (
       config?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER &&
       typeof messageTemplate === 'string'
     ) {
+      const messageTemplateIndex = extraArgs.indexOf(messageTemplate);
+      extraArgs.splice(messageTemplateIndex, 1);
+
       commitMessage = messageTemplate.replace(
         config?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER,
         commitMessage
@@ -154,7 +161,8 @@ ${chalk.grey('——————————————————')}`
 
 export async function commit(
   extraArgs: string[] = [],
-  isStageAllFlag: Boolean = false
+  isStageAllFlag: Boolean = false,
+  fullGitMojiSpec: boolean = false
 ) {
   if (isStageAllFlag) {
     const changedFiles = await getChangedFiles();
@@ -194,7 +202,7 @@ export async function commit(
       isStageAllAndCommitConfirmedByUser &&
       !isCancel(isStageAllAndCommitConfirmedByUser)
     ) {
-      await commit(extraArgs, true);
+      await commit(extraArgs, true, fullGitMojiSpec);
       process.exit(1);
     }
 
@@ -212,7 +220,7 @@ export async function commit(
       await gitAdd({ files });
     }
 
-    await commit(extraArgs, false);
+    await commit(extraArgs, false, fullGitMojiSpec);
     process.exit(1);
   }
 
@@ -225,7 +233,8 @@ export async function commit(
   const [, generateCommitError] = await trytm(
     generateCommitMessageFromGitDiff(
       await getDiff({ files: stagedFiles }),
-      extraArgs
+      extraArgs,
+      fullGitMojiSpec
     )
   );
 

src/commands/config.ts

@@ -15,7 +15,8 @@ dotenv.config();
 
 export enum CONFIG_KEYS {
   OCO_OPENAI_API_KEY = 'OCO_OPENAI_API_KEY',
-  OCO_OPENAI_MAX_TOKENS = 'OCO_OPENAI_MAX_TOKENS',
+  OCO_TOKENS_MAX_INPUT = 'OCO_TOKENS_MAX_INPUT',
+  OCO_TOKENS_MAX_OUTPUT = 'OCO_TOKENS_MAX_OUTPUT',
   OCO_OPENAI_BASE_PATH = 'OCO_OPENAI_BASE_PATH',
   OCO_DESCRIPTION = 'OCO_DESCRIPTION',
   OCO_EMOJI = 'OCO_EMOJI',
@@ -24,15 +25,19 @@ export enum CONFIG_KEYS {
   OCO_MESSAGE_TEMPLATE_PLACEHOLDER = 'OCO_MESSAGE_TEMPLATE_PLACEHOLDER',
   OCO_PROMPT_MODULE = 'OCO_PROMPT_MODULE',
   OCO_AI_PROVIDER = 'OCO_AI_PROVIDER',
+  OCO_ONE_LINE_COMMIT = 'OCO_ONE_LINE_COMMIT'
 }
 
-export const DEFAULT_MODEL_TOKEN_LIMIT = 4096;
-
 export enum CONFIG_MODES {
   get = 'get',
   set = 'set'
 }
 
+export enum DEFAULT_TOKEN_LIMITS {
+  DEFAULT_MAX_TOKENS_INPUT = 4096,
+  DEFAULT_MAX_TOKENS_OUTPUT = 500
+}
+
 const validateConfig = (
   key: string,
   condition: any,
@@ -50,7 +55,11 @@ const validateConfig = (
 export const configValidators = {
   [CONFIG_KEYS.OCO_OPENAI_API_KEY](value: any, config: any = {}) {
     //need api key unless running locally with ollama
-    validateConfig('API_KEY', value || config.OCO_AI_PROVIDER == 'ollama', 'You need to provide an API key');
+    validateConfig(
+      'API_KEY',
+      value || config.OCO_AI_PROVIDER == 'ollama',
+      'You need to provide an API key'
+    );
     validateConfig(
       CONFIG_KEYS.OCO_OPENAI_API_KEY,
       value.startsWith('sk-'),
@@ -75,18 +84,37 @@ export const configValidators = {
     return value;
   },
 
-  [CONFIG_KEYS.OCO_OPENAI_MAX_TOKENS](value: any) {
+  [CONFIG_KEYS.OCO_TOKENS_MAX_INPUT](value: any) {
     // If the value is a string, convert it to a number.
     if (typeof value === 'string') {
       value = parseInt(value);
       validateConfig(
-        CONFIG_KEYS.OCO_OPENAI_MAX_TOKENS,
+        CONFIG_KEYS.OCO_TOKENS_MAX_INPUT,
         !isNaN(value),
         'Must be a number'
       );
     }
     validateConfig(
-      CONFIG_KEYS.OCO_OPENAI_MAX_TOKENS,
+      CONFIG_KEYS.OCO_TOKENS_MAX_INPUT,
+      value ? typeof value === 'number' : undefined,
+      'Must be a number'
+    );
+
+    return value;
+  },
+
+  [CONFIG_KEYS.OCO_TOKENS_MAX_OUTPUT](value: any) {
+    // If the value is a string, convert it to a number.
+    if (typeof value === 'string') {
+      value = parseInt(value);
+      validateConfig(
+        CONFIG_KEYS.OCO_TOKENS_MAX_OUTPUT,
+        !isNaN(value),
+        'Must be a number'
+      );
+    }
+    validateConfig(
+      CONFIG_KEYS.OCO_TOKENS_MAX_OUTPUT,
       value ? typeof value === 'number' : undefined,
       'Must be a number'
     );
@@ -127,12 +155,13 @@ export const configValidators = {
       CONFIG_KEYS.OCO_MODEL,
       [
         'gpt-3.5-turbo',
+        'gpt-3.5-turbo-0125',
         'gpt-4',
-        'gpt-3.5-turbo-16k',
-        'gpt-3.5-turbo-0613',
-        'gpt-4-1106-preview'
+        'gpt-4-1106-preview',
+        'gpt-4-turbo-preview',
+        'gpt-4-0125-preview'
       ].includes(value),
-      `${value} is not supported yet, use 'gpt-4', 'gpt-3.5-turbo-16k' (default), 'gpt-3.5-turbo-0613', 'gpt-3.5-turbo' or 'gpt-4-1106-preview'`
+      `${value} is not supported yet, use 'gpt-4', 'gpt-3.5-turbo' (default), 'gpt-3.5-turbo-0125', 'gpt-4-1106-preview', 'gpt-4-turbo-preview' or 'gpt-4-0125-preview'`
     );
     return value;
   },
@@ -167,6 +196,16 @@ export const configValidators = {
     );
     return value;
   },
+
+  [CONFIG_KEYS.OCO_ONE_LINE_COMMIT](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_ONE_LINE_COMMIT,
+      typeof value === 'boolean',
+      'Must be true or false'
+    );
+
+    return value;
+  },
 };
 
 export type ConfigType = {
@@ -178,18 +217,22 @@ const configPath = pathJoin(homedir(), '.opencommit');
 export const getConfig = (): ConfigType | null => {
   const configFromEnv = {
     OCO_OPENAI_API_KEY: process.env.OCO_OPENAI_API_KEY,
-    OCO_OPENAI_MAX_TOKENS: process.env.OCO_OPENAI_MAX_TOKENS
-      ? Number(process.env.OCO_OPENAI_MAX_TOKENS)
+    OCO_TOKENS_MAX_INPUT: process.env.OCO_TOKENS_MAX_INPUT
+      ? Number(process.env.OCO_TOKENS_MAX_INPUT)
+      : undefined,
+    OCO_TOKENS_MAX_OUTPUT: process.env.OCO_TOKENS_MAX_OUTPUT
+      ? Number(process.env.OCO_TOKENS_MAX_OUTPUT)
       : undefined,
     OCO_OPENAI_BASE_PATH: process.env.OCO_OPENAI_BASE_PATH,
     OCO_DESCRIPTION: process.env.OCO_DESCRIPTION === 'true' ? true : false,
     OCO_EMOJI: process.env.OCO_EMOJI === 'true' ? true : false,
-    OCO_MODEL: process.env.OCO_MODEL || 'gpt-3.5-turbo-16k',
+    OCO_MODEL: process.env.OCO_MODEL || 'gpt-3.5-turbo',
     OCO_LANGUAGE: process.env.OCO_LANGUAGE || 'en',
     OCO_MESSAGE_TEMPLATE_PLACEHOLDER:
       process.env.OCO_MESSAGE_TEMPLATE_PLACEHOLDER || '$msg',
     OCO_PROMPT_MODULE: process.env.OCO_PROMPT_MODULE || 'conventional-commit',
-    OCO_AI_PROVIDER: process.env.OCO_AI_PROVIDER || 'openai'
+    OCO_AI_PROVIDER: process.env.OCO_AI_PROVIDER || 'openai',
+    OCO_ONE_LINE_COMMIT: process.env.OCO_ONE_LINE_COMMIT === 'true' ? true : false
   };
 
   const configExists = existsSync(configPath);

src/commands/githook.ts

@@ -94,7 +94,7 @@ export const hookCommand = command(
       }
 
       throw new Error(
-        `Unsupported mode: ${mode}. Supported modes are: 'set' or 'unset'`
+        `Unsupported mode: ${mode}. Supported modes are: 'set' or 'unset', do: \`oco hook set\``
       );
     } catch (error) {
       outro(`${chalk.red('✖')} ${error}`);

src/engine/ollama.ts

@@ -8,14 +8,14 @@ export class OllamaAi implements AiEngine {
   ): Promise<string | undefined> {
     const model = 'mistral'; // todo: allow other models
 
-    let prompt = messages.map((x) => x.content).join('\n');
-    //hoftix: local models are not so clever so im changing the prompt a bit...
-    prompt += 'Summarize above git diff in 10 words or less';
+    //console.log(messages);
+    //process.exit()
 
-    const url = 'http://localhost:11434/api/generate';
+    const url = 'http://localhost:11434/api/chat';
     const p = {
       model,
-      prompt,
+      messages,
+      options: {temperature: 0, top_p: 0.1},
       stream: false
     };
     try {
@@ -24,8 +24,10 @@ export class OllamaAi implements AiEngine {
           'Content-Type': 'application/json'
         }
       });
-      const answer = response.data?.response;
-      return answer;
+
+      const message = response.data.message;
+
+      return message?.content;
     } catch (err: any) {
       const message = err.response?.data?.error ?? err.message;
       throw new Error('local model issues. details: ' + message);

src/engine/openAi.ts

@@ -11,7 +11,7 @@ import { intro, outro } from '@clack/prompts';
 
 import {
   CONFIG_MODES,
-  DEFAULT_MODEL_TOKEN_LIMIT,
+  DEFAULT_TOKEN_LIMITS,
   getConfig
 } from '../commands/config';
 import { GenerateCommitMessageErrorEnum } from '../generateCommitMessageFromGitDiff';
@@ -20,7 +20,8 @@ import { AiEngine } from './Engine';
 
 const config = getConfig();
 
-let maxTokens = config?.OCO_OPENAI_MAX_TOKENS;
+const MAX_TOKENS_OUTPUT = config?.OCO_TOKENS_MAX_OUTPUT || DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_OUTPUT;
+const MAX_TOKENS_INPUT = config?.OCO_TOKENS_MAX_INPUT || DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_INPUT;
 let basePath = config?.OCO_OPENAI_BASE_PATH;
 let apiKey = config?.OCO_OPENAI_API_KEY
 
@@ -65,14 +66,14 @@ class OpenAi implements AiEngine {
       messages,
       temperature: 0,
       top_p: 0.1,
-      max_tokens: maxTokens || 500
+      max_tokens: MAX_TOKENS_OUTPUT
     };
     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) {
+      if (REQUEST_TOKENS > MAX_TOKENS_INPUT - MAX_TOKENS_OUTPUT) {
         throw new Error(GenerateCommitMessageErrorEnum.tooMuchTokens);
       }
 

src/generateCommitMessageFromGitDiff.ts

@@ -3,18 +3,21 @@ import {
   ChatCompletionRequestMessageRoleEnum
 } from 'openai';
 
-import { DEFAULT_MODEL_TOKEN_LIMIT, getConfig } from './commands/config';
+import { DEFAULT_TOKEN_LIMITS, getConfig } from './commands/config';
 import { getMainCommitPrompt } from './prompts';
 import { mergeDiffs } from './utils/mergeDiffs';
 import { tokenCount } from './utils/tokenCount';
 import { getEngine } from './utils/engine';
 
 const config = getConfig();
+const MAX_TOKENS_INPUT = config?.OCO_TOKENS_MAX_INPUT || DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_INPUT;
+const MAX_TOKENS_OUTPUT = config?.OCO_TOKENS_MAX_OUTPUT || DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_OUTPUT;
 
 const generateCommitMessageChatCompletionPrompt = async (
-  diff: string
+  diff: string,
+  fullGitMojiSpec: boolean
 ): Promise<Array<ChatCompletionRequestMessage>> => {
-  const INIT_MESSAGES_PROMPT = await getMainCommitPrompt();
+  const INIT_MESSAGES_PROMPT = await getMainCommitPrompt(fullGitMojiSpec);
 
   const chatContextAsCompletionRequest = [...INIT_MESSAGES_PROMPT];
 
@@ -29,31 +32,34 @@ const generateCommitMessageChatCompletionPrompt = async (
 export enum GenerateCommitMessageErrorEnum {
   tooMuchTokens = 'TOO_MUCH_TOKENS',
   internalError = 'INTERNAL_ERROR',
-  emptyMessage = 'EMPTY_MESSAGE'
+  emptyMessage = 'EMPTY_MESSAGE',
+  outputTokensTooHigh = `Token limit exceeded, OCO_TOKENS_MAX_OUTPUT must not be much higher than the default ${DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_OUTPUT} tokens.`
 }
 
 const ADJUSTMENT_FACTOR = 20;
 
 export const generateCommitMessageByDiff = async (
-  diff: string
+  diff: string,
+  fullGitMojiSpec: boolean
 ): Promise<string> => {
   try {
-    const INIT_MESSAGES_PROMPT = await getMainCommitPrompt();
+    const INIT_MESSAGES_PROMPT = await getMainCommitPrompt(fullGitMojiSpec);
 
     const INIT_MESSAGES_PROMPT_LENGTH = INIT_MESSAGES_PROMPT.map(
       (msg) => tokenCount(msg.content) + 4
     ).reduce((a, b) => a + b, 0);
 
     const MAX_REQUEST_TOKENS =
-      DEFAULT_MODEL_TOKEN_LIMIT -
+      MAX_TOKENS_INPUT -
       ADJUSTMENT_FACTOR -
       INIT_MESSAGES_PROMPT_LENGTH -
-      config?.OCO_OPENAI_MAX_TOKENS;
+      MAX_TOKENS_OUTPUT;
 
     if (tokenCount(diff) >= MAX_REQUEST_TOKENS) {
       const commitMessagePromises = await getCommitMsgsPromisesFromFileDiffs(
         diff,
-        MAX_REQUEST_TOKENS
+        MAX_REQUEST_TOKENS,
+        fullGitMojiSpec
       );
 
       const commitMessages = [];
@@ -65,7 +71,7 @@ export const generateCommitMessageByDiff = async (
       return commitMessages.join('\n\n');
     }
 
-    const messages = await generateCommitMessageChatCompletionPrompt(diff);
+    const messages = await generateCommitMessageChatCompletionPrompt(diff, fullGitMojiSpec);
 
     const engine = getEngine()
     const commitMessage = await engine.generateCommitMessage(messages);
@@ -82,7 +88,8 @@ export const generateCommitMessageByDiff = async (
 function getMessagesPromisesByChangesInFile(
   fileDiff: string,
   separator: string,
-  maxChangeLength: number
+  maxChangeLength: number,
+  fullGitMojiSpec: boolean
 ) {
   const hunkHeaderSeparator = '@@ ';
   const [fileHeader, ...fileDiffByLines] = fileDiff.split(hunkHeaderSeparator);
@@ -109,7 +116,8 @@ function getMessagesPromisesByChangesInFile(
   const commitMsgsFromFileLineDiffs = lineDiffsWithHeader.map(
     async (lineDiff) => {
       const messages = await generateCommitMessageChatCompletionPrompt(
-        separator + lineDiff
+        separator + lineDiff,
+        fullGitMojiSpec
       );
 
       return engine.generateCommitMessage(messages);
@@ -124,6 +132,10 @@ function splitDiff(diff: string, maxChangeLength: number) {
   const splitDiffs = [];
   let currentDiff = '';
 
+  if (maxChangeLength <= 0) {
+    throw new Error(GenerateCommitMessageErrorEnum.outputTokensTooHigh);
+  }
+
   for (let line of lines) {
     // If a single line exceeds maxChangeLength, split it into multiple lines
     while (tokenCount(line) > maxChangeLength) {
@@ -153,7 +165,8 @@ function splitDiff(diff: string, maxChangeLength: number) {
 
 export const getCommitMsgsPromisesFromFileDiffs = async (
   diff: string,
-  maxDiffLength: number
+  maxDiffLength: number,
+  fullGitMojiSpec: boolean
 ) => {
   const separator = 'diff --git ';
 
@@ -170,13 +183,15 @@ export const getCommitMsgsPromisesFromFileDiffs = async (
       const messagesPromises = getMessagesPromisesByChangesInFile(
         fileDiff,
         separator,
-        maxDiffLength
+        maxDiffLength,
+        fullGitMojiSpec
       );
 
       commitMessagePromises.push(...messagesPromises);
     } else {
       const messages = await generateCommitMessageChatCompletionPrompt(
-        separator + fileDiff
+        separator + fileDiff,
+        fullGitMojiSpec
       );
 
       const engine = getEngine()

src/modules/commitlint/config.ts

@@ -61,6 +61,10 @@ export const configureCommitlintIntegration = async (force = false) => {
 
   // Cleanup the consistency answer. Sometimes 'gpt-3.5-turbo' sends rule's back.
   prompts.forEach((prompt) => (consistency = consistency.replace(prompt, '')));
+
+  // sometimes consistency is preceded by explanatory text like "Here is your JSON:"
+  consistency = utils.getJSONBlock(consistency);
+  
   // ... remaining might be extra set of "\n"
   consistency = utils.removeDoubleNewlines(consistency);
 

src/modules/commitlint/prompts.ts

@@ -267,6 +267,7 @@ const INIT_MAIN_PROMPT = (
 ${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. Use ${language} to answer.
+${ config?.OCO_ONE_LINE_COMMIT ? 'Craft a concise commit message that encapsulates all changes made, with an emphasis on the primary updates. If the modifications share a common theme or scope, mention it succinctly; otherwise, leave the scope out to maintain focus. The goal is to provide a clear and unified overview of the changes in a one single message, without diverging into a list of commit per file change.' : ""}
     
 You will strictly follow the following conventions to generate the content of the commit message:
 - ${prompts.join('\n- ')}

src/modules/commitlint/utils.ts

@@ -16,6 +16,16 @@ export const removeDoubleNewlines = (input: string): string => {
   return input;
 };
 
+export const getJSONBlock = (input: string): string => {
+  const jsonIndex = input.search('```json');
+  if(jsonIndex > -1) {
+    input = input.slice(jsonIndex + 8);
+    const endJsonIndex = consistency.search('```');
+    input = input.slice(0, endJsonIndex); 
+  }
+  return input;
+};
+  
 export const commitlintLLMConfigExists = async (): Promise<boolean> => {
   let exists;
   try {
@@ -44,4 +54,4 @@ export const getCommitlintLLMConfig =
       content.toString()
     ) as CommitlintLLMConfig;
     return commitLintLLMConfig;
-  };
+};

src/prompts.ts

@@ -11,6 +11,7 @@ import { configureCommitlintIntegration } from './modules/commitlint/config';
 import { commitlintPrompts } from './modules/commitlint/prompts';
 import { ConsistencyPrompt } from './modules/commitlint/types';
 import * as utils from './modules/commitlint/utils';
+import { removeConventionalCommitWord } from './utils/removeConventionalCommitWord';
 
 const config = getConfig();
 const translation = i18n[(config?.OCO_LANGUAGE as I18nLocals) || 'en'];
@@ -18,19 +19,107 @@ const translation = i18n[(config?.OCO_LANGUAGE as I18nLocals) || 'en'];
 export const IDENTITY =
   'You are to act as the author of a commit message in git.';
 
-const INIT_MAIN_PROMPT = (language: string): ChatCompletionRequestMessage => ({
+const INIT_MAIN_PROMPT = (
+  language: string,
+  fullGitMojiSpec: boolean
+): ChatCompletionRequestMessage => ({
   role: ChatCompletionRequestMessageRoleEnum.System,
-  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages as per the conventional commit convention and explain WHAT were the changes and mainly WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you are to convert it into a commit message.
-    ${
-      config?.OCO_EMOJI
-        ? 'Use GitMoji convention to preface the commit.'
-        : 'Do not preface the commit with anything.'
-    }
+  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages as per the ${
+    fullGitMojiSpec ? 'GitMoji specification' : 'conventional commit convention'
+  } and explain WHAT were the changes and mainly WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you are to convert it into a commit message.
+  ${
+    config?.OCO_EMOJI
+      ? 'Use GitMoji convention to preface the commit. Here are some help to choose the right emoji (emoji, description): ' +
+        '🐛, Fix a bug; ' +
+        '✨, Introduce new features; ' +
+        '📝, Add or update documentation; ' +
+        '🚀, Deploy stuff; ' +
+        '✅, Add, update, or pass tests; ' +
+        '♻️, Refactor code; ' +
+        '⬆️, Upgrade dependencies; ' +
+        '🔧, Add or update configuration files; ' +
+        '🌐, Internationalization and localization; ' +
+        '💡, Add or update comments in source code; ' +
+        `${
+          fullGitMojiSpec
+            ? '🎨, Improve structure / format of the code; ' +
+              '⚡️, Improve performance; ' +
+              '🔥, Remove code or files; ' +
+              '🚑️, Critical hotfix; ' +
+              '💄, Add or update the UI and style files; ' +
+              '🎉, Begin a project; ' +
+              '🔒️, Fix security issues; ' +
+              '🔐, Add or update secrets; ' +
+              '🔖, Release / Version tags; ' +
+              '🚨, Fix compiler / linter warnings; ' +
+              '🚧, Work in progress; ' +
+              '💚, Fix CI Build; ' +
+              '⬇️, Downgrade dependencies; ' +
+              '📌, Pin dependencies to specific versions; ' +
+              '👷, Add or update CI build system; ' +
+              '📈, Add or update analytics or track code; ' +
+              '➕, Add a dependency; ' +
+              '➖, Remove a dependency; ' +
+              '🔨, Add or update development scripts; ' +
+              '✏️, Fix typos; ' +
+              '💩, Write bad code that needs to be improved; ' +
+              '⏪️, Revert changes; ' +
+              '🔀, Merge branches; ' +
+              '📦️, Add or update compiled files or packages; ' +
+              '👽️, Update code due to external API changes; ' +
+              '🚚, Move or rename resources (e.g.: files, paths, routes); ' +
+              '📄, Add or update license; ' +
+              '💥, Introduce breaking changes; ' +
+              '🍱, Add or update assets; ' +
+              '♿️, Improve accessibility; ' +
+              '🍻, Write code drunkenly; ' +
+              '💬, Add or update text and literals; ' +
+              '🗃️, Perform database related changes; ' +
+              '🔊, Add or update logs; ' +
+              '🔇, Remove logs; ' +
+              '👥, Add or update contributor(s); ' +
+              '🚸, Improve user experience / usability; ' +
+              '🏗️, Make architectural changes; ' +
+              '📱, Work on responsive design; ' +
+              '🤡, Mock things; ' +
+              '🥚, Add or update an easter egg; ' +
+              '🙈, Add or update a .gitignore file; ' +
+              '📸, Add or update snapshots; ' +
+              '⚗️, Perform experiments; ' +
+              '🔍️, Improve SEO; ' +
+              '🏷️, Add or update types; ' +
+              '🌱, Add or update seed files; ' +
+              '🚩, Add, update, or remove feature flags; ' +
+              '🥅, Catch errors; ' +
+              '💫, Add or update animations and transitions; ' +
+              '🗑️, Deprecate code that needs to be cleaned up; ' +
+              '🛂, Work on code related to authorization, roles and permissions; ' +
+              '🩹, Simple fix for a non-critical issue; ' +
+              '🧐, Data exploration/inspection; ' +
+              '⚰️, Remove dead code; ' +
+              '🧪, Add a failing test; ' +
+              '👔, Add or update business logic; ' +
+              '🩺, Add or update healthcheck; ' +
+              '🧱, Infrastructure related changes; ' +
+              '🧑‍💻, Improve developer experience; ' +
+              '💸, Add sponsorships or money related infrastructure; ' +
+              '🧵, Add or update code related to multithreading or concurrency; ' +
+              '🦺, Add or update code related to validation.'
+            : ''
+        }`
+      : 'Do not preface the commit with anything. Conventional commit keywords:' +
+        'fix, feat, build, chore, ci, docs, style, refactor, perf, test.'
+  }  
     ${
       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."
     }
+    ${
+      config?.OCO_ONE_LINE_COMMIT
+        ? 'Craft a concise commit message that encapsulates all changes made, with an emphasis on the primary updates. If the modifications share a common theme or scope, mention it succinctly; otherwise, leave the scope out to maintain focus. The goal is to provide a clear and unified overview of the changes in a one single message, without diverging into a list of commit per file change.'
+        : ""
+    }
     Use the present tense. Lines must not be longer than 74 characters. Use ${language} for the commit message.`
 });
 
@@ -66,14 +155,22 @@ const INIT_CONSISTENCY_PROMPT = (
   translation: ConsistencyPrompt
 ): ChatCompletionRequestMessage => ({
   role: ChatCompletionRequestMessageRoleEnum.Assistant,
-  content: `${config?.OCO_EMOJI ? '🐛 ' : ''}${translation.commitFix}
-${config?.OCO_EMOJI ? '✨ ' : ''}${translation.commitFeat}
+  content: `${
+    config?.OCO_EMOJI
+      ? `🐛 ${removeConventionalCommitWord(translation.commitFix)}`
+      : translation.commitFix
+  }
+${
+  config?.OCO_EMOJI
+    ? `✨ ${removeConventionalCommitWord(translation.commitFeat)}`
+    : translation.commitFeat
+}
 ${config?.OCO_DESCRIPTION ? translation.commitDescription : ''}`
 });
 
-export const getMainCommitPrompt = async (): Promise<
-  ChatCompletionRequestMessage[]
-> => {
+export const getMainCommitPrompt = async (
+  fullGitMojiSpec: boolean
+): Promise<ChatCompletionRequestMessage[]> => {
   switch (config?.OCO_PROMPT_MODULE) {
     case '@commitlint':
       if (!(await utils.commitlintLLMConfigExists())) {
@@ -102,7 +199,7 @@ export const getMainCommitPrompt = async (): Promise<
     default:
       // conventional-commit
       return [
-        INIT_MAIN_PROMPT(translation.localLanguage),
+        INIT_MAIN_PROMPT(translation.localLanguage, fullGitMojiSpec),
         INIT_DIFF_PROMPT,
         INIT_CONSISTENCY_PROMPT(translation)
       ];

src/utils/git.ts

@@ -75,8 +75,11 @@ export const getChangedFiles = async (): Promise<string[]> => {
 
 export const gitAdd = async ({ files }: { files: string[] }) => {
   const gitAddSpinner = spinner();
+
   gitAddSpinner.start('Adding files to commit');
+
   await execa('git', ['add', ...files]);
+
   gitAddSpinner.stop('Done');
 };
 

src/utils/removeConventionalCommitWord.ts

@@ -0,0 +1,3 @@
+export function removeConventionalCommitWord(message: string): string {
+  return message.replace(/^(fix|feat)\((.+?)\):/, '($2):');
+}