3.2.8

feat(cli.ts): enhance fgm flag to include description and default value for better usability

.github/CONTRIBUTING.md

@@ -18,7 +18,7 @@ To get started, follow these steps:
 1. Clone the project repository locally.
 2. Install dependencies with `npm install`.
 3. Run the project with `npm run dev`.
-4. See [issues](https://github.com/di-sukharev/open-commit/issues) or [TODO.md](../TODO.md) to help the project.
+4. See [issues](https://github.com/di-sukharev/opencommit/issues) or [TODO.md](TODO.md) to help the project.
 
 ## Commit message guidelines
 
@@ -30,7 +30,7 @@ If you encounter any issues while using the project, please report them on the G
 
 ## Contacts
 
-If you have any questions about contributing to the project, please contact by [creating an issue](https://github.com/di-sukharev/open-commit/issues) on the GitHub issue tracker.
+If you have any questions about contributing to the project, please contact by [creating an issue](https://github.com/di-sukharev/opencommit/issues) on the GitHub issue tracker.
 
 ## License
 

.github/workflows/codeql.yml

@@ -40,11 +40,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -58,7 +58,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -71,6 +71,6 @@ jobs:
     #     ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3
       with:
         category: "/language:${{matrix.language}}"

.github/workflows/dependency-review.yml

@@ -15,6 +15,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout Repository'
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v2
+        uses: actions/dependency-review-action@v3

.github/workflows/test.yml

@@ -1,6 +1,11 @@
 name: Testing
 
-on: [pull_request]
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+      - main
 
 jobs:
   unit-test:
@@ -9,11 +14,12 @@ jobs:
       matrix:
         node-version: [20.x]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
+        cache: 'npm'
     - name: Install dependencies
       run: npm install
     - name: Run Unit Tests
@@ -24,11 +30,12 @@ jobs:
       matrix:
         node-version: [20.x]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
+        cache: 'npm'
     - name: Install git
       run: |
         sudo apt-get update

.gitignore

@@ -10,4 +10,6 @@ uncaughtExceptions.log
 .vscode
 src/*.json
 .idea
-test.ts
+test.ts
+notes.md
+.nvmrc

README.md

@@ -2,7 +2,7 @@
   <div>
     <img src=".github/logo-grad.svg" alt="OpenCommit logo"/>
     <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>
+    <h4 align="center">Author <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 a second</h2>
 	<p>Killing lame commits with AI 🤯🔫</p>
@@ -16,7 +16,7 @@
     <img src=".github/opencommit-example.png" alt="OpenCommit example"/>
 </div>
 
-All the commits in this repo are authored by OpenCommit — look at [the commits](https://github.com/di-sukharev/opencommit/commit/eae7618d575ee8d2e9fff5de56da79d40c4bc5fc) to see how OpenCommit works. Emojis and long commit descriptions are configurable.
+All the commits in this repo are authored by OpenCommit — look at [the commits](https://github.com/di-sukharev/opencommit/commit/eae7618d575ee8d2e9fff5de56da79d40c4bc5fc) to see how OpenCommit works. Emojis and long commit descriptions are configurable, basically everything is.
 
 ## Setup OpenCommit as a CLI tool
 
@@ -28,36 +28,27 @@ You can use OpenCommit by simply running it via the CLI like this `oco`. 2 secon
    npm install -g opencommit
    ```
 
-   Alternatively run it via `npx opencommit` or `bunx opencommit`
-
-   MacOS may ask to run the command with `sudo` when installing a package globally.
-
-2. Get your API key from [OpenAI](https://platform.openai.com/account/api-keys). Make sure that you add your payment details, so the API works.
+2. Get your API key from [OpenAI](https://platform.openai.com/account/api-keys) or other supported LLM providers (we support them all). Make sure that you add your OpenAI payment details to your account, so the API works.
 
 3. Set the key to OpenCommit config:
 
    ```sh
-   oco config set OCO_OPENAI_API_KEY=<your_api_key>
+   oco config set OCO_API_KEY=<your_api_key>
    ```
 
    Your API key is stored locally in the `~/.opencommit` config file.
 
 ## Usage
 
-You can call OpenCommit directly to generate a commit message for your staged changes:
-
-```sh
-git add <files...>
-opencommit
-```
-
-You can also use the `oco` shortcut:
+You can call OpenCommit with `oco` command to generate a commit message for your staged changes:
 
 ```sh
 git add <files...>
 oco
 ```
 
+Running `git add` is optional, `oco` will do it for you.
+
 ### Running locally with Ollama
 
 You can also run it with local model through ollama:
@@ -68,20 +59,17 @@ You can also run it with local model through ollama:
 
 ```sh
 git add <files...>
-OCO_AI_PROVIDER='ollama' opencommit
+oco config set OCO_AI_PROVIDER='ollama' OCO_MODEL='llama3:8b'
 ```
 
-If you want to use a model other than mistral, you can do so by setting the `OCO_AI_PROVIDER` environment variable as follows:
+Default model is `mistral`.
+
+If you have ollama that is set up in docker/ on another machine with GPUs (not locally), you can change the default endpoint url.
+
+You can do so by setting the `OCO_API_URL` environment variable as follows:
 
 ```sh
-OCO_AI_PROVIDER='ollama/llama3:8b' opencommit
-```
-
-if you have ollama that is set up in docker/ on another machine with GPUs (not locally), you can change the default endpoint url.
-You can do so by setting the `OCO_OLLAMA_API_URL` environment variable as follows:
-
-```sh
-OCO_OLLAMA_API_URL='http://192.168.1.10:11434/api/chat' opencommit
+oco config set OCO_API_URL='http://192.168.1.10:11434/api/chat'
 ```
 
 where 192.168.1.10 is example of endpoint URL, where you have ollama set up.
@@ -95,6 +83,7 @@ There are multiple optional flags that can be used with the `oco` command:
 Link to the GitMoji specification: https://gitmoji.dev/
 
 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.
 
 ```
@@ -116,20 +105,24 @@ oco --yes
 Create a `.env` file and add OpenCommit config variables there like this:
 
 ```env
-OCO_OPENAI_API_KEY=<your OpenAI API token>
+...
+OCO_AI_PROVIDER=<openai (default), anthropic, azure, ollama, gemini, flowise, deepseek>
+OCO_API_KEY=<your OpenAI API token> // or other LLM provider API token
+OCO_API_URL=<may be used to set proxy path to OpenAI api>
+OCO_API_CUSTOM_HEADERS=<JSON string of custom HTTP headers to include in API requests>
 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-4o', 'gpt-4', 'gpt-4-turbo', 'gpt-3.5-turbo' (default), 'gpt-3.5-turbo-0125', 'gpt-4-1106-preview', 'gpt-4-turbo-preview' or 'gpt-4-0125-preview'>
+OCO_MODEL=<either 'gpt-4o-mini' (default), 'gpt-4o', 'gpt-4', 'gpt-4-turbo', 'gpt-3.5-turbo', 'gpt-3.5-turbo-0125', 'gpt-4-1106-preview', 'gpt-4-turbo-preview' or 'gpt-4-0125-preview' or any Anthropic or Ollama model or any string basically, but it should be a valid model name>
 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>
-OCO_AI_PROVIDER=<anthropic, azure, ollama or ollama/model default ollama model: mistral>
 ```
 
+Global configs are same as local configs, but they are stored in the global `~/.opencommit` config file and set with `oco config set` command, e.g. `oco config set OCO_MODEL=gpt-4o`.
+
 ### Global config for all repos
 
 Local config still has more priority than Global config, but you may set `OCO_MODEL` and `OCO_LOCALE` globally and set local configs for `OCO_EMOJI` and `OCO_DESCRIPTION` per repo which is more convenient.
@@ -137,7 +130,19 @@ Local config still has more priority than Global config, but you may set `OCO_MO
 Simply set any of the variables above like this:
 
 ```sh
-oco config set OCO_MODEL=gpt-4o
+oco config set OCO_MODEL=gpt-4o-mini
+```
+
+To see all available configuration parameters and their accepted values:
+
+```sh
+oco config describe
+```
+
+To see details for a specific parameter:
+
+```sh
+oco config describe OCO_MODEL
 ```
 
 Configure [GitMoji](https://gitmoji.dev/) to preface a message.
@@ -152,42 +157,54 @@ To remove preface emojis:
 oco config set OCO_EMOJI=false
 ```
 
-### Switch to GPT-4 or other models
+Other config options are behaving the same.
 
-By default, OpenCommit uses `gpt-4o` model.
+### Output WHY the changes were done (WIP)
 
-You may switch to GPT-4 which performs better, but costs ~x15 times more 🤠
+You can set the `OCO_WHY` config to `true` to have OpenCommit output a short description of WHY the changes were done after the commit message. Default is `false`.
+
+To make this perform accurate we must store 'what files do' in some kind of an index or embedding and perform a lookup (kinda RAG) for the accurate git commit message. If you feel like building this comment on this ticket https://github.com/di-sukharev/opencommit/issues/398 and let's go from there together.
 
 ```sh
-oco config set OCO_MODEL=gpt-4
+oco config set OCO_WHY=true
+```
+
+### Switch to GPT-4 or other models
+
+By default, OpenCommit uses `gpt-4o-mini` model.
+
+You may switch to gpt-4o which performs better, but costs more 🤠
+
+```sh
+oco config set OCO_MODEL=gpt-4o
 ```
 
 or for as a cheaper option:
 
 ```sh
-oco config set OCO_MODEL=gpt-4o-mini
+oco config set OCO_MODEL=gpt-3.5-turbo
 ```
 
-### Switch to Azure OpenAI
+### Switch to other LLM providers with a custom URL
 
 By default OpenCommit uses [OpenAI](https://openai.com).
 
-You could switch to [Azure OpenAI Service](https://learn.microsoft.com/azure/cognitive-services/openai/)🚀
+You could switch to [Azure OpenAI Service](https://learn.microsoft.com/azure/cognitive-services/openai/) or Flowise or Ollama.
 
 ```sh
-opencommit config set OCO_AI_PROVIDER=azure
-```
+oco config set OCO_AI_PROVIDER=azure OCO_API_KEY=<your_azure_api_key> OCO_API_URL=<your_azure_endpoint>
 
-Of course need to set 'OPENAI_API_KEY'. And also need to set the
-'OPENAI_BASE_PATH' for the endpoint and set the deployment name to
-'model'.
+oco config set OCO_AI_PROVIDER=flowise OCO_API_KEY=<your_flowise_api_key> OCO_API_URL=<your_flowise_endpoint>
+
+oco config set OCO_AI_PROVIDER=ollama OCO_API_KEY=<your_ollama_api_key> OCO_API_URL=<your_ollama_endpoint>
+```
 
 ### Locale configuration
 
 To globally specify the language used to generate commit messages:
 
 ```sh
-# de, German ,Deutsch
+# de, German, Deutsch
 oco config set OCO_LANGUAGE=de
 oco config set OCO_LANGUAGE=German
 oco config set OCO_LANGUAGE=Deutsch
@@ -201,14 +218,16 @@ oco config set OCO_LANGUAGE=française
 The default language setting is **English**
 All available languages are currently listed in the [i18n](https://github.com/di-sukharev/opencommit/tree/master/src/i18n) folder
 
-### Push to git
+### Push to git (gonna be deprecated)
 
-Pushing to git is on by default but if you would like to turn it off just use:
+A prompt for pushing to git is on by default but if you would like to turn it off just use:
 
 ```sh
 oco config set OCO_GITPUSH=false
 ```
 
+and it will exit right after commit is confirmed without asking if you would like to push to remote.
+
 ### Switch to `@commitlint`
 
 OpenCommit allows you to choose the prompt module used to generate commit messages. By default, OpenCommit uses its conventional-commit message generator. However, you can switch to using the `@commitlint` prompt module if you prefer. This option lets you generate commit messages in respect with the local config.
@@ -291,7 +310,7 @@ In our codebase, the implementation of this feature can be found in the followin
 
 ```javascript
 commitMessage = messageTemplate.replace(
-  config?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER,
+  config.OCO_MESSAGE_TEMPLATE_PLACEHOLDER,
   commitMessage
 );
 ```
@@ -348,7 +367,7 @@ Or follow the process of your IDE Source Control feature, when it calls `git com
 
 OpenCommit is now available as a GitHub Action which automatically improves all new commits messages when you push to remote!
 
-This is great if you want to make sure all of the commits in all of your repository branches are meaningful and not lame like `fix1` or `done2`.
+This is great if you want to make sure all commits in all of your repository branches are meaningful and not lame like `fix1` or `done2`.
 
 Create a file `.github/workflows/opencommit.yml` with the contents below:
 
@@ -383,7 +402,7 @@ jobs:
           # set openAI api key in repo actions secrets,
           # for openAI keys go to: https://platform.openai.com/account/api-keys
           # for repo secret go to: <your_repo_url>/settings/secrets/actions
-          OCO_OPENAI_API_KEY: ${{ secrets.OCO_OPENAI_API_KEY }}
+          OCO_API_KEY: ${{ secrets.OCO_API_KEY }}
 
           # customization
           OCO_TOKENS_MAX_INPUT: 4096

jest.config.ts

@@ -9,19 +9,33 @@ const config: Config = {
   testTimeout: 100_000,
   coverageProvider: 'v8',
   moduleDirectories: ['node_modules', 'src'],
-  preset: 'ts-jest/presets/js-with-ts-esm',
+  preset: 'ts-jest/presets/default-esm',
   setupFilesAfterEnv: ['<rootDir>/test/jest-setup.ts'],
   testEnvironment: 'node',
   testRegex: ['.*\\.test\\.ts$'],
-  transformIgnorePatterns: ['node_modules/(?!cli-testing-library)'],
+  // Tell Jest to ignore the specific duplicate package.json files
+  // that are causing Haste module naming collisions
+  modulePathIgnorePatterns: [
+    '<rootDir>/test/e2e/prompt-module/data/'
+  ],
+  transformIgnorePatterns: [
+    'node_modules/(?!(cli-testing-library|@clack|cleye)/.*)'
+  ],
   transform: {
-    '^.+\\.(ts|tsx)$': [
+    '^.+\\.(ts|tsx|js|jsx|mjs)$': [
       'ts-jest',
       {
         diagnostics: false,
-        useESM: true
+        useESM: true,
+        tsconfig: {
+          module: 'ESNext',
+          target: 'ES2022'
+        }
       }
     ]
+  },
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1'
   }
 };
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencommit",
-  "version": "3.0.19",
+  "version": "3.2.8",
   "description": "Auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
   "keywords": [
     "git",
@@ -17,11 +17,11 @@
   ],
   "main": "cli.js",
   "bin": {
-    "opencommit": "./out/cli.cjs",
-    "oco": "./out/cli.cjs"
+    "opencommit": "out/cli.cjs",
+    "oco": "out/cli.cjs"
   },
   "repository": {
-    "url": "https://github.com/di-sukharev/opencommit"
+    "url": "git+https://github.com/di-sukharev/opencommit.git"
   },
   "type": "module",
   "author": "https://github.com/di-sukharev",
@@ -44,10 +44,11 @@
     "ollama:start": "OCO_AI_PROVIDER='ollama' node ./out/cli.cjs",
     "dev": "ts-node ./src/cli.ts",
     "dev:gemini": "OCO_AI_PROVIDER='gemini' ts-node ./src/cli.ts",
-    "build": "rimraf out && node esbuild.config.js",
+    "build": "npx rimraf out && node esbuild.config.js",
     "build:push": "npm run build && git add . && git commit -m 'build' && git push",
-    "deploy": "npm run build:push && git push --tags && npm publish --tag latest",
-    "deploy:patch": "npm version patch && npm run deploy",
+    "deploy": "npm publish --tag latest",
+    "deploy:build": "npm run build:push && git push --tags && npm run deploy",
+    "deploy:patch": "npm version patch && npm run deploy:build",
     "lint": "eslint src --ext ts && tsc --noEmit",
     "format": "prettier --write src",
     "test": "node --no-warnings --experimental-vm-modules $( [ -f ./node_modules/.bin/jest ] && echo ./node_modules/.bin/jest || which jest ) test/unit",
@@ -57,7 +58,8 @@
     "test:unit:docker": "npm run test:docker-build && DOCKER_CONTENT_TRUST=0 docker run --rm oco-test npm run test:unit",
     "test:e2e": "npm run test:e2e:setup && jest test/e2e",
     "test:e2e:setup": "sh test/e2e/setup.sh",
-    "test:e2e:docker": "npm run test:docker-build && DOCKER_CONTENT_TRUST=0 docker run --rm oco-test npm run test:e2e"
+    "test:e2e:docker": "npm run test:docker-build && DOCKER_CONTENT_TRUST=0 docker run --rm oco-test npm run test:e2e",
+    "mlx:start": "OCO_AI_PROVIDER='mlx' node ./out/cli.cjs"
   },
   "devDependencies": {
     "@commitlint/types": "^17.4.4",
@@ -65,14 +67,15 @@
     "@types/inquirer": "^9.0.3",
     "@types/jest": "^29.5.12",
     "@types/node": "^16.18.14",
-    "@typescript-eslint/eslint-plugin": "^5.45.0",
-    "@typescript-eslint/parser": "^5.45.0",
+    "@typescript-eslint/eslint-plugin": "^8.29.0",
+    "@typescript-eslint/parser": "^8.29.0",
     "cli-testing-library": "^2.0.2",
     "dotenv": "^16.0.3",
-    "esbuild": "^0.15.18",
-    "eslint": "^8.28.0",
+    "esbuild": "^0.25.5",
+    "eslint": "^9.24.0",
     "jest": "^29.7.0",
     "prettier": "^2.8.4",
+    "rimraf": "^6.0.1",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.3"
@@ -80,15 +83,15 @@
   "dependencies": {
     "@actions/core": "^1.10.0",
     "@actions/exec": "^1.1.1",
-    "@actions/github": "^5.1.1",
-    "@azure/openai": "^1.0.0-beta.12",
+    "@actions/github": "^6.0.1",
     "@anthropic-ai/sdk": "^0.19.2",
+    "@azure/openai": "^1.0.0-beta.12",
     "@clack/prompts": "^0.6.1",
     "@dqbd/tiktoken": "^1.0.2",
     "@google/generative-ai": "^0.11.4",
+    "@mistralai/mistralai": "^1.3.5",
     "@octokit/webhooks-schemas": "^6.11.0",
     "@octokit/webhooks-types": "^6.11.0",
-    "ai": "^2.2.14",
     "axios": "^1.3.4",
     "chalk": "^5.2.0",
     "cleye": "^1.3.2",
@@ -97,9 +100,12 @@
     "ignore": "^5.2.4",
     "ini": "^3.0.1",
     "inquirer": "^9.1.4",
-    "openai": "^3.2.1"
+    "openai": "^4.57.0",
+    "punycode": "^2.3.1",
+    "zod": "^3.23.8"
   },
   "overrides": {
-    "whatwg-url": "13.0.0"
+    "ajv": "^8.17.1",
+    "whatwg-url": "^14.0.0"
   }
 }

src/cli.ts

@@ -9,6 +9,7 @@ import { configCommand } from './commands/config';
 import { hookCommand, isHookCalled } from './commands/githook.js';
 import { prepareCommitMessageHook } from './commands/prepare-commit-msg-hook';
 import { checkIsLatestVersion } from './utils/checkIsLatestVersion';
+import { runMigrations } from './migrations/_run.js';
 
 const extraArgs = process.argv.slice(2);
 
@@ -18,7 +19,17 @@ cli(
     name: 'opencommit',
     commands: [configCommand, hookCommand, commitlintConfigCommand],
     flags: {
-      fgm: Boolean,
+      fgm: {
+        type: Boolean,
+        description: 'Use full GitMoji specification',
+        default: false
+      },
+      context: {
+        type: String,
+        alias: 'c',
+        description: 'Additional user input context for the commit message',
+        default: ''
+      },
       yes: {
         type: Boolean,
         alias: 'y',
@@ -30,12 +41,13 @@ cli(
     help: { description: packageJSON.description }
   },
   async ({ flags }) => {
+    await runMigrations();
     await checkIsLatestVersion();
 
     if (await isHookCalled()) {
       prepareCommitMessageHook();
     } else {
-      commit(extraArgs, false, flags.fgm, flags.yes);
+      commit(extraArgs, flags.context, false, flags.fgm, flags.yes);
     }
   },
   extraArgs

src/commands/ENUMS.ts

@@ -0,0 +1,5 @@
+export enum COMMANDS {
+  config = 'config',
+  hook = 'hook',
+  commitlint = 'commitlint'
+}

src/commands/commit.ts

@@ -1,6 +1,3 @@
-import chalk from 'chalk';
-import { execa } from 'execa';
-
 import {
   confirm,
   intro,
@@ -10,7 +7,8 @@ import {
   select,
   spinner
 } from '@clack/prompts';
-
+import chalk from 'chalk';
+import { execa } from 'execa';
 import { generateCommitMessageByDiff } from '../generateCommitMessageFromGitDiff';
 import {
   assertGitRepo,
@@ -32,43 +30,53 @@ const getGitRemotes = async () => {
 // Check for the presence of message templates
 const checkMessageTemplate = (extraArgs: string[]): string | false => {
   for (const key in extraArgs) {
-    if (extraArgs[key].includes(config?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER))
+    if (extraArgs[key].includes(config.OCO_MESSAGE_TEMPLATE_PLACEHOLDER))
       return extraArgs[key];
   }
   return false;
 };
 
-const generateCommitMessageFromGitDiff = async (
-  diff: string,
-  extraArgs: string[],
-  fullGitMojiSpec: boolean,
-  skipCommitConfirmation: boolean
-): Promise<void> => {
+interface GenerateCommitMessageFromGitDiffParams {
+  diff: string;
+  extraArgs: string[];
+  context?: string;
+  fullGitMojiSpec?: boolean;
+  skipCommitConfirmation?: boolean;
+}
+
+const generateCommitMessageFromGitDiff = async ({
+  diff,
+  extraArgs,
+  context = '',
+  fullGitMojiSpec = false,
+  skipCommitConfirmation = false
+}: GenerateCommitMessageFromGitDiffParams): Promise<void> => {
   await assertGitRepo();
-  const commitSpinner = spinner();
-  commitSpinner.start('Generating the commit message');
+  const commitGenerationSpinner = spinner();
+  commitGenerationSpinner.start('Generating the commit message');
 
   try {
     let commitMessage = await generateCommitMessageByDiff(
       diff,
-      fullGitMojiSpec
+      fullGitMojiSpec,
+      context
     );
 
     const messageTemplate = checkMessageTemplate(extraArgs);
     if (
-      config?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER &&
+      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,
+        config.OCO_MESSAGE_TEMPLATE_PLACEHOLDER,
         commitMessage
       );
     }
 
-    commitSpinner.stop('📝 Commit message generated');
+    commitGenerationSpinner.stop('📝 Commit message generated');
 
     outro(
       `Generated commit message:
@@ -77,27 +85,33 @@ ${commitMessage}
 ${chalk.grey('——————————————————')}`
     );
 
-    const isCommitConfirmedByUser = skipCommitConfirmation || await confirm({
-      message: 'Confirm the commit message?'
-    });
+    const isCommitConfirmedByUser =
+      skipCommitConfirmation ||
+      (await confirm({
+        message: 'Confirm the commit message?'
+      }));
 
-    if (isCommitConfirmedByUser && !isCancel(isCommitConfirmedByUser)) {
+    if (isCancel(isCommitConfirmedByUser)) process.exit(1);
+
+    if (isCommitConfirmedByUser) {
+      const committingChangesSpinner = spinner();
+      committingChangesSpinner.start('Committing the changes');
       const { stdout } = await execa('git', [
         'commit',
         '-m',
         commitMessage,
         ...extraArgs
       ]);
-
-      outro(`${chalk.green('✔')} Successfully committed`);
+      committingChangesSpinner.stop(
+        `${chalk.green('✔')} Successfully committed`
+      );
 
       outro(stdout);
 
       const remotes = await getGitRemotes();
 
       // user isn't pushing, return early
-      if (config?.OCO_GITPUSH === false)
-          return
+      if (config.OCO_GITPUSH === false) return;
 
       if (!remotes.length) {
         const { stdout } = await execa('git', ['push']);
@@ -105,12 +119,14 @@ ${chalk.grey('——————————————————')}`
         process.exit(0);
       }
 
-      if (remotes.length === 1 && config?.OCO_GITPUSH !== true) {
+      if (remotes.length === 1) {
         const isPushConfirmedByUser = await confirm({
           message: 'Do you want to run `git push`?'
         });
 
-        if (isPushConfirmedByUser && !isCancel(isPushConfirmedByUser)) {
+        if (isCancel(isPushConfirmedByUser)) process.exit(1);
+
+        if (isPushConfirmedByUser) {
           const pushSpinner = spinner();
 
           pushSpinner.start(`Running 'git push ${remotes[0]}'`);
@@ -133,42 +149,54 @@ ${chalk.grey('——————————————————')}`
           process.exit(0);
         }
       } else {
+        const skipOption = `don't push`;
         const selectedRemote = (await select({
           message: 'Choose a remote to push to',
-          options: remotes.map((remote) => ({ value: remote, label: remote }))
+          options: [...remotes, skipOption].map((remote) => ({
+            value: remote,
+            label: remote
+          }))
         })) as string;
 
-        if (!isCancel(selectedRemote)) {
+        if (isCancel(selectedRemote)) process.exit(1);
+
+        if (selectedRemote !== skipOption) {
           const pushSpinner = spinner();
 
           pushSpinner.start(`Running 'git push ${selectedRemote}'`);
 
           const { stdout } = await execa('git', ['push', selectedRemote]);
 
+          if (stdout) outro(stdout);
+
           pushSpinner.stop(
             `${chalk.green(
               '✔'
-            )} Successfully pushed all commits to ${selectedRemote}`
+            )} successfully pushed all commits to ${selectedRemote}`
           );
-
-          if (stdout) outro(stdout);
-        } else outro(`${chalk.gray('✖')} process cancelled`);
+        }
       }
-    }
-    if (!isCommitConfirmedByUser && !isCancel(isCommitConfirmedByUser)) {
+    } else {
       const regenerateMessage = await confirm({
-        message: 'Do you want to regenerate the message ?'
+        message: 'Do you want to regenerate the message?'
       });
-      if (regenerateMessage && !isCancel(isCommitConfirmedByUser)) {
-        await generateCommitMessageFromGitDiff(
+
+      if (isCancel(regenerateMessage)) process.exit(1);
+
+      if (regenerateMessage) {
+        await generateCommitMessageFromGitDiff({
           diff,
           extraArgs,
           fullGitMojiSpec
-        )
+        });
       }
     }
   } catch (error) {
-    commitSpinner.stop('📝 Commit message generated');
+    commitGenerationSpinner.stop(
+      `${chalk.red('✖')} Failed to generate the commit message`
+    );
+
+    console.log(error);
 
     const err = error as Error;
     outro(`${chalk.red('✖')} ${err?.message || err}`);
@@ -178,6 +206,7 @@ ${chalk.grey('——————————————————')}`
 
 export async function commit(
   extraArgs: string[] = [],
+  context: string = '',
   isStageAllFlag: Boolean = false,
   fullGitMojiSpec: boolean = false,
   skipCommitConfirmation: boolean = false
@@ -210,18 +239,18 @@ export async function commit(
 
   stagedFilesSpinner.start('Counting staged files');
 
-  if (!stagedFiles.length) {
+  if (stagedFiles.length === 0) {
     stagedFilesSpinner.stop('No files are staged');
+
     const isStageAllAndCommitConfirmedByUser = await confirm({
       message: 'Do you want to stage all files and generate commit message?'
     });
 
-    if (
-      isStageAllAndCommitConfirmedByUser &&
-      !isCancel(isStageAllAndCommitConfirmedByUser)
-    ) {
-      await commit(extraArgs, true, fullGitMojiSpec);
-      process.exit(1);
+    if (isCancel(isStageAllAndCommitConfirmedByUser)) process.exit(1);
+
+    if (isStageAllAndCommitConfirmedByUser) {
+      await commit(extraArgs, context, true, fullGitMojiSpec);
+      process.exit(0);
     }
 
     if (stagedFiles.length === 0 && changedFiles.length > 0) {
@@ -233,13 +262,13 @@ export async function commit(
         }))
       })) as string[];
 
-      if (isCancel(files)) process.exit(1);
+      if (isCancel(files)) process.exit(0);
 
       await gitAdd({ files });
     }
 
-    await commit(extraArgs, false, fullGitMojiSpec);
-    process.exit(1);
+    await commit(extraArgs, context, false, fullGitMojiSpec);
+    process.exit(0);
   }
 
   stagedFilesSpinner.stop(
@@ -249,12 +278,13 @@ export async function commit(
   );
 
   const [, generateCommitError] = await trytm(
-    generateCommitMessageFromGitDiff(
-      await getDiff({ files: stagedFiles }),
+    generateCommitMessageFromGitDiff({
+      diff: await getDiff({ files: stagedFiles }),
       extraArgs,
+      context,
       fullGitMojiSpec,
       skipCommitConfirmation
-    )
+    })
   );
 
   if (generateCommitError) {

src/commands/commitlint.ts

@@ -1,11 +1,9 @@
+import { intro, outro } from '@clack/prompts';
 import chalk from 'chalk';
 import { command } from 'cleye';
-
-import { intro, outro } from '@clack/prompts';
-
-import { COMMANDS } from '../CommandsEnum';
 import { configureCommitlintIntegration } from '../modules/commitlint/config';
 import { getCommitlintLLMConfig } from '../modules/commitlint/utils';
+import { COMMANDS } from './ENUMS';
 
 export enum CONFIG_MODES {
   get = 'get',
@@ -25,7 +23,7 @@ export const commitlintConfigCommand = command(
       if (mode === CONFIG_MODES.get) {
         const commitLintConfig = await getCommitlintLLMConfig();
 
-        outro(commitLintConfig.toString());
+        outro(JSON.stringify(commitLintConfig, null, 2));
 
         return;
       }

src/commands/config.ts

@@ -1,3 +1,4 @@
+import { intro, outro } from '@clack/prompts';
 import chalk from 'chalk';
 import { command } from 'cleye';
 import * as dotenv from 'dotenv';
@@ -5,42 +6,34 @@ import { existsSync, readFileSync, writeFileSync } from 'fs';
 import { parse as iniParse, stringify as iniStringify } from 'ini';
 import { homedir } from 'os';
 import { join as pathJoin, resolve as pathResolve } from 'path';
-
-import { intro, outro } from '@clack/prompts';
-
-import { COMMANDS } from '../CommandsEnum';
-import { getI18nLocal } from '../i18n';
+import { COMMANDS } from './ENUMS';
 import { TEST_MOCK_TYPES } from '../engine/testAi';
+import { getI18nLocal, i18n } from '../i18n';
 
 export enum CONFIG_KEYS {
-  OCO_OPENAI_API_KEY = 'OCO_OPENAI_API_KEY',
-  OCO_ANTHROPIC_API_KEY = 'OCO_ANTHROPIC_API_KEY',
-  OCO_AZURE_API_KEY = 'OCO_AZURE_API_KEY',
-  OCO_GEMINI_API_KEY = 'OCO_GEMINI_API_KEY',
-  OCO_GEMINI_BASE_PATH = 'OCO_GEMINI_BASE_PATH',
+  OCO_API_KEY = 'OCO_API_KEY',
   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',
   OCO_MODEL = 'OCO_MODEL',
   OCO_LANGUAGE = 'OCO_LANGUAGE',
+  OCO_WHY = 'OCO_WHY',
   OCO_MESSAGE_TEMPLATE_PLACEHOLDER = 'OCO_MESSAGE_TEMPLATE_PLACEHOLDER',
   OCO_PROMPT_MODULE = 'OCO_PROMPT_MODULE',
   OCO_AI_PROVIDER = 'OCO_AI_PROVIDER',
-  OCO_GITPUSH = 'OCO_GITPUSH',
   OCO_ONE_LINE_COMMIT = 'OCO_ONE_LINE_COMMIT',
-  OCO_AZURE_ENDPOINT = 'OCO_AZURE_ENDPOINT',
   OCO_TEST_MOCK_TYPE = 'OCO_TEST_MOCK_TYPE',
   OCO_API_URL = 'OCO_API_URL',
-  OCO_OLLAMA_API_URL = 'OCO_OLLAMA_API_URL',
-  OCO_FLOWISE_ENDPOINT = 'OCO_FLOWISE_ENDPOINT',
-  OCO_FLOWISE_API_KEY = 'OCO_FLOWISE_API_KEY'
+  OCO_API_CUSTOM_HEADERS = 'OCO_API_CUSTOM_HEADERS',
+  OCO_OMIT_SCOPE = 'OCO_OMIT_SCOPE',
+  OCO_GITPUSH = 'OCO_GITPUSH' // todo: deprecate
 }
 
 export enum CONFIG_MODES {
   get = 'get',
-  set = 'set'
+  set = 'set',
+  describe = 'describe'
 }
 
 export const MODEL_LIST = {
@@ -86,17 +79,78 @@ export const MODEL_LIST = {
     'gemini-1.0-pro',
     'gemini-pro-vision',
     'text-embedding-004'
-  ]
+  ],
+
+  groq: [
+    'llama3-70b-8192', // Meta Llama 3 70B (default one, no daily token limit and 14 400 reqs/day)
+    'llama3-8b-8192', // Meta Llama 3 8B
+    'llama-guard-3-8b', // Llama Guard 3 8B
+    'llama-3.1-8b-instant', // Llama 3.1 8B (Preview)
+    'llama-3.1-70b-versatile', // Llama 3.1 70B (Preview)
+    'gemma-7b-it', // Gemma 7B
+    'gemma2-9b-it' // Gemma 2 9B
+  ],
+
+  mistral: [
+    'ministral-3b-2410',
+    'ministral-3b-latest',
+    'ministral-8b-2410',
+    'ministral-8b-latest',
+    'open-mistral-7b',
+    'mistral-tiny',
+    'mistral-tiny-2312',
+    'open-mistral-nemo',
+    'open-mistral-nemo-2407',
+    'mistral-tiny-2407',
+    'mistral-tiny-latest',
+    'open-mixtral-8x7b',
+    'mistral-small',
+    'mistral-small-2312',
+    'open-mixtral-8x22b',
+    'open-mixtral-8x22b-2404',
+    'mistral-small-2402',
+    'mistral-small-2409',
+    'mistral-small-latest',
+    'mistral-medium-2312',
+    'mistral-medium',
+    'mistral-medium-latest',
+    'mistral-large-2402',
+    'mistral-large-2407',
+    'mistral-large-2411',
+    'mistral-large-latest',
+    'pixtral-large-2411',
+    'pixtral-large-latest',
+    'codestral-2405',
+    'codestral-latest',
+    'codestral-mamba-2407',
+    'open-codestral-mamba',
+    'codestral-mamba-latest',
+    'pixtral-12b-2409',
+    'pixtral-12b',
+    'pixtral-12b-latest',
+    'mistral-embed',
+    'mistral-moderation-2411',
+    'mistral-moderation-latest'
+  ],
+  deepseek: ['deepseek-chat', 'deepseek-reasoner']
 };
 
 const getDefaultModel = (provider: string | undefined): string => {
   switch (provider) {
     case 'ollama':
       return '';
+    case 'mlx':
+      return '';
     case 'anthropic':
       return MODEL_LIST.anthropic[0];
     case 'gemini':
       return MODEL_LIST.gemini[0];
+    case 'groq':
+      return MODEL_LIST.groq[0];
+    case 'mistral':
+      return MODEL_LIST.mistral[0];
+    case 'deepseek':
+      return MODEL_LIST.deepseek[0];
     default:
       return MODEL_LIST.openai[0];
   }
@@ -113,8 +167,10 @@ const validateConfig = (
   validationMessage: string
 ) => {
   if (!condition) {
+    outro(`${chalk.red('✖')} wrong value for ${key}: ${validationMessage}.`);
+
     outro(
-      `${chalk.red('✖')} Unsupported config key ${key}: ${validationMessage}`
+      'For more help refer to docs https://github.com/di-sukharev/opencommit'
     );
 
     process.exit(1);
@@ -122,76 +178,19 @@ const validateConfig = (
 };
 
 export const configValidators = {
-  [CONFIG_KEYS.OCO_OPENAI_API_KEY](value: any, config: any = {}) {
-    if (config.OCO_AI_PROVIDER == 'gemini') return value;
+  [CONFIG_KEYS.OCO_API_KEY](value: any, config: any = {}) {
+    if (config.OCO_AI_PROVIDER !== 'openai') return value;
 
-    //need api key unless running locally with ollama
     validateConfig(
-      'OpenAI API_KEY',
-      value ||
-        config.OCO_ANTHROPIC_API_KEY ||
-        config.OCO_AI_PROVIDER.startsWith('ollama') ||
-        config.OCO_AZURE_API_KEY ||
-        config.OCO_AI_PROVIDER == 'test' ||
-        config.OCO_AI_PROVIDER == 'flowise',
-      'You need to provide an OpenAI/Anthropic/Azure or other provider API key via `oco config set OCO_OPENAI_API_KEY=your_key`, for help refer to docs https://github.com/di-sukharev/opencommit'
-    );
-    validateConfig(
-      CONFIG_KEYS.OCO_OPENAI_API_KEY,
-      value.startsWith('sk-') || config.OCO_AI_PROVIDER != 'openai',
-      'Must start with "sk-" for openai provider'
+      'OCO_API_KEY',
+      typeof value === 'string' && value.length > 0,
+      'Empty value is not allowed'
     );
 
-    return value;
-  },
-
-  [CONFIG_KEYS.OCO_AZURE_API_KEY](value: any, config: any = {}) {
     validateConfig(
-      'ANTHROPIC_API_KEY',
-      value ||
-        config.OCO_OPENAI_API_KEY ||
-        config.OCO_AZURE_API_KEY ||
-        config.OCO_AI_PROVIDER == 'ollama' ||
-        config.OCO_AI_PROVIDER == 'test' ||
-        config.OCO_AI_PROVIDER == 'flowise',
-      'You need to provide an OpenAI/Anthropic/Azure API key'
-    );
-
-    return value;
-  },
-
-  [CONFIG_KEYS.OCO_GEMINI_API_KEY](value: any, config: any = {}) {
-    // only need to check for gemini api key if using gemini
-    if (config.OCO_AI_PROVIDER != 'gemini') return value;
-
-    validateConfig(
-      'Gemini API Key',
-      value || config.OCO_GEMINI_API_KEY || config.OCO_AI_PROVIDER == 'test',
-      'You need to provide an Gemini API key'
-    );
-
-    return value;
-  },
-
-  [CONFIG_KEYS.OCO_ANTHROPIC_API_KEY](value: any, config: any = {}) {
-    validateConfig(
-      'ANTHROPIC_API_KEY',
-      value ||
-        config.OCO_OPENAI_API_KEY ||
-        config.OCO_AI_PROVIDER == 'ollama' ||
-        config.OCO_AI_PROVIDER == 'test' ||
-        config.OCO_AI_PROVIDER == 'flowise',
-      'You need to provide an OpenAI/Anthropic API key'
-    );
-
-    return value;
-  },
-
-  [CONFIG_KEYS.OCO_FLOWISE_API_KEY](value: any, config: any = {}) {
-    validateConfig(
-      CONFIG_KEYS.OCO_FLOWISE_API_KEY,
-      value || config.OCO_AI_PROVIDER != 'flowise',
-      'You need to provide a flowise API key'
+      'OCO_API_KEY',
+      value,
+      'You need to provide the OCO_API_KEY when OCO_AI_PROVIDER set to "openai" (default) or "ollama" or "mlx" or "azure" or "gemini" or "flowise" or "anthropic" or "deepseek". Run `oco config set OCO_API_KEY=your_key OCO_AI_PROVIDER=openai`'
     );
 
     return value;
@@ -201,25 +200,33 @@ export const configValidators = {
     validateConfig(
       CONFIG_KEYS.OCO_DESCRIPTION,
       typeof value === 'boolean',
-      'Must be true or false'
+      'Must be boolean: true or false'
     );
 
     return value;
   },
 
-  [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);
+  [CONFIG_KEYS.OCO_API_CUSTOM_HEADERS](value) {
+    try {
+      // Custom headers must be a valid JSON string
+      if (typeof value === 'string') {
+        JSON.parse(value);
+      }
+      return value;
+    } catch (error) {
       validateConfig(
-        CONFIG_KEYS.OCO_TOKENS_MAX_INPUT,
-        !isNaN(value),
-        'Must be a number'
+        CONFIG_KEYS.OCO_API_CUSTOM_HEADERS,
+        false,
+        'Must be a valid JSON string of headers'
       );
     }
+  },
+
+  [CONFIG_KEYS.OCO_TOKENS_MAX_INPUT](value: any) {
+    value = parseInt(value);
     validateConfig(
       CONFIG_KEYS.OCO_TOKENS_MAX_INPUT,
-      value ? typeof value === 'number' : undefined,
+      !isNaN(value),
       'Must be a number'
     );
 
@@ -227,18 +234,10 @@ export const configValidators = {
   },
 
   [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'
-      );
-    }
+    value = parseInt(value);
     validateConfig(
       CONFIG_KEYS.OCO_TOKENS_MAX_OUTPUT,
-      value ? typeof value === 'number' : undefined,
+      !isNaN(value),
       'Must be a number'
     );
 
@@ -249,26 +248,39 @@ export const configValidators = {
     validateConfig(
       CONFIG_KEYS.OCO_EMOJI,
       typeof value === 'boolean',
-      'Must be true or false'
+      'Must be boolean: true or false'
+    );
+
+    return value;
+  },
+
+  [CONFIG_KEYS.OCO_OMIT_SCOPE](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_OMIT_SCOPE,
+      typeof value === 'boolean',
+      'Must be boolean: true or false'
     );
 
     return value;
   },
 
   [CONFIG_KEYS.OCO_LANGUAGE](value: any) {
+    const supportedLanguages = Object.keys(i18n);
+
     validateConfig(
       CONFIG_KEYS.OCO_LANGUAGE,
       getI18nLocal(value),
-      `${value} is not supported yet`
+      `${value} is not supported yet. Supported languages: ${supportedLanguages}`
     );
+
     return getI18nLocal(value);
   },
 
-  [CONFIG_KEYS.OCO_OPENAI_BASE_PATH](value: any) {
+  [CONFIG_KEYS.OCO_API_URL](value: any) {
     validateConfig(
-      CONFIG_KEYS.OCO_OPENAI_BASE_PATH,
+      CONFIG_KEYS.OCO_API_URL,
       typeof value === 'string',
-      'Must be string'
+      `${value} is not a valid URL. It should start with 'http://' or 'https://'.`
     );
     return value;
   },
@@ -304,6 +316,7 @@ export const configValidators = {
     return value;
   },
 
+  // todo: deprecate
   [CONFIG_KEYS.OCO_GITPUSH](value: any) {
     validateConfig(
       CONFIG_KEYS.OCO_GITPUSH,
@@ -314,19 +327,24 @@ export const configValidators = {
   },
 
   [CONFIG_KEYS.OCO_AI_PROVIDER](value: any) {
+    if (!value) value = 'openai';
+
     validateConfig(
       CONFIG_KEYS.OCO_AI_PROVIDER,
       [
-        '',
         'openai',
+        'mistral',
         'anthropic',
         'gemini',
         'azure',
         'test',
-        'flowise'
+        'flowise',
+        'groq',
+        'deepseek'
       ].includes(value) || value.startsWith('ollama'),
-      `${value} is not supported yet, use 'ollama', 'anthropic', 'azure', 'gemini', 'flowise' or 'openai' (default)`
+      `${value} is not supported yet, use 'ollama', 'mlx', 'anthropic', 'azure', 'gemini', 'flowise', 'mistral', 'deepseek' or 'openai' (default)`
     );
+
     return value;
   },
 
@@ -340,26 +358,6 @@ export const configValidators = {
     return value;
   },
 
-  [CONFIG_KEYS.OCO_AZURE_ENDPOINT](value: any) {
-    validateConfig(
-      CONFIG_KEYS.OCO_AZURE_ENDPOINT,
-      value.includes('openai.azure.com'),
-      'Must be in format "https://<resource name>.openai.azure.com/"'
-    );
-
-    return value;
-  },
-
-  [CONFIG_KEYS.OCO_FLOWISE_ENDPOINT](value: any) {
-    validateConfig(
-      CONFIG_KEYS.OCO_FLOWISE_ENDPOINT,
-      typeof value === 'string' && value.includes(':'),
-      'Value must be string and should include both I.P. and port number' // Considering the possibility of DNS lookup or feeding the I.P. explicitely, there is no pattern to verify, except a column for the port number
-    );
-
-    return value;
-  },
-
   [CONFIG_KEYS.OCO_TEST_MOCK_TYPE](value: any) {
     validateConfig(
       CONFIG_KEYS.OCO_TEST_MOCK_TYPE,
@@ -371,83 +369,67 @@ export const configValidators = {
     return value;
   },
 
-  [CONFIG_KEYS.OCO_OLLAMA_API_URL](value: any) {
-    // add simple api validator
+  [CONFIG_KEYS.OCO_WHY](value: any) {
     validateConfig(
-      CONFIG_KEYS.OCO_API_URL,
-      typeof value === 'string' && value.startsWith('http'),
-      `${value} is not a valid URL`
+      CONFIG_KEYS.OCO_WHY,
+      typeof value === 'boolean',
+      'Must be true or false'
     );
     return value;
   }
 };
 
+export enum OCO_AI_PROVIDER_ENUM {
+  OLLAMA = 'ollama',
+  OPENAI = 'openai',
+  ANTHROPIC = 'anthropic',
+  GEMINI = 'gemini',
+  AZURE = 'azure',
+  TEST = 'test',
+  FLOWISE = 'flowise',
+  GROQ = 'groq',
+  MISTRAL = 'mistral',
+  MLX = 'mlx',
+  DEEPSEEK = 'deepseek'
+}
+
 export type ConfigType = {
-  [key in CONFIG_KEYS]?: any;
+  [CONFIG_KEYS.OCO_API_KEY]?: string;
+  [CONFIG_KEYS.OCO_TOKENS_MAX_INPUT]: number;
+  [CONFIG_KEYS.OCO_TOKENS_MAX_OUTPUT]: number;
+  [CONFIG_KEYS.OCO_API_URL]?: string;
+  [CONFIG_KEYS.OCO_API_CUSTOM_HEADERS]?: string;
+  [CONFIG_KEYS.OCO_DESCRIPTION]: boolean;
+  [CONFIG_KEYS.OCO_EMOJI]: boolean;
+  [CONFIG_KEYS.OCO_WHY]: boolean;
+  [CONFIG_KEYS.OCO_MODEL]: string;
+  [CONFIG_KEYS.OCO_LANGUAGE]: string;
+  [CONFIG_KEYS.OCO_MESSAGE_TEMPLATE_PLACEHOLDER]: string;
+  [CONFIG_KEYS.OCO_PROMPT_MODULE]: OCO_PROMPT_MODULE_ENUM;
+  [CONFIG_KEYS.OCO_AI_PROVIDER]: OCO_AI_PROVIDER_ENUM;
+  [CONFIG_KEYS.OCO_GITPUSH]: boolean;
+  [CONFIG_KEYS.OCO_ONE_LINE_COMMIT]: boolean;
+  [CONFIG_KEYS.OCO_OMIT_SCOPE]: boolean;
+  [CONFIG_KEYS.OCO_TEST_MOCK_TYPE]: string;
 };
 
-const defaultConfigPath = pathJoin(homedir(), '.opencommit');
-const defaultEnvPath = pathResolve(process.cwd(), '.env');
-export const getConfig = ({
-  configPath = defaultConfigPath,
-  envPath = defaultEnvPath
-}: {
-  configPath?: string;
-  envPath?: string;
-} = {}): ConfigType | null => {
-  dotenv.config({ path: envPath });
-  const configFromEnv = {
-    OCO_OPENAI_API_KEY: process.env.OCO_OPENAI_API_KEY,
-    OCO_ANTHROPIC_API_KEY: process.env.OCO_ANTHROPIC_API_KEY,
-    OCO_AZURE_API_KEY: process.env.OCO_AZURE_API_KEY,
-    OCO_GEMINI_API_KEY: process.env.OCO_GEMINI_API_KEY,
-    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_GEMINI_BASE_PATH: process.env.OCO_GEMINI_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 || getDefaultModel(process.env.OCO_AI_PROVIDER),
-    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_GITPUSH: process.env.OCO_GITPUSH === 'false' ? false : true,
-    OCO_ONE_LINE_COMMIT:
-      process.env.OCO_ONE_LINE_COMMIT === 'true' ? true : false,
-    OCO_AZURE_ENDPOINT: process.env.OCO_AZURE_ENDPOINT || undefined,
-    OCO_TEST_MOCK_TYPE: process.env.OCO_TEST_MOCK_TYPE || 'commit-message',
-    OCO_FLOWISE_ENDPOINT: process.env.OCO_FLOWISE_ENDPOINT || ':',
-    OCO_FLOWISE_API_KEY: process.env.OCO_FLOWISE_API_KEY || undefined,
-    OCO_OLLAMA_API_URL: process.env.OCO_OLLAMA_API_URL || undefined
-  };
-  const configExists = existsSync(configPath);
-  if (!configExists) return configFromEnv;
+export const defaultConfigPath = pathJoin(homedir(), '.opencommit');
+export const defaultEnvPath = pathResolve(process.cwd(), '.env');
 
-  const configFile = readFileSync(configPath, 'utf8');
-  const config = iniParse(configFile);
+const assertConfigsAreValid = (config: Record<string, any>) => {
+  for (const [key, value] of Object.entries(config)) {
+    if (!value) continue;
 
-  for (const configKey of Object.keys(config)) {
-    if (['null', 'undefined'].includes(config[configKey])) {
-      config[configKey] = undefined;
+    if (typeof value === 'string' && ['null', 'undefined'].includes(value)) {
+      config[key] = undefined;
       continue;
     }
-    try {
-      const validator = configValidators[configKey as CONFIG_KEYS];
-      const validValue = validator(
-        config[configKey] ?? configFromEnv[configKey as CONFIG_KEYS],
-        config
-      );
 
-      config[configKey] = validValue;
+    try {
+      const validate = configValidators[key as CONFIG_KEYS];
+      validate(value, config);
     } catch (error) {
-      outro(`Unknown '${configKey}' config option or missing validator.`);
+      outro(`Unknown '${key}' config option or missing validator.`);
       outro(
         `Manually fix the '.env' file or global '~/.opencommit' config file.`
       );
@@ -455,61 +437,394 @@ export const getConfig = ({
       process.exit(1);
     }
   }
+};
 
-  return config;
+enum OCO_PROMPT_MODULE_ENUM {
+  CONVENTIONAL_COMMIT = 'conventional-commit',
+  COMMITLINT = '@commitlint'
+}
+
+export const DEFAULT_CONFIG = {
+  OCO_TOKENS_MAX_INPUT: DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_INPUT,
+  OCO_TOKENS_MAX_OUTPUT: DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_OUTPUT,
+  OCO_DESCRIPTION: false,
+  OCO_EMOJI: false,
+  OCO_MODEL: getDefaultModel('openai'),
+  OCO_LANGUAGE: 'en',
+  OCO_MESSAGE_TEMPLATE_PLACEHOLDER: '$msg',
+  OCO_PROMPT_MODULE: OCO_PROMPT_MODULE_ENUM.CONVENTIONAL_COMMIT,
+  OCO_AI_PROVIDER: OCO_AI_PROVIDER_ENUM.OPENAI,
+  OCO_ONE_LINE_COMMIT: false,
+  OCO_TEST_MOCK_TYPE: 'commit-message',
+  OCO_WHY: false,
+  OCO_OMIT_SCOPE: false,
+  OCO_GITPUSH: true // todo: deprecate
+};
+
+const initGlobalConfig = (configPath: string = defaultConfigPath) => {
+  writeFileSync(configPath, iniStringify(DEFAULT_CONFIG), 'utf8');
+  return DEFAULT_CONFIG;
+};
+
+const parseConfigVarValue = (value?: any) => {
+  try {
+    return JSON.parse(value);
+  } catch (error) {
+    return value;
+  }
+};
+
+const getEnvConfig = (envPath: string) => {
+  dotenv.config({ path: envPath });
+
+  return {
+    OCO_MODEL: process.env.OCO_MODEL,
+    OCO_API_URL: process.env.OCO_API_URL,
+    OCO_API_KEY: process.env.OCO_API_KEY,
+    OCO_API_CUSTOM_HEADERS: process.env.OCO_API_CUSTOM_HEADERS,
+    OCO_AI_PROVIDER: process.env.OCO_AI_PROVIDER as OCO_AI_PROVIDER_ENUM,
+
+    OCO_TOKENS_MAX_INPUT: parseConfigVarValue(process.env.OCO_TOKENS_MAX_INPUT),
+    OCO_TOKENS_MAX_OUTPUT: parseConfigVarValue(
+      process.env.OCO_TOKENS_MAX_OUTPUT
+    ),
+
+    OCO_DESCRIPTION: parseConfigVarValue(process.env.OCO_DESCRIPTION),
+    OCO_EMOJI: parseConfigVarValue(process.env.OCO_EMOJI),
+    OCO_LANGUAGE: process.env.OCO_LANGUAGE,
+    OCO_MESSAGE_TEMPLATE_PLACEHOLDER:
+      process.env.OCO_MESSAGE_TEMPLATE_PLACEHOLDER,
+    OCO_PROMPT_MODULE: process.env.OCO_PROMPT_MODULE as OCO_PROMPT_MODULE_ENUM,
+    OCO_ONE_LINE_COMMIT: parseConfigVarValue(process.env.OCO_ONE_LINE_COMMIT),
+    OCO_TEST_MOCK_TYPE: process.env.OCO_TEST_MOCK_TYPE,
+    OCO_OMIT_SCOPE: parseConfigVarValue(process.env.OCO_OMIT_SCOPE),
+
+    OCO_GITPUSH: parseConfigVarValue(process.env.OCO_GITPUSH) // todo: deprecate
+  };
+};
+
+export const setGlobalConfig = (
+  config: ConfigType,
+  configPath: string = defaultConfigPath
+) => {
+  writeFileSync(configPath, iniStringify(config), 'utf8');
+};
+
+export const getIsGlobalConfigFileExist = (
+  configPath: string = defaultConfigPath
+) => {
+  return existsSync(configPath);
+};
+
+export const getGlobalConfig = (configPath: string = defaultConfigPath) => {
+  let globalConfig: ConfigType;
+
+  const isGlobalConfigFileExist = getIsGlobalConfigFileExist(configPath);
+  if (!isGlobalConfigFileExist) globalConfig = initGlobalConfig(configPath);
+  else {
+    const configFile = readFileSync(configPath, 'utf8');
+    globalConfig = iniParse(configFile) as ConfigType;
+  }
+
+  return globalConfig;
+};
+
+/**
+ * Merges two configs.
+ * Env config takes precedence over global ~/.opencommit config file
+ * @param main - env config
+ * @param fallback - global ~/.opencommit config file
+ * @returns merged config
+ */
+const mergeConfigs = (main: Partial<ConfigType>, fallback: ConfigType) => {
+  const allKeys = new Set([...Object.keys(main), ...Object.keys(fallback)]);
+  return Array.from(allKeys).reduce((acc, key) => {
+    acc[key] = parseConfigVarValue(main[key] ?? fallback[key]);
+    return acc;
+  }, {} as ConfigType);
+};
+
+interface GetConfigOptions {
+  globalPath?: string;
+  envPath?: string;
+  setDefaultValues?: boolean;
+}
+
+const cleanUndefinedValues = (config: ConfigType) => {
+  return Object.fromEntries(
+    Object.entries(config).map(([_, v]) => {
+      try {
+        if (typeof v === 'string') {
+          if (v === 'undefined') return [_, undefined];
+          if (v === 'null') return [_, null];
+
+          const parsedValue = JSON.parse(v);
+          return [_, parsedValue];
+        }
+        return [_, v];
+      } catch (error) {
+        return [_, v];
+      }
+    })
+  );
+};
+
+export const getConfig = ({
+  envPath = defaultEnvPath,
+  globalPath = defaultConfigPath
+}: GetConfigOptions = {}): ConfigType => {
+  const envConfig = getEnvConfig(envPath);
+  const globalConfig = getGlobalConfig(globalPath);
+
+  const config = mergeConfigs(envConfig, globalConfig);
+
+  const cleanConfig = cleanUndefinedValues(config);
+
+  return cleanConfig as ConfigType;
 };
 
 export const setConfig = (
-  keyValues: [key: string, value: string][],
-  configPath: string = defaultConfigPath
+  keyValues: [key: string, value: string | boolean | number | null][],
+  globalConfigPath: string = defaultConfigPath
 ) => {
-  const config = getConfig() || {};
+  const config = getConfig({
+    globalPath: globalConfigPath
+  });
 
-  for (const [configKey, configValue] of keyValues) {
-    if (!configValidators.hasOwnProperty(configKey)) {
-      throw new Error(`Unsupported config key: ${configKey}`);
+  const configToSet = {};
+
+  for (let [key, value] of keyValues) {
+    if (!configValidators.hasOwnProperty(key)) {
+      const supportedKeys = Object.keys(configValidators).join('\n');
+      throw new Error(
+        `Unsupported config key: ${key}. Expected keys are:\n\n${supportedKeys}.\n\nFor more help refer to our docs: https://github.com/di-sukharev/opencommit`
+      );
     }
 
     let parsedConfigValue;
 
     try {
-      parsedConfigValue = JSON.parse(configValue);
+      if (typeof value === 'string') parsedConfigValue = JSON.parse(value);
+      else parsedConfigValue = value;
     } catch (error) {
-      parsedConfigValue = configValue;
+      parsedConfigValue = value;
     }
 
-    const validValue =
-      configValidators[configKey as CONFIG_KEYS](parsedConfigValue);
-    config[configKey as CONFIG_KEYS] = validValue;
+    const validValue = configValidators[key as CONFIG_KEYS](
+      parsedConfigValue,
+      config
+    );
+
+    configToSet[key] = validValue;
   }
 
-  writeFileSync(configPath, iniStringify(config), 'utf8');
+  setGlobalConfig(mergeConfigs(configToSet, config), globalConfigPath);
 
-  outro(`${chalk.green('✔')} Config successfully set`);
+  outro(`${chalk.green('✔')} config successfully set`);
 };
 
+// --- HELP MESSAGE GENERATION ---
+function getConfigKeyDetails(key) {
+  switch (key) {
+    case CONFIG_KEYS.OCO_MODEL:
+      return {
+        description: 'The AI model to use for generating commit messages',
+        values: MODEL_LIST
+      };
+    case CONFIG_KEYS.OCO_AI_PROVIDER:
+      return {
+        description: 'The AI provider to use',
+        values: Object.values(OCO_AI_PROVIDER_ENUM)
+      };
+    case CONFIG_KEYS.OCO_PROMPT_MODULE:
+      return {
+        description: 'The prompt module to use for commit message generation',
+        values: Object.values(OCO_PROMPT_MODULE_ENUM)
+      };
+    case CONFIG_KEYS.OCO_LANGUAGE:
+      return {
+        description: 'The locale to use for commit messages',
+        values: Object.keys(i18n)
+      };
+    case CONFIG_KEYS.OCO_TEST_MOCK_TYPE:
+      return {
+        description: 'The type of test mock to use',
+        values: ['commit-message', 'prompt-module-commitlint-config']
+      };
+    case CONFIG_KEYS.OCO_ONE_LINE_COMMIT:
+      return {
+        description: 'One line commit message',
+        values: ['true', 'false']
+      };
+    case CONFIG_KEYS.OCO_DESCRIPTION:
+      return {
+        description: 'Postface a message with ~3 sentences description of the changes',
+        values: ['true', 'false']
+      };
+    case CONFIG_KEYS.OCO_EMOJI:
+      return {
+        description: 'Preface a message with GitMoji',
+        values: ['true', 'false']
+      };
+    case CONFIG_KEYS.OCO_WHY:
+      return {
+        description: 'Output a short description of why the changes were done after the commit message (default: false)',
+        values: ['true', 'false']
+      }
+    case CONFIG_KEYS.OCO_OMIT_SCOPE:
+      return {
+        description: 'Do not include a scope in the commit message',
+        values: ['true', 'false']
+      };
+    case CONFIG_KEYS.OCO_GITPUSH:
+      return {
+        description: 'Push to git after commit (deprecated). If false, oco will exit after committing',
+        values: ['true', 'false']
+      };
+    case CONFIG_KEYS.OCO_TOKENS_MAX_INPUT:
+      return {
+        description: 'Max model token limit',
+        values: ['Any positive integer']
+      };
+    case CONFIG_KEYS.OCO_TOKENS_MAX_OUTPUT:
+      return {
+        description: 'Max response tokens',
+        values: ['Any positive integer']
+      };
+    case CONFIG_KEYS.OCO_API_KEY:
+      return {
+        description: 'API key for the selected provider',
+        values: ['String (required for most providers)']
+      };
+    case CONFIG_KEYS.OCO_API_URL:
+      return {
+        description: 'Custom API URL - may be used to set proxy path to OpenAI API',
+        values: ["URL string (must start with 'http://' or 'https://')"]
+      };
+    case CONFIG_KEYS.OCO_MESSAGE_TEMPLATE_PLACEHOLDER:
+      return {
+        description: 'Message template placeholder',
+        values: ["String (must start with $)"]
+      };
+    default:
+      return {
+        description: 'String value',
+        values: ['Any string']
+      };
+  }
+}
+
+function printConfigKeyHelp(param) {
+  if (!Object.values(CONFIG_KEYS).includes(param)) {
+    console.log(chalk.red(`Unknown config parameter: ${param}`));
+    return;
+  }
+
+  const details = getConfigKeyDetails(param as CONFIG_KEYS);
+
+  let desc = details.description;
+  let defaultValue = undefined;
+  if (param in DEFAULT_CONFIG) {
+    defaultValue = DEFAULT_CONFIG[param];
+  }
+
+
+  console.log(chalk.bold(`\n${param}:`));
+  console.log(chalk.gray(`  Description: ${desc}`));
+  if (defaultValue !== undefined) {
+    // Print booleans and numbers as-is, strings without quotes
+    if (typeof defaultValue === 'string') {
+      console.log(chalk.gray(`  Default: ${defaultValue}`));
+    } else {
+      console.log(chalk.gray(`  Default: ${defaultValue}`));
+    }
+  }
+
+  if (Array.isArray(details.values)) {
+    console.log(chalk.gray('  Accepted values:'));
+    details.values.forEach(value => {
+      console.log(chalk.gray(`    - ${value}`));
+    });
+  } else {
+    console.log(chalk.gray('  Accepted values by provider:'));
+    Object.entries(details.values).forEach(([provider, values]) => {
+      console.log(chalk.gray(`    ${provider}:`));
+      (values as string[]).forEach(value => {
+        console.log(chalk.gray(`      - ${value}`));
+      });
+    });
+  }
+}
+
+function printAllConfigHelp() {
+  console.log(chalk.bold('Available config parameters:'));
+  for (const key of Object.values(CONFIG_KEYS).sort()) {
+    const details = getConfigKeyDetails(key);
+    // Try to get the default value from DEFAULT_CONFIG
+    let defaultValue = undefined;
+    if (key in DEFAULT_CONFIG) {
+      defaultValue = DEFAULT_CONFIG[key];
+    }
+    
+    console.log(chalk.bold(`\n${key}:`));
+    console.log(chalk.gray(`  Description: ${details.description}`));
+    if (defaultValue !== undefined) {
+      if (typeof defaultValue === 'string') {
+        console.log(chalk.gray(`  Default: ${defaultValue}`));
+      } else {
+        console.log(chalk.gray(`  Default: ${defaultValue}`));
+      }
+    }
+  }
+  console.log(chalk.yellow('\nUse "oco config describe [PARAMETER]" to see accepted values and more details for a specific config parameter.'));
+}
+
 export const configCommand = command(
   {
     name: COMMANDS.config,
-    parameters: ['<mode>', '<key=values...>']
+    parameters: ['<mode>', '[key=values...]'],
+    help: {
+      description: 'Configure opencommit settings',
+      examples: [
+        'Describe all config parameters: oco config describe',
+        'Describe a specific parameter: oco config describe OCO_MODEL',
+        'Get a config value: oco config get OCO_MODEL',
+        'Set a config value: oco config set OCO_MODEL=gpt-4'
+      ]
+    }
   },
   async (argv) => {
-    intro('opencommit — config');
     try {
       const { mode, keyValues } = argv._;
+      intro(`COMMAND: config ${mode} ${keyValues}`);
 
-      if (mode === CONFIG_MODES.get) {
+      if (mode === CONFIG_MODES.describe) {
+        if (!keyValues || keyValues.length === 0) {
+          printAllConfigHelp();
+        } else {
+          for (const key of keyValues) {
+            printConfigKeyHelp(key);
+          }
+        }
+        process.exit(0);
+      } else if (mode === CONFIG_MODES.get) {
+        if (!keyValues || keyValues.length === 0) {
+          throw new Error('No config keys specified for get mode');
+        }
         const config = getConfig() || {};
         for (const key of keyValues) {
           outro(`${key}=${config[key as keyof typeof config]}`);
         }
       } else if (mode === CONFIG_MODES.set) {
+        if (!keyValues || keyValues.length === 0) {
+          throw new Error('No config keys specified for set mode');
+        }
         await setConfig(
           keyValues.map((keyValue) => keyValue.split('=') as [string, string])
         );
       } else {
         throw new Error(
-          `Unsupported mode: ${mode}. Valid modes are: "set" and "get"`
+          `Unsupported mode: ${mode}. Valid modes are: "set", "get", and "describe"`
         );
       }
     } catch (error) {

src/commands/githook.ts

@@ -1,13 +1,11 @@
+import { intro, outro } from '@clack/prompts';
 import chalk from 'chalk';
 import { command } from 'cleye';
 import { existsSync } from 'fs';
 import fs from 'fs/promises';
 import path from 'path';
-
-import { intro, outro } from '@clack/prompts';
-
-import { COMMANDS } from '../CommandsEnum.js';
 import { assertGitRepo, getCoreHooksPath } from '../utils/git.js';
+import { COMMANDS } from './ENUMS';
 
 const HOOK_NAME = 'prepare-commit-msg';
 const DEFAULT_SYMLINK_URL = path.join('.git', 'hooks', HOOK_NAME);
@@ -94,7 +92,7 @@ export const hookCommand = command(
       }
 
       throw new Error(
-        `Unsupported mode: ${mode}. Supported modes are: 'set' or 'unset', do: \`oco hook set\``
+        `Unsupported mode: ${mode}. Supported modes are: 'set' or 'unset'. Run: \`oco hook set\``
       );
     } catch (error) {
       outro(`${chalk.red('✖')} ${error}`);

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

@@ -39,10 +39,11 @@ export const prepareCommitMessageHook = async (
 
     const config = getConfig();
 
-    if (!config?.OCO_OPENAI_API_KEY && !config?.OCO_ANTHROPIC_API_KEY && !config?.OCO_AZURE_API_KEY) {
-      throw new Error(
-        'No OPEN_AI_API or OCO_ANTHROPIC_API_KEY or OCO_AZURE_API_KEY exists. Set your key in ~/.opencommit'
+    if (!config.OCO_API_KEY) {
+      outro(
+        'No OCO_API_KEY is set. Set your key via `oco config set OCO_API_KEY=<value>. For more info see https://github.com/di-sukharev/opencommit'
       );
+      return;
     }
 
     const spin = spinner();

src/engine/Engine.ts

@@ -1,7 +1,31 @@
-import { ChatCompletionRequestMessage } from 'openai';
+import AnthropicClient from '@anthropic-ai/sdk';
+import { OpenAIClient as AzureOpenAIClient } from '@azure/openai';
+import { GoogleGenerativeAI as GeminiClient } from '@google/generative-ai';
+import { AxiosInstance as RawAxiosClient } from 'axios';
+import { OpenAI as OpenAIClient } from 'openai';
+import { Mistral as MistralClient } from '@mistralai/mistralai';
+
+export interface AiEngineConfig {
+  apiKey: string;
+  model: string;
+  maxTokensOutput: number;
+  maxTokensInput: number;
+  baseURL?: string;
+  customHeaders?: Record<string, string>;
+}
+
+type Client =
+  | OpenAIClient
+  | AzureOpenAIClient
+  | AnthropicClient
+  | RawAxiosClient
+  | GeminiClient
+  | MistralClient;
 
 export interface AiEngine {
+  config: AiEngineConfig;
+  client: Client;
   generateCommitMessage(
-    messages: Array<ChatCompletionRequestMessage>
-  ): Promise<string | undefined>;
+    messages: Array<OpenAIClient.Chat.Completions.ChatCompletionMessageParam>
+  ): Promise<string | null | undefined>;
 }

src/engine/anthropic.ts

@@ -1,104 +1,63 @@
+import AnthropicClient from '@anthropic-ai/sdk';
+import {
+  MessageCreateParamsNonStreaming,
+  MessageParam
+} from '@anthropic-ai/sdk/resources/messages.mjs';
+import { outro } from '@clack/prompts';
 import axios from 'axios';
 import chalk from 'chalk';
-
-import Anthropic from '@anthropic-ai/sdk';
-import {ChatCompletionRequestMessage} from 'openai'
-import { MessageCreateParamsNonStreaming, MessageParam } from '@anthropic-ai/sdk/resources';
-
-import { intro, outro } from '@clack/prompts';
-
-import {
-  CONFIG_MODES,
-  DEFAULT_TOKEN_LIMITS,
-  getConfig
-} from '../commands/config';
+import { OpenAI } from 'openai';
 import { GenerateCommitMessageErrorEnum } from '../generateCommitMessageFromGitDiff';
+import { removeContentTags } from '../utils/removeContentTags';
 import { tokenCount } from '../utils/tokenCount';
-import { AiEngine } from './Engine';
-import { MODEL_LIST } from '../commands/config';
+import { AiEngine, AiEngineConfig } from './Engine';
 
-const config = getConfig();
+interface AnthropicConfig extends AiEngineConfig {}
 
-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;
+export class AnthropicEngine implements AiEngine {
+  config: AnthropicConfig;
+  client: AnthropicClient;
 
-let provider = config?.OCO_AI_PROVIDER;
-let apiKey = config?.OCO_ANTHROPIC_API_KEY;
-const [command, mode] = process.argv.slice(2);
-if (
-  provider === 'anthropic' &&
-  !apiKey &&
-  command !== 'config' &&
-  mode !== CONFIG_MODES.set
-) {
-  intro('opencommit');
-
-  outro(
-    'OCO_ANTHROPIC_API_KEY is not set, please run `oco config set OCO_ANTHROPIC_API_KEY=<your token> . If you are using Claude, make sure you add payment details, so API works.`'
-  );
-  outro(
-    'For help look into README https://github.com/di-sukharev/opencommit#setup'
-  );
-
-  process.exit(1);
-}
-
-const MODEL = config?.OCO_MODEL;
-if (provider === 'anthropic' &&
-  MODEL.typeof !== 'string' && 
-  command !== 'config' &&
-  mode !== CONFIG_MODES.set) {
-outro(
-  `${chalk.red('✖')} Unsupported model ${MODEL}. The model can be any string, but the current configuration is not supported.`
-);
-process.exit(1);
-}
-
-export class AnthropicAi implements AiEngine {
-  private anthropicAiApiConfiguration = {
-    apiKey: apiKey
-  };
-  private anthropicAI!: Anthropic;
-
-  constructor() {
-    this.anthropicAI = new Anthropic(this.anthropicAiApiConfiguration);
+  constructor(config) {
+    this.config = config;
+    this.client = new AnthropicClient({ apiKey: this.config.apiKey });
   }
 
   public generateCommitMessage = async (
-    messages: Array<ChatCompletionRequestMessage>
+    messages: Array<OpenAI.Chat.Completions.ChatCompletionMessageParam>
   ): Promise<string | undefined> => {
-
-    const systemMessage = messages.find(msg => msg.role === 'system')?.content as string;
-    const restMessages = messages.filter((msg) => msg.role !== 'system') as MessageParam[];
+    const systemMessage = messages.find((msg) => msg.role === 'system')
+      ?.content as string;
+    const restMessages = messages.filter(
+      (msg) => msg.role !== 'system'
+    ) as MessageParam[];
 
     const params: MessageCreateParamsNonStreaming = {
-      model: MODEL,
+      model: this.config.model,
       system: systemMessage,
       messages: restMessages,
       temperature: 0,
       top_p: 0.1,
-      max_tokens: MAX_TOKENS_OUTPUT
+      max_tokens: this.config.maxTokensOutput
     };
     try {
       const REQUEST_TOKENS = messages
         .map((msg) => tokenCount(msg.content as string) + 4)
         .reduce((a, b) => a + b, 0);
 
-      if (REQUEST_TOKENS > MAX_TOKENS_INPUT - MAX_TOKENS_OUTPUT) {
+      if (
+        REQUEST_TOKENS >
+        this.config.maxTokensInput - this.config.maxTokensOutput
+      ) {
         throw new Error(GenerateCommitMessageErrorEnum.tooMuchTokens);
       }
 
-      const data  = await this.anthropicAI.messages.create(params);
+      const data = await this.client.messages.create(params);
 
       const message = data?.content[0].text;
-
-      return message;
+      let content = message;
+      return removeContentTags(content, 'think');
     } catch (error) {
-      outro(`${chalk.red('✖')} ${JSON.stringify(params)}`);
-
       const err = error as Error;
       outro(`${chalk.red('✖')} ${err?.message || err}`);
 

src/engine/azure.ts

@@ -1,93 +1,66 @@
+import {
+  AzureKeyCredential,
+  OpenAIClient as AzureOpenAIClient
+} from '@azure/openai';
+import { outro } from '@clack/prompts';
 import axios from 'axios';
 import chalk from 'chalk';
-import { execa } from 'execa';
-import {
-  ChatCompletionRequestMessage,
-} from 'openai';
-
-import { OpenAIClient, AzureKeyCredential } from '@azure/openai';
-
-import { intro, outro } from '@clack/prompts';
-
-import {
-  CONFIG_MODES,
-  DEFAULT_TOKEN_LIMITS,
-  getConfig
-} from '../commands/config';
+import { OpenAI } from 'openai';
 import { GenerateCommitMessageErrorEnum } from '../generateCommitMessageFromGitDiff';
+import { removeContentTags } from '../utils/removeContentTags';
 import { tokenCount } from '../utils/tokenCount';
-import { AiEngine } from './Engine';
+import { AiEngine, AiEngineConfig } from './Engine';
 
-const config = getConfig();
-
-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_AZURE_API_KEY;
-let apiEndpoint = config?.OCO_AZURE_ENDPOINT;
-
-const [command, mode] = process.argv.slice(2);
-
-const provider = config?.OCO_AI_PROVIDER;
-
-if (
-  provider === 'azure' &&
-  !apiKey &&
-  !apiEndpoint &&
-  command !== 'config' &&
-  mode !== CONFIG_MODES.set
-) {
-  intro('opencommit');
-
-  outro(
-    'OCO_AZURE_API_KEY or OCO_AZURE_ENDPOINT are not set, please run `oco config set OCO_AZURE_API_KEY=<your token> . If you are using GPT, make sure you add payment details, so API works.`'
-  );
-  outro(
-    'For help look into README https://github.com/di-sukharev/opencommit#setup'
-  );
-
-  process.exit(1);
+interface AzureAiEngineConfig extends AiEngineConfig {
+  baseURL: string;
+  apiKey: string;
 }
 
-const MODEL = config?.OCO_MODEL || 'gpt-3.5-turbo';
+export class AzureEngine implements AiEngine {
+  config: AzureAiEngineConfig;
+  client: AzureOpenAIClient;
 
-export class Azure implements AiEngine {
-  private openAI!: OpenAIClient;
-
-  constructor() {
-    if (provider === 'azure') {
-      this.openAI = new OpenAIClient(apiEndpoint, new AzureKeyCredential(apiKey));
-    }
+  constructor(config: AzureAiEngineConfig) {
+    this.config = config;
+    this.client = new AzureOpenAIClient(
+      this.config.baseURL,
+      new AzureKeyCredential(this.config.apiKey)
+    );
   }
 
-  public generateCommitMessage = async (
-    messages: Array<ChatCompletionRequestMessage>
+  generateCommitMessage = async (
+    messages: Array<OpenAI.Chat.Completions.ChatCompletionMessageParam>
   ): Promise<string | undefined> => {
     try {
       const REQUEST_TOKENS = messages
-        .map((msg) => tokenCount(msg.content) + 4)
+        .map((msg) => tokenCount(msg.content as string) + 4)
         .reduce((a, b) => a + b, 0);
 
-      if (REQUEST_TOKENS > MAX_TOKENS_INPUT - MAX_TOKENS_OUTPUT) {
+      if (
+        REQUEST_TOKENS >
+        this.config.maxTokensInput - this.config.maxTokensOutput
+      ) {
         throw new Error(GenerateCommitMessageErrorEnum.tooMuchTokens);
       }
 
-      const data = await this.openAI.getChatCompletions(MODEL, messages);
+      const data = await this.client.getChatCompletions(
+        this.config.model,
+        messages
+      );
 
       const message = data.choices[0].message;
 
       if (message?.content === null) {
         return undefined;
       }
-      return message?.content;
+      
+      let content = message?.content;
+      return removeContentTags(content, 'think');
     } catch (error) {
-      outro(`${chalk.red('✖')} ${MODEL}`);
+      outro(`${chalk.red('✖')} ${this.config.model}`);
 
       const err = error as Error;
-      outro(`${chalk.red('✖')} ${err?.message || err}`);
+      outro(`${chalk.red('✖')} ${JSON.stringify(error)}`);
 
       if (
         axios.isAxiosError<{ error?: { message: string } }>(error) &&
@@ -105,5 +78,3 @@ export class Azure implements AiEngine {
     }
   };
 }
-
-export const azure = new Azure();

src/engine/deepseek.ts

@@ -0,0 +1,61 @@
+import axios from 'axios';
+import { OpenAI } from 'openai';
+import { GenerateCommitMessageErrorEnum } from '../generateCommitMessageFromGitDiff';
+import { removeContentTags } from '../utils/removeContentTags';
+import { tokenCount } from '../utils/tokenCount';
+import { OpenAiEngine, OpenAiConfig } from './openAi';
+
+export interface DeepseekConfig extends OpenAiConfig {}
+
+export class DeepseekEngine extends OpenAiEngine {
+  constructor(config: DeepseekConfig) {
+    // Call OpenAIEngine constructor with forced Deepseek baseURL
+    super({
+      ...config,
+      baseURL: 'https://api.deepseek.com/v1'
+    });
+  }
+
+  // Identical method from OpenAiEngine, re-implemented here
+  public generateCommitMessage = async (
+    messages: Array<OpenAI.Chat.Completions.ChatCompletionMessageParam>
+  ): Promise<string | null> => {
+    const params = {
+      model: this.config.model,
+      messages,
+      temperature: 0,
+      top_p: 0.1,
+      max_tokens: this.config.maxTokensOutput
+    };
+
+    try {
+      const REQUEST_TOKENS = messages
+        .map((msg) => tokenCount(msg.content as string) + 4)
+        .reduce((a, b) => a + b, 0);
+
+      if (
+        REQUEST_TOKENS >
+        this.config.maxTokensInput - this.config.maxTokensOutput
+      )
+        throw new Error(GenerateCommitMessageErrorEnum.tooMuchTokens);
+
+      const completion = await this.client.chat.completions.create(params);
+
+      const message = completion.choices[0].message;
+      let content = message?.content;
+      return removeContentTags(content, 'think');
+    } catch (error) {
+      const err = error as Error;
+      if (
+        axios.isAxiosError<{ error?: { message: string } }>(error) &&
+        error.response?.status === 401
+      ) {
+        const openAiError = error.response.data.error;
+
+        if (openAiError) throw new Error(openAiError.message);
+      }
+
+      throw err;
+    }
+  };
+}

src/engine/flowise.ts

@@ -1,40 +1,44 @@
-import axios, { AxiosError } from 'axios';
-import { ChatCompletionRequestMessage } from 'openai';
-import { AiEngine } from './Engine';
+import axios, { AxiosInstance } from 'axios';
+import { OpenAI } from 'openai';
+import { removeContentTags } from '../utils/removeContentTags';
+import { AiEngine, AiEngineConfig } from './Engine';
 
-import {
-  getConfig
-} from '../commands/config';
+interface FlowiseAiConfig extends AiEngineConfig {}
 
-const config = getConfig();
+export class FlowiseEngine implements AiEngine {
+  config: FlowiseAiConfig;
+  client: AxiosInstance;
 
-export class FlowiseAi implements AiEngine {
+  constructor(config) {
+    this.config = config;
+    this.client = axios.create({
+      url: `${config.baseURL}/${config.apiKey}`,
+      headers: { 'Content-Type': 'application/json' }
+    });
+  }
 
   async generateCommitMessage(
-    messages: Array<ChatCompletionRequestMessage>
+    messages: Array<OpenAI.Chat.Completions.ChatCompletionMessageParam>
   ): Promise<string | undefined> {
+    const gitDiff = (messages[messages.length - 1]?.content as string)
+      .replace(/\\/g, '\\\\')
+      .replace(/"/g, '\\"')
+      .replace(/\n/g, '\\n')
+      .replace(/\r/g, '\\r')
+      .replace(/\t/g, '\\t');
 
-    const gitDiff = messages[ messages.length - 1 ]?.content?.replace(/\\/g, '\\\\')  
-                                                            .replace(/"/g, '\\"')    
-                                                            .replace(/\n/g, '\\n')   
-                                                            .replace(/\r/g, '\\r')   
-                                                            .replace(/\t/g, '\\t');  
-    const url = `http://${config?.OCO_FLOWISE_ENDPOINT}/api/v1/prediction/${config?.OCO_FLOWISE_API_KEY}`; 
     const payload = {
-        question : gitDiff,
-        overrideConfig : {
-          systemMessagePrompt: messages[0]?.content,
-        },
-        history : messages.slice( 1, -1 ) 
-    }
+      question: gitDiff,
+      overrideConfig: {
+        systemMessagePrompt: messages[0]?.content
+      },
+      history: messages.slice(1, -1)
+    };
     try {
-      const response = await axios.post(url, payload, {
-        headers: {
-          'Content-Type': 'application/json'
-        }
-      });
+      const response = await this.client.post('', payload);
       const message = response.data;
-      return message?.text;
+      let content = message?.text;
+      return removeContentTags(content, 'think');
     } catch (err: any) {
       const message = err.response?.data?.error ?? err.message;
       throw new Error('local model issues. details: ' + message);

src/engine/gemini.ts

@@ -1,133 +1,90 @@
-import { ChatCompletionRequestMessage } from 'openai';
-import { AiEngine } from './Engine';
-import { Content, GenerativeModel, GoogleGenerativeAI, HarmBlockThreshold, HarmCategory, Part } from '@google/generative-ai';
-import { CONFIG_MODES, ConfigType, DEFAULT_TOKEN_LIMITS, getConfig, MODEL_LIST } from '../commands/config';
-import { intro, outro } from '@clack/prompts';
-import chalk from 'chalk';
+import {
+  Content,
+  GoogleGenerativeAI,
+  HarmBlockThreshold,
+  HarmCategory,
+  Part
+} from '@google/generative-ai';
 import axios from 'axios';
+import { OpenAI } from 'openai';
+import { removeContentTags } from '../utils/removeContentTags';
+import { AiEngine, AiEngineConfig } from './Engine';
 
+interface GeminiConfig extends AiEngineConfig {}
 
-export class Gemini implements AiEngine {
+export class GeminiEngine implements AiEngine {
+  config: GeminiConfig;
+  client: GoogleGenerativeAI;
 
-  private readonly config: ConfigType;
-  private readonly googleGenerativeAi: GoogleGenerativeAI;
-  private ai: GenerativeModel;
-
-  // vars 
-  private maxTokens = {
-    input: DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_INPUT,
-    output: DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_OUTPUT
-  };
-  private basePath: string;
-  private apiKey: string;
-  private model: string;
-
-  constructor() {
-    this.config = getConfig() as ConfigType;
-    this.googleGenerativeAi = new GoogleGenerativeAI(this.config.OCO_GEMINI_API_KEY);
-    
-    this.warmup();
+  constructor(config) {
+    this.client = new GoogleGenerativeAI(config.apiKey);
+    this.config = config;
   }
 
-  async generateCommitMessage(messages: ChatCompletionRequestMessage[]): Promise<string | undefined> {
-    const systemInstruction = messages.filter(m => m.role === 'system')
-      .map(m => m.content)
+  async generateCommitMessage(
+    messages: Array<OpenAI.Chat.Completions.ChatCompletionMessageParam>
+  ): Promise<string | undefined> {
+    const systemInstruction = messages
+      .filter((m) => m.role === 'system')
+      .map((m) => m.content)
       .join('\n');
-    
-    this.ai = this.googleGenerativeAi.getGenerativeModel({
-      model: this.model,
-      systemInstruction,
+
+    const gemini = this.client.getGenerativeModel({
+      model: this.config.model,
+      systemInstruction
     });
-    
-    const contents = messages.filter(m => m.role !== 'system')
-      .map(m => ({ parts: [{ text: m.content } as Part], role: m.role == 'user' ? m.role : 'model', } as Content));
-      
+
+    const contents = messages
+      .filter((m) => m.role !== 'system')
+      .map(
+        (m) =>
+          ({
+            parts: [{ text: m.content } as Part],
+            role: m.role === 'user' ? m.role : 'model'
+          } as Content)
+      );
+
     try {
-      const result = await this.ai.generateContent({
-        contents, 
+      const result = await gemini.generateContent({
+        contents,
         safetySettings: [
-          { 
-            category: HarmCategory.HARM_CATEGORY_DANGEROUS_CONTENT, 
-            threshold: HarmBlockThreshold.BLOCK_LOW_AND_ABOVE, 
-          },
           {
-            category: HarmCategory.HARM_CATEGORY_HARASSMENT, 
+            category: HarmCategory.HARM_CATEGORY_DANGEROUS_CONTENT,
             threshold: HarmBlockThreshold.BLOCK_LOW_AND_ABOVE
           },
           {
-            category: HarmCategory.HARM_CATEGORY_HATE_SPEECH, 
+            category: HarmCategory.HARM_CATEGORY_HARASSMENT,
             threshold: HarmBlockThreshold.BLOCK_LOW_AND_ABOVE
           },
           {
-            category: HarmCategory.HARM_CATEGORY_SEXUALLY_EXPLICIT, 
+            category: HarmCategory.HARM_CATEGORY_HATE_SPEECH,
             threshold: HarmBlockThreshold.BLOCK_LOW_AND_ABOVE
           },
+          {
+            category: HarmCategory.HARM_CATEGORY_SEXUALLY_EXPLICIT,
+            threshold: HarmBlockThreshold.BLOCK_LOW_AND_ABOVE
+          }
         ],
         generationConfig: {
-          maxOutputTokens: this.maxTokens.output,
+          maxOutputTokens: this.config.maxTokensOutput,
           temperature: 0,
-          topP: 0.1,
-        },
+          topP: 0.1
+        }
       });
-      
-      return result.response.text();
+
+      const content = result.response.text();
+      return removeContentTags(content, 'think');
     } catch (error) {
       const err = error as Error;
-      outro(`${chalk.red('✖')} ${err?.message || err}`);
-      
       if (
         axios.isAxiosError<{ error?: { message: string } }>(error) &&
         error.response?.status === 401
       ) {
         const geminiError = error.response.data.error;
-
-        if (geminiError?.message) outro(geminiError.message);
-        outro(
-          'For help look into README https://github.com/di-sukharev/opencommit#setup'
-        );
+        if (geminiError) throw new Error(geminiError?.message);
       }
-      
+
       throw err;
     }
   }
-
-  private warmup(): void {
-    if (this.config.OCO_TOKENS_MAX_INPUT !== undefined) this.maxTokens.input = this.config.OCO_TOKENS_MAX_INPUT;
-    if (this.config.OCO_TOKENS_MAX_OUTPUT !== undefined) this.maxTokens.output = this.config.OCO_TOKENS_MAX_OUTPUT;
-    this.basePath = this.config.OCO_GEMINI_BASE_PATH;
-    this.apiKey = this.config.OCO_GEMINI_API_KEY;
-
-    const [command, mode] = process.argv.slice(2);
-
-    const provider = this.config.OCO_AI_PROVIDER;
-
-    if (provider === 'gemini' && !this.apiKey &&
-      command !== 'config' && mode !== 'set') {
-      intro('opencommit');
-
-      outro('OCO_GEMINI_API_KEY is not set, please run `oco config set OCO_GEMINI_API_KEY=<your token> . If you are using GPT, make sure you add payment details, so API works.');
-
-      outro(
-        'For help look into README https://github.com/di-sukharev/opencommit#setup'
-      );
-
-      process.exit(1);
-    }
-    
-    this.model = this.config.OCO_MODEL || MODEL_LIST.gemini[0];
-    
-    if (provider === 'gemini' &&
-      !MODEL_LIST.gemini.includes(this.model) &&
-      command !== 'config' &&
-      mode !== CONFIG_MODES.set) {
-      outro(
-        `${chalk.red('✖')} Unsupported model ${this.model} for Gemini. Supported models are: ${MODEL_LIST.gemini.join(
-          ', '
-        )}`
-      );
-
-      process.exit(1);
-    }
-  }
-
-}
+}

src/engine/groq.ts

@@ -0,0 +1,10 @@
+import { OpenAiConfig, OpenAiEngine } from './openAi';
+
+interface GroqConfig extends OpenAiConfig {}
+
+export class GroqEngine extends OpenAiEngine {
+  constructor(config: GroqConfig) {
+    config.baseURL = 'https://api.groq.com/openai/v1';
+    super(config);
+  }
+}

src/engine/mistral.ts

@@ -0,0 +1,77 @@
+import axios from 'axios';
+import { OpenAI } from 'openai';
+import { GenerateCommitMessageErrorEnum } from '../generateCommitMessageFromGitDiff';
+import { removeContentTags } from '../utils/removeContentTags';
+import { tokenCount } from '../utils/tokenCount';
+import { AiEngine, AiEngineConfig } from './Engine';
+
+// Using any for Mistral types to avoid type declaration issues
+export interface MistralAiConfig extends AiEngineConfig {}
+export type MistralCompletionMessageParam = Array<any>;
+
+// Import Mistral dynamically to avoid TS errors
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const Mistral = require('@mistralai/mistralai').Mistral;
+
+export class MistralAiEngine implements AiEngine {
+  config: MistralAiConfig;
+  client: any; // Using any type for Mistral client to avoid TS errors
+
+  constructor(config: MistralAiConfig) {
+    this.config = config;
+
+    if (!config.baseURL) {
+      this.client = new Mistral({ apiKey: config.apiKey });
+    } else {
+      this.client = new Mistral({ apiKey: config.apiKey, serverURL: config.baseURL });
+    }
+  }
+
+  public generateCommitMessage = async (
+    messages: Array<OpenAI.Chat.Completions.ChatCompletionMessageParam>
+  ): Promise<string | null> => {
+    const params = {
+      model: this.config.model,
+      messages: messages as MistralCompletionMessageParam,
+      topP: 0.1,
+      maxTokens: this.config.maxTokensOutput
+    };
+
+    try {
+      const REQUEST_TOKENS = messages
+        .map((msg) => tokenCount(msg.content as string) + 4)
+        .reduce((a, b) => a + b, 0);
+
+      if (
+        REQUEST_TOKENS >
+        this.config.maxTokensInput - this.config.maxTokensOutput
+      )
+        throw new Error(GenerateCommitMessageErrorEnum.tooMuchTokens);
+
+      const completion = await this.client.chat.complete(params);
+
+      if (!completion.choices)
+        throw Error('No completion choice available.')
+      
+      const message = completion.choices[0].message;
+
+      if (!message || !message.content)
+        throw Error('No completion choice available.')
+
+      let content = message.content as string;
+      return removeContentTags(content, 'think');
+    } catch (error) {
+      const err = error as Error;
+      if (
+        axios.isAxiosError<{ error?: { message: string } }>(error) &&
+        error.response?.status === 401
+      ) {
+        const mistralError = error.response.data.error;
+
+        if (mistralError) throw new Error(mistralError.message);
+      }
+
+      throw err;
+    }
+  };
+}

src/engine/mlx.ts

@@ -0,0 +1,47 @@
+import axios, { AxiosInstance } from 'axios';
+import { OpenAI } from 'openai';
+import { removeContentTags } from '../utils/removeContentTags';
+import { AiEngine, AiEngineConfig } from './Engine';
+
+interface MLXConfig extends AiEngineConfig {}
+
+export class MLXEngine implements AiEngine {
+    config: MLXConfig;
+    client: AxiosInstance;
+
+    constructor(config) {
+        this.config = config;
+        this.client = axios.create({
+            url: config.baseURL
+            ? `${config.baseURL}/${config.apiKey}`
+            : 'http://localhost:8080/v1/chat/completions',
+            headers: { 'Content-Type': 'application/json' }
+        });
+    }
+
+    async generateCommitMessage(
+        messages: Array<OpenAI.Chat.Completions.ChatCompletionMessageParam>): 
+        Promise<string | undefined> {
+            const params = {
+                messages,
+                temperature: 0, 
+                top_p: 0.1,
+                repetition_penalty: 1.5,
+                stream: false
+            };
+            try {
+                const response = await this.client.post(
+                    this.client.getUri(this.config),
+                    params
+                );
+                
+                const choices = response.data.choices;
+                const message = choices[0].message;
+                let content = message?.content;
+                return removeContentTags(content, 'think');
+            } catch (err: any) {
+                const message = err.response?.data?.error ?? err.message;
+                throw new Error(`MLX provider error: ${message}`);
+            }
+        }
+}

src/engine/ollama.ts

@@ -1,52 +1,52 @@
-import axios, { AxiosError } from 'axios';
-import { ChatCompletionRequestMessage } from 'openai';
-import { AiEngine } from './Engine';
+import axios, { AxiosInstance } from 'axios';
+import { OpenAI } from 'openai';
+import { removeContentTags } from '../utils/removeContentTags';
+import { AiEngine, AiEngineConfig } from './Engine';
 
-import {
-  getConfig
-} from '../commands/config';
+interface OllamaConfig extends AiEngineConfig {}
 
-const config = getConfig();
+export class OllamaEngine implements AiEngine {
+  config: OllamaConfig;
+  client: AxiosInstance;
 
-export class OllamaAi implements AiEngine {
-  private model = "mistral"; // as default model of Ollama
-  private url = "http://localhost:11434/api/chat"; // default URL of Ollama API
-
-  setModel(model: string) {
-    this.model = model ?? config?.OCO_MODEL ?? 'mistral';
-  }
-  
-  setUrl(url: string) {
-    this.url = url ?? config?.OCO_OLLAMA_API_URL ?? 'http://localhost:11434/api/chat';
+  constructor(config) {
+    this.config = config;
+    
+    // Combine base headers with custom headers
+    const headers = { 
+      'Content-Type': 'application/json',
+      ...config.customHeaders 
+    };
+    
+    this.client = axios.create({
+      url: config.baseURL
+        ? `${config.baseURL}/${config.apiKey}`
+        : 'http://localhost:11434/api/chat',
+      headers
+    });
   }
+
   async generateCommitMessage(
-    messages: Array<ChatCompletionRequestMessage>
+    messages: Array<OpenAI.Chat.Completions.ChatCompletionMessageParam>
   ): Promise<string | undefined> {
-    const model = this.model;
-
-    //console.log(messages);
-    //process.exit()
-
-    const url = this.url;
-    const p = {
-      model,
+    const params = {
+      model: this.config.model ?? 'mistral',
       messages,
       options: { temperature: 0, top_p: 0.1 },
       stream: false
     };
     try {
-      const response = await axios.post(url, p, {
-        headers: {
-          'Content-Type': 'application/json'
-        }
-      });
+      const response = await this.client.post(
+        this.client.getUri(this.config),
+        params
+      );
 
-      const message = response.data.message;
-
-      return message?.content;
+      const { message } = response.data;
+      let content = message?.content;
+      return removeContentTags(content, 'think');
     } catch (err: any) {
       const message = err.response?.data?.error ?? err.message;
-      throw new Error('local model issues. details: ' + message);
+      throw new Error(`Ollama provider error: ${message}`);
     }
   }
 }

src/engine/openAi.ts

@@ -1,127 +1,77 @@
 import axios from 'axios';
-import chalk from 'chalk';
-import { execa } from 'execa';
-
-import {
-  ChatCompletionRequestMessage,
-  Configuration as OpenAiApiConfiguration,
-  OpenAIApi
-} from 'openai';
-
-import { intro, outro } from '@clack/prompts';
-
-import {
-  CONFIG_MODES,
-  DEFAULT_TOKEN_LIMITS,
-  getConfig
-} from '../commands/config';
+import { OpenAI } from 'openai';
 import { GenerateCommitMessageErrorEnum } from '../generateCommitMessageFromGitDiff';
+import { parseCustomHeaders } from '../utils/engine';
+import { removeContentTags } from '../utils/removeContentTags';
 import { tokenCount } from '../utils/tokenCount';
-import { AiEngine } from './Engine';
-import { MODEL_LIST } from '../commands/config';
+import { AiEngine, AiEngineConfig } from './Engine';
 
-const config = getConfig();
+export interface OpenAiConfig extends AiEngineConfig {}
 
-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;
+export class OpenAiEngine implements AiEngine {
+  config: OpenAiConfig;
+  client: OpenAI;
 
-const [command, mode] = process.argv.slice(2);
+  constructor(config: OpenAiConfig) {
+    this.config = config;
 
-const provider = config?.OCO_AI_PROVIDER;
-
-if (
-  provider === 'openai' &&
-  !apiKey &&
-  command !== 'config' &&
-  mode !== CONFIG_MODES.set
-) {
-  intro('opencommit');
-
-  outro(
-    'OCO_OPENAI_API_KEY is not set, please run `oco config set OCO_OPENAI_API_KEY=<your token> . If you are using GPT, make sure you add payment details, so API works.`'
-  );
-  outro(
-    'For help look into README https://github.com/di-sukharev/opencommit#setup'
-  );
-
-  process.exit(1);
-}
-
-const MODEL = config?.OCO_MODEL || 'gpt-3.5-turbo';
-if (provider === 'openai' &&
-  MODEL.typeof !== 'string' && 
-    command !== 'config' &&
-    mode !== CONFIG_MODES.set) {
-  outro(
-    `${chalk.red('✖')} Unsupported model ${MODEL}. The model can be any string, but the current configuration is not supported.`
-  );
-  process.exit(1);
-}
-
-export class OpenAi implements AiEngine {
-  
-  private openAiApiConfiguration = new OpenAiApiConfiguration({
-    apiKey: apiKey
-  });
-  private openAI!: OpenAIApi;
-
-  constructor() {
-    if (basePath) {
-      this.openAiApiConfiguration.basePath = basePath;
+    const clientOptions: OpenAI.ClientOptions = {
+      apiKey: config.apiKey
+    };
+    
+    if (config.baseURL) {
+      clientOptions.baseURL = config.baseURL;
     }
-    this.openAI = new OpenAIApi(this.openAiApiConfiguration);
+    
+    if (config.customHeaders) {
+      const headers = parseCustomHeaders(config.customHeaders);
+      if (Object.keys(headers).length > 0) {
+        clientOptions.defaultHeaders = headers;
+      }
+    }
+    
+    this.client = new OpenAI(clientOptions);
   }
 
   public generateCommitMessage = async (
-    messages: Array<ChatCompletionRequestMessage>
-  ): Promise<string | undefined> => {
+    messages: Array<OpenAI.Chat.Completions.ChatCompletionMessageParam>
+  ): Promise<string | null> => {
     const params = {
-      model: MODEL,
+      model: this.config.model,
       messages,
       temperature: 0,
       top_p: 0.1,
-      max_tokens: MAX_TOKENS_OUTPUT
+      max_tokens: this.config.maxTokensOutput
     };
+
     try {
       const REQUEST_TOKENS = messages
         .map((msg) => tokenCount(msg.content as string) + 4)
         .reduce((a, b) => a + b, 0);
 
-      if (REQUEST_TOKENS > MAX_TOKENS_INPUT - MAX_TOKENS_OUTPUT) {
+      if (
+        REQUEST_TOKENS >
+        this.config.maxTokensInput - this.config.maxTokensOutput
+      )
         throw new Error(GenerateCommitMessageErrorEnum.tooMuchTokens);
-      }
+      
+      const completion = await this.client.chat.completions.create(params);
 
-      const { data } = await this.openAI.createChatCompletion(params);
-
-      const message = data.choices[0].message;
-
-      return message?.content;
+      const message = completion.choices[0].message;
+      let content = message?.content;
+      return removeContentTags(content, 'think');
     } catch (error) {
-      outro(`${chalk.red('✖')} ${JSON.stringify(params)}`);
-
       const err = error as Error;
-      outro(`${chalk.red('✖')} ${err?.message || err}`);
-
       if (
         axios.isAxiosError<{ error?: { message: string } }>(error) &&
         error.response?.status === 401
       ) {
         const openAiError = error.response.data.error;
 
-        if (openAiError?.message) outro(openAiError.message);
-        outro(
-          'For help look into README https://github.com/di-sukharev/opencommit#setup'
-        );
+        if (openAiError) throw new Error(openAiError.message);
       }
 
       throw err;
     }
   };
-  
 }
-

src/engine/testAi.ts

@@ -1,31 +1,47 @@
-import { ChatCompletionRequestMessage } from 'openai';
+import { OpenAI } from 'openai';
+
 import { AiEngine } from './Engine';
-import { getConfig } from '../commands/config';
 
 export const TEST_MOCK_TYPES = [
   'commit-message',
-  'prompt-module-commitlint-config',
-] as const
-type TestMockType = typeof TEST_MOCK_TYPES[number];
+  'prompt-module-commitlint-config'
+] as const;
+
+export type TestMockType = (typeof TEST_MOCK_TYPES)[number];
+
+type TestAiEngine = Partial<AiEngine> & {
+  mockType: TestMockType;
+};
+
+export class TestAi implements TestAiEngine {
+  mockType: TestMockType;
+
+  // those are not used in the test engine
+  config: any;
+  client: any;
+  // ---
+
+  constructor(mockType: TestMockType) {
+    this.mockType = mockType;
+  }
 
-export class TestAi implements AiEngine {
   async generateCommitMessage(
-    _messages: Array<ChatCompletionRequestMessage>
+    _messages: Array<OpenAI.Chat.Completions.ChatCompletionMessageParam>
   ): Promise<string | undefined> {
-    const config = getConfig();
-    switch (config?.OCO_TEST_MOCK_TYPE as TestMockType | undefined) {
+    switch (this.mockType) {
       case 'commit-message':
         return 'fix(testAi.ts): test commit message';
       case 'prompt-module-commitlint-config':
-        return `{\n` +
+        return (
+          `{\n` +
           `  "localLanguage": "english",\n` +
           `  "commitFix": "fix(server): Change 'port' variable to uppercase 'PORT'",\n` +
           `  "commitFeat": "feat(server): Allow server to listen on a port specified through environment variable",\n` +
           `  "commitDescription": "Change 'port' variable to uppercase 'PORT'. Allow server to listen on a port specified through environment variable."\n` +
           `}`
+        );
       default:
-        throw Error('unsupported test mock type')
+        throw Error('unsupported test mock type');
     }
   }
 }
-

src/generateCommitMessageFromGitDiff.ts

@@ -1,31 +1,25 @@
-import {
-  ChatCompletionRequestMessage,
-  ChatCompletionRequestMessageRoleEnum
-} from 'openai';
-
+import { OpenAI } from 'openai';
 import { DEFAULT_TOKEN_LIMITS, getConfig } from './commands/config';
 import { getMainCommitPrompt } from './prompts';
+import { getEngine } from './utils/engine';
 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 MAX_TOKENS_INPUT = config.OCO_TOKENS_MAX_INPUT;
+const MAX_TOKENS_OUTPUT = config.OCO_TOKENS_MAX_OUTPUT;
 
 const generateCommitMessageChatCompletionPrompt = async (
   diff: string,
-  fullGitMojiSpec: boolean
-): Promise<Array<ChatCompletionRequestMessage>> => {
-  const INIT_MESSAGES_PROMPT = await getMainCommitPrompt(fullGitMojiSpec);
+  fullGitMojiSpec: boolean,
+  context: string
+): Promise<Array<OpenAI.Chat.Completions.ChatCompletionMessageParam>> => {
+  const INIT_MESSAGES_PROMPT = await getMainCommitPrompt(fullGitMojiSpec, context);
 
   const chatContextAsCompletionRequest = [...INIT_MESSAGES_PROMPT];
 
   chatContextAsCompletionRequest.push({
-    role: ChatCompletionRequestMessageRoleEnum.User,
+    role: 'user',
     content: diff
   });
 
@@ -43,10 +37,14 @@ const ADJUSTMENT_FACTOR = 20;
 
 export const generateCommitMessageByDiff = async (
   diff: string,
-  fullGitMojiSpec: boolean
+  fullGitMojiSpec: boolean = false,
+  context: string = ""
 ): Promise<string> => {
   try {
-    const INIT_MESSAGES_PROMPT = await getMainCommitPrompt(fullGitMojiSpec);
+    const INIT_MESSAGES_PROMPT = await getMainCommitPrompt(
+      fullGitMojiSpec,
+      context
+    );
 
     const INIT_MESSAGES_PROMPT_LENGTH = INIT_MESSAGES_PROMPT.map(
       (msg) => tokenCount(msg.content as string) + 4
@@ -76,7 +74,8 @@ export const generateCommitMessageByDiff = async (
 
     const messages = await generateCommitMessageChatCompletionPrompt(
       diff,
-      fullGitMojiSpec
+      fullGitMojiSpec,
+      context,
     );
 
     const engine = getEngine();
@@ -181,7 +180,7 @@ export const getCommitMsgsPromisesFromFileDiffs = async (
   // merge multiple files-diffs into 1 prompt to save tokens
   const mergedFilesDiffs = mergeDiffs(diffByFiles, maxDiffLength);
 
-  const commitMessagePromises = [] as Promise<string | undefined>[];
+  const commitMessagePromises = [] as Promise<string | null | undefined>[];
 
   for (const fileDiff of mergedFilesDiffs) {
     if (tokenCount(fileDiff) >= maxDiffLength) {

src/github-action.ts

@@ -1,11 +1,9 @@
-import { unlinkSync, writeFileSync } from 'fs';
-
 import core from '@actions/core';
 import exec from '@actions/exec';
 import github from '@actions/github';
 import { intro, outro } from '@clack/prompts';
 import { PushEvent } from '@octokit/webhooks-types';
-
+import { unlinkSync, writeFileSync } from 'fs';
 import { generateCommitMessageByDiff } from './generateCommitMessageFromGitDiff';
 import { randomIntFromInterval } from './utils/randomIntFromInterval';
 import { sleep } from './utils/sleep';
@@ -54,7 +52,7 @@ async function improveMessagesInChunks(diffsAndSHAs: DiffAndSHA[]) {
   const chunkSize = diffsAndSHAs!.length % 2 === 0 ? 4 : 3;
   outro(`Improving commit messages in chunks of ${chunkSize}.`);
   const improvePromises = diffsAndSHAs!.map((commit) =>
-    generateCommitMessageByDiff(commit.diff)
+    generateCommitMessageByDiff(commit.diff, false)
   );
 
   let improvedMessagesAndSHAs: MsgAndSHA[] = [];

src/i18n/cs.json

@@ -2,5 +2,7 @@
   "localLanguage": "česky",
   "commitFix": "fix(server.ts): zlepšení velikosti proměnné port na velká písmena PORT",
   "commitFeat": "feat(server.ts): přidání podpory pro proměnnou prostředí process.env.PORT",
-  "commitDescription": "Proměnná port se nyní jmenuje PORT, což odpovídá konvenci pojmenování, protože PORT je konstanta. Podpora proměnné prostředí process.env.PORT umožňuje snadnější správu nastavení při spuštění."
+  "commitDescription": "Proměnná port se nyní jmenuje PORT, což odpovídá konvenci pojmenování, protože PORT je konstanta. Podpora proměnné prostředí process.env.PORT umožňuje snadnější správu nastavení při spuštění.",
+  "commitFixOmitScope": "fix: zlepšení velikosti proměnné port na velká písmena PORT",
+  "commitFeatOmitScope": "feat: přidání podpory pro proměnnou prostředí process.env.PORT"
 }

src/i18n/de.json

@@ -2,5 +2,7 @@
   "localLanguage": "Deutsch",
   "commitFix": "fix(server.ts): Ändere die Groß- und Kleinschreibung der Port-Variable von Kleinbuchstaben auf Großbuchstaben PORT.",
   "commitFeat": "Funktion(server.ts): Unterstützung für die Umgebungsvariable process.env.PORT hinzufügen",
-  "commitDescription": "Die Port-Variable heißt jetzt PORT, was die Konsistenz mit den Namenskonventionen verbessert, da PORT eine Konstante ist. Die Unterstützung für eine Umgebungsvariable ermöglicht es der Anwendung, flexibler zu sein, da sie jetzt auf jedem verfügbaren Port laufen kann, der über die Umgebungsvariable process.env.PORT angegeben wird."
+  "commitDescription": "Die Port-Variable heißt jetzt PORT, was die Konsistenz mit den Namenskonventionen verbessert, da PORT eine Konstante ist. Die Unterstützung für eine Umgebungsvariable ermöglicht es der Anwendung, flexibler zu sein, da sie jetzt auf jedem verfügbaren Port laufen kann, der über die Umgebungsvariable process.env.PORT angegeben wird.",
+  "commitFixOmitScope": "fix: Ändere die Groß- und Kleinschreibung der Port-Variable von Kleinbuchstaben auf Großbuchstaben PORT.",
+  "commitFeatOmitScope": "Funktion: Unterstützung für die Umgebungsvariable process.env.PORT hinzufügen"
 }

src/i18n/en.json

@@ -2,5 +2,7 @@
   "localLanguage": "english",
   "commitFix": "fix(server.ts): change port variable case from lowercase port to uppercase PORT to improve semantics",
   "commitFeat": "feat(server.ts): add support for process.env.PORT environment variable to be able to run app on a configurable port",
-  "commitDescription": "The port variable is now named PORT, which improves consistency with the naming conventions as PORT is a constant. Support for an environment variable allows the application to be more flexible as it can now run on any available port specified via the process.env.PORT environment variable."
+  "commitDescription": "The port variable is now named PORT, which improves consistency with the naming conventions as PORT is a constant. Support for an environment variable allows the application to be more flexible as it can now run on any available port specified via the process.env.PORT environment variable.",
+  "commitFixOmitScope": "fix: change port variable case from lowercase port to uppercase PORT to improve semantics",
+  "commitFeatOmitScope": "feat: add support for process.env.PORT environment variable to be able to run app on a configurable port"
 }

src/i18n/es_ES.json

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

src/i18n/fr.json

@@ -2,5 +2,7 @@
   "localLanguage": "française",
   "commitFix": "corriger(server.ts) : changer la casse de la variable de port de minuscules à majuscules (PORT)",
   "commitFeat": "fonctionnalité(server.ts) : ajouter la prise en charge de la variable d'environnement process.env.PORT",
-  "commitDescription": "La variable de port est maintenant nommée PORT, ce qui améliore la cohérence avec les conventions de nommage car PORT est une constante. La prise en charge d'une variable d'environnement permet à l'application d'être plus flexible car elle peut maintenant s'exécuter sur n'importe quel port disponible spécifié via la variable d'environnement process.env.PORT."
+  "commitDescription": "La variable de port est maintenant nommée PORT, ce qui améliore la cohérence avec les conventions de nommage car PORT est une constante. La prise en charge d'une variable d'environnement permet à l'application d'être plus flexible car elle peut maintenant s'exécuter sur n'importe quel port disponible spécifié via la variable d'environnement process.env.PORT.",
+  "commitFixOmitScope": "corriger : changer la casse de la variable de port de minuscules à majuscules (PORT)",
+  "commitFeatOmitScope": "fonctionnalité : ajouter la prise en charge de la variable d'environnement process.env.PORT"
 }

src/i18n/id_ID.json

@@ -2,5 +2,7 @@
   "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"
+  "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",
+  "commitFixOmitScope": "fix: mengubah huruf port variable dari huruf kecil ke huruf besar PORT",
+  "commitFeatOmitScope": "feat: menambahkan support di process.env.PORT environment variabel"
 }

src/i18n/it.json

@@ -2,5 +2,7 @@
   "localLanguage": "italiano",
   "commitFix": "fix(server.ts): cambia la grafia della variabile della porta dal minuscolo port al maiuscolo PORT",
   "commitFeat": "feat(server.ts): aggiunge il supporto per la variabile di ambiente process.env.PORT",
-  "commitDescription": "La variabile port è ora chiamata PORT, migliorando la coerenza con le convenzioni di denominazione in quanto PORT è una costante. Il supporto per una variabile di ambiente consente all'applicazione di essere più flessibile poiché ora può essere eseguita su qualsiasi porta disponibile specificata tramite la variabile di ambiente process.env.PORT."
+  "commitDescription": "La variabile port è ora chiamata PORT, migliorando la coerenza con le convenzioni di denominazione in quanto PORT è una costante. Il supporto per una variabile di ambiente consente all'applicazione di essere più flessibile poiché ora può essere eseguita su qualsiasi porta disponibile specificata tramite la variabile di ambiente process.env.PORT.",
+  "commitFixOmitScope": "fix: cambia la grafia della variabile della porta dal minuscolo port al maiuscolo PORT",
+  "commitFeatOmitScope": "feat: aggiunge il supporto per la variabile di ambiente process.env.PORT"
 }

src/i18n/ja.json

@@ -2,5 +2,7 @@
   "localLanguage": "日本語",
   "commitFix": "修正(server.ts): ポート変数を小文字のportから大文字のPORTに変更",
   "commitFeat": "新機能(server.ts): 環境変数process.env.PORTのサポートを追加",
-  "commitDescription": "ポート変数は現在PORTという名前になり、定数であるPORTを使うことで命名規則に一貫性が生まれました。環境変数をサポートすることで、環境変数process.env.PORTで指定された任意の利用可能なポートで実行できるようになり、アプリケーションはより柔軟になりました。"
+  "commitDescription": "ポート変数は現在PORTという名前になり、定数であるPORTを使うことで命名規則に一貫性が生まれました。環境変数をサポートすることで、環境変数process.env.PORTで指定された任意の利用可能なポートで実行できるようになり、アプリケーションはより柔軟になりました。",
+  "commitFixOmitScope": "修正: ポート変数を小文字のportから大文字のPORTに変更",
+  "commitFeatOmitScope": "新機能: 環境変数process.env.PORTのサポートを追加"
 }

src/i18n/ko.json

@@ -2,5 +2,7 @@
   "localLanguage": "한국어",
   "commitFix": "fix(server.ts): 포트 변수를 소문자 port에서 대문자 PORT로 변경",
   "commitFeat": "피트(server.ts): process.env.PORT 환경 변수 지원 추가",
-  "commitDescription": "포트 변수는 이제 PORT로 이름이 지정되어 상수인 PORT와 일관성 있는 이름 규칙을 따릅니다. 환경 변수 지원을 통해 애플리케이션은 이제 process.env.PORT 환경 변수로 지정된 사용 가능한 모든 포트에서 실행할 수 있으므로 더 유연해졌습니다."
+  "commitDescription": "포트 변수는 이제 PORT로 이름이 지정되어 상수인 PORT와 일관성 있는 이름 규칙을 따릅니다. 환경 변수 지원을 통해 애플리케이션은 이제 process.env.PORT 환경 변수로 지정된 사용 가능한 모든 포트에서 실행할 수 있으므로 더 유연해졌습니다.",
+  "commitFixOmitScope": "fix: 포트 변수를 소문자 port에서 대문자 PORT로 변경",
+  "commitFeatOmitScope": "피트: process.env.PORT 환경 변수 지원 추가"
 }

src/i18n/nl.json

@@ -2,5 +2,7 @@
   "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."
+  "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.",
+  "commitFixOmitScope": "fix: verander poortvariabele van kleine letters poort naar hoofdletters PORT",
+  "commitFeatOmitScope": "feat: voeg ondersteuning toe voor process.env.PORT omgevingsvariabele"
 }

src/i18n/pl.json

@@ -2,5 +2,7 @@
   "localLanguage": "polski",
   "commitFix": "fix(server.ts): poprawa wielkości zmiennej port na pisane z dużymi literami PORT",
   "commitFeat": "feat(server.ts): dodanie obsługi zmiennej środowiskowej process.env.PORT",
-  "commitDescription": "Zmienna port jest teraz nazwana PORT, co jest zgodne z konwencją nazewniczą ponieważ PORT jest stałą. Obsługa zmiennej środowiskowej process.env.PORT pozwala łatwiej zarządzać ustawieniami przy starcie."
+  "commitDescription": "Zmienna port jest teraz nazwana PORT, co jest zgodne z konwencją nazewniczą ponieważ PORT jest stałą. Obsługa zmiennej środowiskowej process.env.PORT pozwala łatwiej zarządzać ustawieniami przy starcie.",
+  "commitFixOmitScope": "fix: poprawa wielkości zmiennej port na pisane z dużymi literami PORT",
+  "commitFeatOmitScope": "feat: dodanie obsługi zmiennej środowiskowej process.env.PORT"
 }

src/i18n/pt_br.json

@@ -2,5 +2,7 @@
   "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."
+  "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.",
+  "commitFixOmitScope": "fix: altera o caso da variável de porta de port minúscula para PORT maiúscula",
+  "commitFeatOmitScope": "feat: adiciona suporte para a variável de ambiente process.env.PORT"
 }

src/i18n/ru.json

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

src/i18n/sv.json

@@ -2,5 +2,7 @@
   "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."
+  "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.",
+  "commitFixOmitScope": "fixa: ändra variabelnamnet för port från små bokstäver till stora bokstäver PORT",
+  "commitFeatOmitScope": "nyhet: lägg till stöd för process.env.PORT miljövariabel"
 }

src/i18n/th.json

@@ -2,5 +2,7 @@
   "localLanguage": "ไทย",
   "commitFix": "fix(server.ts): เปลี่ยนตัวพิมพ์ของตัวแปร จากตัวพิมพ์เล็ก port เป็นตัวพิมพ์ใหญ่ PORT",
   "commitFeat": "feat(server.ts): เพิ่มการรองรับสำหรับตัวแปรสภาพแวดล้อม process.env.PORT",
-  "commitDescription": "ตอนนี้ตัวแปรพอร์ตมีชื่อว่า PORT, ซึ่งปรับปรุงความสอดคล้องกับหลักการตั้งชื่อเนื่องจาก PORT เป็นค่าคงที่. การสนับสนุนสำหรับตัวแปรสภาพแวดล้อม ช่วยให้แอปพลิเคชันมีความยืดหยุ่นมากขึ้นเนื่องจาก สามารถทำงานบนพอร์ตใด ๆ ตามที่กำหนด ซึ่งระบุผ่านตัวแปรสภาพแวดล้อม process.env.PORT"
+  "commitDescription": "ตอนนี้ตัวแปรพอร์ตมีชื่อว่า PORT, ซึ่งปรับปรุงความสอดคล้องกับหลักการตั้งชื่อเนื่องจาก PORT เป็นค่าคงที่. การสนับสนุนสำหรับตัวแปรสภาพแวดล้อม ช่วยให้แอปพลิเคชันมีความยืดหยุ่นมากขึ้นเนื่องจาก สามารถทำงานบนพอร์ตใด ๆ ตามที่กำหนด ซึ่งระบุผ่านตัวแปรสภาพแวดล้อม process.env.PORT",
+  "commitFixOmitScope": "fix: เปลี่ยนตัวพิมพ์ของตัวแปร จากตัวพิมพ์เล็ก port เป็นตัวพิมพ์ใหญ่ PORT",
+  "commitFeatOmitScope": "feat: เพิ่มการรองรับสำหรับตัวแปรสภาพแวดล้อม process.env.PORT"
 }

src/i18n/tr.json

@@ -2,5 +2,7 @@
   "localLanguage": "Turkish",
   "commitFix": "fix(server.ts): port değişkeni küçük harfli porttan büyük harfli PORT'a değiştirildi",
   "commitFeat": "feat(server.ts): process.env.PORT ortam değişkeni için destek eklendi.",
-  "commitDescription": "Bağlantı noktası değişkeni artık PORT olarak adlandırıldı ve PORT bir sabit değişken olduğu için bu adlandırma tutarlılığı artırır. Ortam değişkeni desteği, artık process.env.PORT ortam değişkeni aracılığıyla belirtilen herhangi bir kullanılabilir bağlantı noktasında çalışabileceğinden uygulamanın daha esnek olmasını sağlar."
+  "commitDescription": "Bağlantı noktası değişkeni artık PORT olarak adlandırıldı ve PORT bir sabit değişken olduğu için bu adlandırma tutarlılığı artırır. Ortam değişkeni desteği, artık process.env.PORT ortam değişkeni aracılığıyla belirtilen herhangi bir kullanılabilir bağlantı noktasında çalışabileceğinden uygulamanın daha esnek olmasını sağlar.",
+  "commitFixOmitScope": "fix: port değişkeni küçük harfli porttan büyük harfli PORT'a değiştirildi",
+  "commitFeatOmitScope": "feat: process.env.PORT ortam değişkeni için destek eklendi."
 }

src/i18n/vi_VN.json

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

src/i18n/zh_CN.json

@@ -2,5 +2,7 @@
   "localLanguage": "简体中文",
   "commitFix": "fix(server.ts)：将端口变量从小写port改为大写PORT",
   "commitFeat": "feat(server.ts)：添加对process.env.PORT环境变量的支持",
-  "commitDescription": "现在端口变量被命名为PORT，这提高了命名约定的一致性，因为PORT是一个常量。环境变量的支持使应用程序更加灵活，因为它现在可以通过process.env.PORT环境变量在任何可用端口上运行。"
+  "commitDescription": "现在端口变量被命名为PORT，这提高了命名约定的一致性，因为PORT是一个常量。环境变量的支持使应用程序更加灵活，因为它现在可以通过process.env.PORT环境变量在任何可用端口上运行。",
+  "commitFixOmitScope": "fix：将端口变量从小写port改为大写PORT",
+  "commitFeatOmitScope": "feat：添加对process.env.PORT环境变量的支持"
 }

src/i18n/zh_TW.json

@@ -2,5 +2,7 @@
   "localLanguage": "繁體中文",
   "commitFix": "修正(server.ts)：將端口變數從小寫端口改為大寫PORT",
   "commitFeat": "功能(server.ts)：新增對process.env.PORT環境變數的支援",
-  "commitDescription": "現在port變數已更名為PORT，以符合命名慣例，因為PORT是一個常量。支援環境變數可以使應用程序更靈活，因為它現在可以通過process.env.PORT環境變數運行在任何可用端口上。"
+  "commitDescription": "現在port變數已更名為PORT，以符合命名慣例，因為PORT是一個常量。支援環境變數可以使應用程序更靈活，因為它現在可以通過process.env.PORT環境變數運行在任何可用端口上。",
+  "commitFixOmitScope": "修正：將端口變數從小寫端口改為大寫PORT",
+  "commitFeatOmitScope": "功能：新增對process.env.PORT環境變數的支援"
 }

src/migrations/00_use_single_api_key_and_url.ts

@@ -0,0 +1,45 @@
+import {
+  CONFIG_KEYS,
+  getConfig,
+  OCO_AI_PROVIDER_ENUM,
+  setConfig
+} from '../commands/config';
+
+export default function () {
+  const config = getConfig({ setDefaultValues: false });
+
+  const aiProvider = config.OCO_AI_PROVIDER;
+
+  let apiKey: string | undefined;
+  let apiUrl: string | undefined;
+
+  if (aiProvider === OCO_AI_PROVIDER_ENUM.OLLAMA) {
+    apiKey = config['OCO_OLLAMA_API_KEY'];
+    apiUrl = config['OCO_OLLAMA_API_URL'];
+  } else if (aiProvider === OCO_AI_PROVIDER_ENUM.ANTHROPIC) {
+    apiKey = config['OCO_ANTHROPIC_API_KEY'];
+    apiUrl = config['OCO_ANTHROPIC_BASE_PATH'];
+  } else if (aiProvider === OCO_AI_PROVIDER_ENUM.OPENAI) {
+    apiKey = config['OCO_OPENAI_API_KEY'];
+    apiUrl = config['OCO_OPENAI_BASE_PATH'];
+  } else if (aiProvider === OCO_AI_PROVIDER_ENUM.AZURE) {
+    apiKey = config['OCO_AZURE_API_KEY'];
+    apiUrl = config['OCO_AZURE_ENDPOINT'];
+  } else if (aiProvider === OCO_AI_PROVIDER_ENUM.GEMINI) {
+    apiKey = config['OCO_GEMINI_API_KEY'];
+    apiUrl = config['OCO_GEMINI_BASE_PATH'];
+  } else if (aiProvider === OCO_AI_PROVIDER_ENUM.FLOWISE) {
+    apiKey = config['OCO_FLOWISE_API_KEY'];
+    apiUrl = config['OCO_FLOWISE_ENDPOINT'];
+  } else {
+    throw new Error(
+      `Migration failed, set AI provider first. Run "oco config set OCO_AI_PROVIDER=<provider>", where <provider> is one of: ${Object.values(
+        OCO_AI_PROVIDER_ENUM
+      ).join(', ')}`
+    );
+  }
+
+  if (apiKey) setConfig([[CONFIG_KEYS.OCO_API_KEY, apiKey]]);
+
+  if (apiUrl) setConfig([[CONFIG_KEYS.OCO_API_URL, apiUrl]]);
+}

src/migrations/01_remove_obsolete_config_keys_from_global_file.ts

@@ -0,0 +1,26 @@
+import { getGlobalConfig, setGlobalConfig } from '../commands/config';
+
+export default function () {
+  const obsoleteKeys = [
+    'OCO_OLLAMA_API_KEY',
+    'OCO_OLLAMA_API_URL',
+    'OCO_ANTHROPIC_API_KEY',
+    'OCO_ANTHROPIC_BASE_PATH',
+    'OCO_OPENAI_API_KEY',
+    'OCO_OPENAI_BASE_PATH',
+    'OCO_AZURE_API_KEY',
+    'OCO_AZURE_ENDPOINT',
+    'OCO_GEMINI_API_KEY',
+    'OCO_GEMINI_BASE_PATH',
+    'OCO_FLOWISE_API_KEY',
+    'OCO_FLOWISE_ENDPOINT'
+  ];
+
+  const globalConfig = getGlobalConfig();
+
+  const configToOverride = { ...globalConfig };
+
+  for (const key of obsoleteKeys) delete configToOverride[key];
+
+  setGlobalConfig(configToOverride);
+}

src/migrations/02_set_missing_default_values.ts

@@ -0,0 +1,22 @@
+import {
+  ConfigType,
+  DEFAULT_CONFIG,
+  getGlobalConfig,
+  setConfig
+} from '../commands/config';
+
+export default function () {
+  const setDefaultConfigValues = (config: ConfigType) => {
+    const entriesToSet: [key: string, value: string | boolean | number][] = [];
+    for (const entry of Object.entries(DEFAULT_CONFIG)) {
+      const [key, _value] = entry;
+      if (config[key] === 'undefined' || config[key] === undefined)
+        entriesToSet.push(entry);
+    }
+
+    if (entriesToSet.length > 0) setConfig(entriesToSet);
+    console.log(entriesToSet);
+  };
+
+  setDefaultConfigValues(getGlobalConfig());
+}

src/migrations/_migrations.ts

@@ -0,0 +1,18 @@
+import migration00 from './00_use_single_api_key_and_url';
+import migration01 from './01_remove_obsolete_config_keys_from_global_file';
+import migration02 from './02_set_missing_default_values';
+
+export const migrations = [
+  {
+    name: '00_use_single_api_key_and_url',
+    run: migration00
+  },
+  {
+    name: '01_remove_obsolete_config_keys_from_global_file',
+    run: migration01
+  },
+  {
+    name: '02_set_missing_default_values',
+    run: migration02
+  }
+];

src/migrations/_run.ts

@@ -0,0 +1,71 @@
+import fs from 'fs';
+import { homedir } from 'os';
+import { join as pathJoin } from 'path';
+import { migrations } from './_migrations';
+import { outro } from '@clack/prompts';
+import chalk from 'chalk';
+import {
+  getConfig,
+  getIsGlobalConfigFileExist,
+  OCO_AI_PROVIDER_ENUM
+} from '../commands/config';
+
+const migrationsFile = pathJoin(homedir(), '.opencommit_migrations');
+
+const getCompletedMigrations = (): string[] => {
+  if (!fs.existsSync(migrationsFile)) {
+    return [];
+  }
+  const data = fs.readFileSync(migrationsFile, 'utf-8');
+  return data ? JSON.parse(data) : [];
+};
+
+const saveCompletedMigration = (migrationName: string) => {
+  const completedMigrations = getCompletedMigrations();
+  completedMigrations.push(migrationName);
+  fs.writeFileSync(
+    migrationsFile,
+    JSON.stringify(completedMigrations, null, 2)
+  );
+};
+
+export const runMigrations = async () => {
+  // if no config file, we assume it's a new installation and no migrations are needed
+  if (!getIsGlobalConfigFileExist()) return;
+
+  const config = getConfig();
+  if (config.OCO_AI_PROVIDER === OCO_AI_PROVIDER_ENUM.TEST) return;
+
+  const completedMigrations = getCompletedMigrations();
+
+  let isMigrated = false;
+
+  for (const migration of migrations) {
+    if (!completedMigrations.includes(migration.name)) {
+      try {
+        console.log('Applying migration', migration.name);
+        migration.run();
+        console.log('Migration applied successfully', migration.name);
+        saveCompletedMigration(migration.name);
+      } catch (error) {
+        outro(
+          `${chalk.red('Failed to apply migration')} ${
+            migration.name
+          }: ${error}`
+        );
+        process.exit(1);
+      }
+
+      isMigrated = true;
+    }
+  }
+
+  if (isMigrated) {
+    outro(
+      `${chalk.green(
+        '✔'
+      )} Migrations to your config were applied successfully. Please rerun.`
+    );
+    process.exit(0);
+  }
+};

src/modules/commitlint/config.ts

@@ -2,16 +2,16 @@ import { spinner } from '@clack/prompts';
 
 import { getConfig } from '../../commands/config';
 import { i18n, I18nLocals } from '../../i18n';
+import { getEngine } from '../../utils/engine';
 import { COMMITLINT_LLM_CONFIG_PATH } from './constants';
 import { computeHash } from './crypto';
 import { commitlintPrompts, inferPromptsFromCommitlintConfig } from './prompts';
 import { getCommitLintPWDConfig } from './pwd-commitlint';
 import { CommitlintLLMConfig } from './types';
 import * as utils from './utils';
-import { getEngine } from '../../utils/engine';
 
 const config = getConfig();
-const translation = i18n[(config?.OCO_LANGUAGE as I18nLocals) || 'en'];
+const translation = i18n[(config.OCO_LANGUAGE as I18nLocals) || 'en'];
 
 export const configureCommitlintIntegration = async (force = false) => {
   const spin = spinner();
@@ -26,7 +26,7 @@ export const configureCommitlintIntegration = async (force = false) => {
       * @commitlint >= 9.0.0 is installed in the local directory.
       * 'node_modules/@commitlint/load' package exists.
       * A valid @commitlint configuration exists.
-      `,
+      `
     );
   }
 
@@ -53,7 +53,7 @@ export const configureCommitlintIntegration = async (force = false) => {
 
   spin.start('Generating consistency with given @commitlint rules');
 
-  const prompts = inferPromptsFromCommitlintConfig(commitLintConfig);
+  const prompts = inferPromptsFromCommitlintConfig(commitLintConfig as any);
 
   const consistencyPrompts =
     commitlintPrompts.GEN_COMMITLINT_CONSISTENCY_PROMPT(prompts);

src/modules/commitlint/prompts.ts

@@ -1,8 +1,5 @@
 import chalk from 'chalk';
-import {
-  ChatCompletionRequestMessage,
-  ChatCompletionRequestMessageRoleEnum
-} from 'openai';
+import { OpenAI } from 'openai';
 
 import { outro } from '@clack/prompts';
 import {
@@ -17,7 +14,7 @@ import { i18n, I18nLocals } from '../../i18n';
 import { IDENTITY, INIT_DIFF_PROMPT } from '../../prompts';
 
 const config = getConfig();
-const translation = i18n[(config?.OCO_LANGUAGE as I18nLocals) || 'en'];
+const translation = i18n[(config.OCO_LANGUAGE as I18nLocals) || 'en'];
 
 type DeepPartial<T> = {
   [P in keyof T]?: {
@@ -59,30 +56,28 @@ const llmReadableRules: {
   blankline: (key, applicable) =>
     `There should ${applicable} be a blank line at the beginning of the ${key}.`,
   caseRule: (key, applicable, value: string | Array<string>) =>
-    `The ${key} should ${applicable} be in ${
-      Array.isArray(value)
-        ? `one of the following case: 
+    `The ${key} should ${applicable} be in ${Array.isArray(value)
+      ? `one of the following case:
   - ${value.join('\n  - ')}.`
-        : `${value} case.`
+      : `${value} case.`
     }`,
   emptyRule: (key, applicable) => `The ${key} should ${applicable} be empty.`,
   enumRule: (key, applicable, value: string | Array<string>) =>
-    `The ${key} should ${applicable} be one of the following values: 
+    `The ${key} should ${applicable} be one of the following values:
   - ${Array.isArray(value) ? value.join('\n  - ') : value}.`,
   enumTypeRule: (key, applicable, value: string | Array<string>, prompt) =>
-    `The ${key} should ${applicable} be one of the following values: 
-  - ${
-    Array.isArray(value)
+    `The ${key} should ${applicable} be one of the following values:
+  - ${Array.isArray(value)
       ? value
-          .map((v) => {
-            const description = getTypeRuleExtraDescription(v, prompt);
-            if (description) {
-              return `${v} (${description})`;
-            } else return v;
-          })
-          .join('\n  - ')
+        .map((v) => {
+          const description = getTypeRuleExtraDescription(v, prompt);
+          if (description) {
+            return `${v} (${description})`;
+          } else return v;
+        })
+        .join('\n  - ')
       : value
-  }.`,
+    }.`,
   fullStopRule: (key, applicable, value: string) =>
     `The ${key} should ${applicable} end with '${value}'.`,
   maxLengthRule: (key, applicable, value: string) =>
@@ -207,25 +202,28 @@ export const inferPromptsFromCommitlintConfig = (
  * ubiquitous language from @commitlint.
  * While gpt-4 does this on it self, gpt-3.5 can't map this on his own atm.
  */
-const STRUCTURE_OF_COMMIT = `
+const STRUCTURE_OF_COMMIT = config.OCO_OMIT_SCOPE
+  ? `
+- Header of commit is composed of type and subject: <type-of-commit>: <subject-of-commit>
+- Description of commit is composed of body and footer (optional): <body-of-commit>\n<footer(s)-of-commit>`
+  : `
 - Header of commit is composed of type, scope, subject: <type-of-commit>(<scope-of-commit>): <subject-of-commit>
 - Description of commit is composed of body and footer (optional): <body-of-commit>\n<footer(s)-of-commit>`;
 
 // Prompt to generate LLM-readable rules based on @commitlint rules.
 const GEN_COMMITLINT_CONSISTENCY_PROMPT = (
   prompts: string[]
-): ChatCompletionRequestMessage[] => [
-  {
-    role: ChatCompletionRequestMessageRoleEnum.Assistant,
-    // prettier-ignore
-    content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages for two different changes in a single codebase and output them in the provided JSON format: one for a bug fix and another for a new feature. 
+): OpenAI.Chat.Completions.ChatCompletionMessageParam[] => [
+    {
+      role: 'system',
+      content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages for two different changes in a single codebase and output them in the provided JSON format: one for a bug fix and another for a new feature.
 
 Here are the specific requirements and conventions that should be strictly followed:
 
 Commit Message Conventions:
 - The commit message consists of three parts: Header, Body, and Footer.
-- Header: 
-  - Format: \`<type>(<scope>): <subject>\`
+- Header:
+  - Format: ${config.OCO_OMIT_SCOPE ? '`<type>: <subject>`' : '`<type>(<scope>): <subject>`'}
 - ${prompts.join('\n- ')}
 
 JSON Output Format:
@@ -233,22 +231,24 @@ JSON Output Format:
 \`\`\`json
 {
   "localLanguage": "${translation.localLanguage}",
-  "commitFix": "<Header of commit for bug fix>",
-  "commitFeat": "<Header of commit for feature>",
+  "commitFix": "<Header of commit for bug fix with scope>",
+  "commitFeat": "<Header of commit for feature with scope>",
+  "commitFixOmitScope": "<Header of commit for bug fix without scope>",
+  "commitFeatOmitScope": "<Header of commit for feature without scope>",
   "commitDescription": "<Description of commit for both the bug fix and the feature>"
 }
 \`\`\`
-- The "commitDescription" should not include the commit message’s header, only the description.
+- The "commitDescription" should not include the commit message's header, only the description.
 - Description should not be more than 74 characters.
 
 Additional Details:
-- Changing the variable 'port' to uppercase 'PORT' is considered a bug fix. 
-- Allowing the server to listen on a port specified through the environment variable is considered a new feature. 
+- Changing the variable 'port' to uppercase 'PORT' is considered a bug fix.
+- Allowing the server to listen on a port specified through the environment variable is considered a new feature.
 
 Example Git Diff is to follow:`
-  },
-  INIT_DIFF_PROMPT
-];
+    },
+    INIT_DIFF_PROMPT
+  ];
 
 /**
  * Prompt to have LLM generate a message using @commitlint rules.
@@ -260,22 +260,32 @@ Example Git Diff is to follow:`
 const INIT_MAIN_PROMPT = (
   language: string,
   prompts: string[]
-): ChatCompletionRequestMessage => ({
-  role: ChatCompletionRequestMessageRoleEnum.System,
-  // prettier-ignore
-  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages in the given @commitlint convention and explain WHAT were the changes and WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you convert it into a commit message.
-${config?.OCO_EMOJI ? 'Use GitMoji convention to preface the commit.' : 'Do not preface the commit with anything.'}
-${config?.OCO_DESCRIPTION ? 'Add a short description of WHY the changes are done after the commit message. Don\'t start it with "This commit", just describe the changes.' : "Don't add any descriptions to the commit, only commit message."}
+): OpenAI.Chat.Completions.ChatCompletionMessageParam => ({
+  role: 'system',
+  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages in the given @commitlint convention and explain WHAT were the changes ${config.OCO_WHY ? 'and WHY the changes were done' : ''
+    }. I'll send you an output of 'git diff --staged' command, and you convert it into a commit message.
+${config.OCO_EMOJI
+      ? 'Use GitMoji convention to preface the commit.'
+      : 'Do not preface the commit with anything.'
+    }
+${config.OCO_DESCRIPTION
+      ? 'Add a short description of WHY the changes are done after the commit message. Don\'t start it with "This commit", just describe the changes.'
+      : "Don't add any descriptions to the commit, only commit message."
+    }
 Use the present tense. 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.' : ""}
-    
+${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.'
+      : ''
+    }
+${config.OCO_OMIT_SCOPE
+      ? 'Do not include a scope in the commit message format. Use the format: <type>: <subject>'
+      : ''
+    }
 You will strictly follow the following conventions to generate the content of the commit message:
 - ${prompts.join('\n- ')}
 
 The conventions refers to the following structure of commit message:
-${STRUCTURE_OF_COMMIT}
-    
-    `
+${STRUCTURE_OF_COMMIT}`
 });
 
 export const commitlintPrompts = {

src/modules/commitlint/pwd-commitlint.ts

@@ -1,13 +1,30 @@
 import fs from 'fs/promises';
 import path from 'path';
 
+const findModulePath = (moduleName: string) => {
+  const searchPaths = [
+    path.join('node_modules', moduleName),
+    path.join('node_modules', '.pnpm'),
+    path.resolve(__dirname, '../..')
+  ];
+
+  for (const basePath of searchPaths) {
+    try {
+      const resolvedPath = require.resolve(moduleName, { paths: [basePath] });
+      return resolvedPath;
+    } catch {
+      // Continue to the next search path if the module is not found
+    }
+  }
+
+  throw new Error(`Cannot find module ${moduleName}`);
+};
+
 const getCommitLintModuleType = async (): Promise<'cjs' | 'esm'> => {
-  const packageFile = 'node_modules/@commitlint/load/package.json';
-  const packageJsonPath = path.join(
-    process.env.PWD || process.cwd(),
-    packageFile,
-  );
+  const packageFile = '@commitlint/load/package.json';
+  const packageJsonPath = findModulePath(packageFile);
   const packageJson = JSON.parse(await fs.readFile(packageJsonPath, 'utf8'));
+
   if (!packageJson) {
     throw new Error(`Failed to parse ${packageFile}`);
   }
@@ -19,7 +36,7 @@ const getCommitLintModuleType = async (): Promise<'cjs' | 'esm'> => {
  * QualifiedConfig from any version of @commitlint/types
  * @see https://github.com/conventional-changelog/commitlint/blob/master/@commitlint/types/src/load.ts
  */
-type QualifiedConfigOnAnyVersion = { [key:string]: unknown };
+type QualifiedConfigOnAnyVersion = { [key: string]: unknown };
 
 /**
  *  This code is loading the configuration for the `@commitlint` package from the current working
@@ -27,36 +44,31 @@ type QualifiedConfigOnAnyVersion = { [key:string]: unknown };
  *
  * @returns
  */
-export const getCommitLintPWDConfig = async (): Promise<QualifiedConfigOnAnyVersion | null> => {
-  let load, nodeModulesPath;
-  switch (await getCommitLintModuleType()) {
-    case 'cjs':
-      /**
-       * CommonJS (<= commitlint@v18.x.x.)
-       */
-      nodeModulesPath = path.join(
-        process.env.PWD || process.cwd(),
-        'node_modules/@commitlint/load',
-      );
-      load = require(nodeModulesPath).default;
-      break;
-    case 'esm':
-      /**
-       * ES Module (commitlint@v19.x.x. <= )
-       * Directory import is not supported in ES Module resolution, so import the file directly
-       */
-      nodeModulesPath = path.join(
-        process.env.PWD || process.cwd(),
-        'node_modules/@commitlint/load/lib/load.js',
-      );
-      load = (await import(nodeModulesPath)).default;
-      break;
-  }
+export const getCommitLintPWDConfig =
+  async (): Promise<QualifiedConfigOnAnyVersion | null> => {
+    let load: Function, modulePath: string;
+    switch (await getCommitLintModuleType()) {
+      case 'cjs':
+        /**
+         * CommonJS (<= commitlint@v18.x.x.)
+         */
+        modulePath = findModulePath('@commitlint/load');
+        load = require(modulePath).default;
+        break;
+      case 'esm':
+        /**
+         * ES Module (commitlint@v19.x.x. <= )
+         * Directory import is not supported in ES Module resolution, so import the file directly
+         */
+        modulePath = findModulePath('@commitlint/load/lib/load.js');
+        load = (await import(modulePath)).default;
+        break;
+    }
 
-  if (load && typeof load === 'function') {
-    return await load();
-  }
+    if (load && typeof load === 'function') {
+      return await load();
+    }
 
-  // @commitlint/load is not a function
-  return null;
-};
+    // @commitlint/load is not a function
+    return null;
+  };

src/prompts.ts

@@ -1,10 +1,5 @@
-import {
-  ChatCompletionRequestMessage,
-  ChatCompletionRequestMessageRoleEnum
-} from 'openai';
-
 import { note } from '@clack/prompts';
-
+import { OpenAI } from 'openai';
 import { getConfig } from './commands/config';
 import { i18n, I18nLocals } from './i18n';
 import { configureCommitlintIntegration } from './modules/commitlint/config';
@@ -14,117 +9,154 @@ import * as utils from './modules/commitlint/utils';
 import { removeConventionalCommitWord } from './utils/removeConventionalCommitWord';
 
 const config = getConfig();
-const translation = i18n[(config?.OCO_LANGUAGE as I18nLocals) || 'en'];
+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.';
+  'You are to act as an author of a commit message in git.';
+
+const GITMOJI_HELP = `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;`;
+
+const FULL_GITMOJI_SPEC = `${GITMOJI_HELP}
+🎨, 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.`;
+
+const CONVENTIONAL_COMMIT_KEYWORDS =
+  'Do not preface the commit with anything, except for the conventional commit keywords: fix, feat, build, chore, ci, docs, style, refactor, perf, test.';
+
+const getCommitConvention = (fullGitMojiSpec: boolean) =>
+  config.OCO_EMOJI
+    ? fullGitMojiSpec
+      ? FULL_GITMOJI_SPEC
+      : GITMOJI_HELP
+    : CONVENTIONAL_COMMIT_KEYWORDS;
+
+const getDescriptionInstruction = () =>
+  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.";
+
+const getOneLineCommitInstruction = () =>
+  config.OCO_ONE_LINE_COMMIT
+    ? 'Craft a concise, single sentence, 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 one single message.'
+    : '';
+
+const getScopeInstruction = () =>
+  config.OCO_OMIT_SCOPE
+    ? 'Do not include a scope in the commit message format. Use the format: <type>: <subject>'
+    : '';
+
+/**
+ * Get the context of the user input
+ * @param extraArgs - The arguments passed to the command line
+ * @example
+ *  $ oco -- This is a context used to generate the commit message
+ * @returns - The context of the user input
+ */
+const userInputCodeContext = (context: string) => {
+  if (context !== '' && context !== ' ') {
+    return `Additional context provided by the user: <context>${context}</context>\nConsider this context when generating the commit message, incorporating relevant information when appropriate.`;
+  }
+  return '';
+};
 
 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 ${
-    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.`
+  fullGitMojiSpec: boolean,
+  context: string
+): OpenAI.Chat.Completions.ChatCompletionMessageParam => ({
+  role: 'system',
+  content: (() => {
+    const commitConvention = fullGitMojiSpec
+      ? 'GitMoji specification'
+      : 'Conventional Commit Convention';
+    const missionStatement = `${IDENTITY} Your mission is to create clean and comprehensive commit messages as per the ${commitConvention} and explain WHAT were the changes and mainly WHY the changes were done.`;
+    const diffInstruction =
+      "I'll send you an output of 'git diff --staged' command, and you are to convert it into a commit message.";
+    const conventionGuidelines = getCommitConvention(fullGitMojiSpec);
+    const descriptionGuideline = getDescriptionInstruction();
+    const oneLineCommitGuideline = getOneLineCommitInstruction();
+    const scopeInstruction = getScopeInstruction();
+    const generalGuidelines = `Use the present tense. Lines must not be longer than 74 characters. Use ${language} for the commit message.`;
+    const userInputContext = userInputCodeContext(context);
+
+    return `${missionStatement}\n${diffInstruction}\n${conventionGuidelines}\n${descriptionGuideline}\n${oneLineCommitGuideline}\n${scopeInstruction}\n${generalGuidelines}\n${userInputContext}`;
+  })()
 });
 
-export const INIT_DIFF_PROMPT: ChatCompletionRequestMessage = {
-  role: ChatCompletionRequestMessageRoleEnum.User,
+export const INIT_DIFF_PROMPT: OpenAI.Chat.Completions.ChatCompletionMessageParam =
+{
+  role: 'user',
   content: `diff --git a/src/server.ts b/src/server.ts
     index ad4db42..f3b18a9 100644
     --- a/src/server.ts
@@ -151,27 +183,54 @@ export const INIT_DIFF_PROMPT: ChatCompletionRequestMessage = {
                 });`
 };
 
+const COMMIT_TYPES = {
+  fix: '🐛',
+  feat: '✨'
+} as const;
+
+const generateCommitString = (
+  type: keyof typeof COMMIT_TYPES,
+  message: string
+): string => {
+  const cleanMessage = removeConventionalCommitWord(message);
+  return config.OCO_EMOJI
+    ? `${COMMIT_TYPES[type]} ${cleanMessage}`
+    : message;
+};
+
+const getConsistencyContent = (translation: ConsistencyPrompt) => {
+  const fixMessage = config.OCO_OMIT_SCOPE && translation.commitFixOmitScope
+    ? translation.commitFixOmitScope
+    : translation.commitFix;
+
+  const featMessage = config.OCO_OMIT_SCOPE && translation.commitFeatOmitScope
+    ? translation.commitFeatOmitScope
+    : translation.commitFeat;
+
+  const fix = generateCommitString('fix', fixMessage);
+  const feat = config.OCO_ONE_LINE_COMMIT
+    ? ''
+    : generateCommitString('feat', featMessage);
+
+  const description = config.OCO_DESCRIPTION
+    ? translation.commitDescription
+    : '';
+
+  return [fix, feat, description].filter(Boolean).join('\n');
+};
+
 const INIT_CONSISTENCY_PROMPT = (
   translation: ConsistencyPrompt
-): ChatCompletionRequestMessage => ({
-  role: ChatCompletionRequestMessageRoleEnum.Assistant,
-  content: `${
-    config?.OCO_EMOJI
-      ? `🐛 ${removeConventionalCommitWord(translation.commitFix)}`
-      : translation.commitFix
-  }
-${
-  config?.OCO_EMOJI
-    ? `✨ ${removeConventionalCommitWord(translation.commitFeat)}`
-    : translation.commitFeat
-}
-${config?.OCO_DESCRIPTION ? translation.commitDescription : ''}`
+): OpenAI.Chat.Completions.ChatCompletionMessageParam => ({
+  role: 'assistant',
+  content: getConsistencyContent(translation)
 });
 
 export const getMainCommitPrompt = async (
-  fullGitMojiSpec: boolean
-): Promise<ChatCompletionRequestMessage[]> => {
-  switch (config?.OCO_PROMPT_MODULE) {
+  fullGitMojiSpec: boolean,
+  context: string
+): Promise<Array<OpenAI.Chat.Completions.ChatCompletionMessageParam>> => {
+  switch (config.OCO_PROMPT_MODULE) {
     case '@commitlint':
       if (!(await utils.commitlintLLMConfigExists())) {
         note(
@@ -191,15 +250,14 @@ export const getMainCommitPrompt = async (
         INIT_DIFF_PROMPT,
         INIT_CONSISTENCY_PROMPT(
           commitLintConfig.consistency[
-            translation.localLanguage
+          translation.localLanguage
           ] as ConsistencyPrompt
         )
       ];
 
     default:
-      // conventional-commit
       return [
-        INIT_MAIN_PROMPT(translation.localLanguage, fullGitMojiSpec),
+        INIT_MAIN_PROMPT(translation.localLanguage, fullGitMojiSpec, context),
         INIT_DIFF_PROMPT,
         INIT_CONSISTENCY_PROMPT(translation)
       ];

src/utils/engine.ts

@@ -1,37 +1,84 @@
+import { getConfig, OCO_AI_PROVIDER_ENUM } from '../commands/config';
+import { AnthropicEngine } from '../engine/anthropic';
+import { AzureEngine } from '../engine/azure';
 import { AiEngine } from '../engine/Engine';
-import { OpenAi } from '../engine/openAi';
-import { Gemini } from '../engine/gemini';
-import { getConfig } from '../commands/config';
-import { OllamaAi } from '../engine/ollama';
-import { AnthropicAi } from '../engine/anthropic'
-import { TestAi } from '../engine/testAi';
-import { Azure } from '../engine/azure';
-import { FlowiseAi } from '../engine/flowise'
+import { FlowiseEngine } from '../engine/flowise';
+import { GeminiEngine } from '../engine/gemini';
+import { OllamaEngine } from '../engine/ollama';
+import { OpenAiEngine } from '../engine/openAi';
+import { MistralAiEngine } from '../engine/mistral';
+import { TestAi, TestMockType } from '../engine/testAi';
+import { GroqEngine } from '../engine/groq';
+import { MLXEngine } from '../engine/mlx';
+import { DeepseekEngine } from '../engine/deepseek';
+
+export function parseCustomHeaders(headers: any): Record<string, string> {
+  let parsedHeaders = {};
+  
+  if (!headers) {
+    return parsedHeaders;
+  }
+  
+  try {
+    if (typeof headers === 'object' && !Array.isArray(headers)) {
+      parsedHeaders = headers;
+    } else {
+      parsedHeaders = JSON.parse(headers);
+    }
+  } catch (error) {
+    console.warn('Invalid OCO_API_CUSTOM_HEADERS format, ignoring custom headers');
+  }
+  
+  return parsedHeaders;
+}
 
 export function getEngine(): AiEngine {
   const config = getConfig();
-  const provider = config?.OCO_AI_PROVIDER;
-  
-  if (provider?.startsWith('ollama')) {
-    const ollamaAi = new OllamaAi();
-    const model = provider.substring('ollama/'.length);
-    if (model) {
-      ollamaAi.setModel(model);
-      ollamaAi.setUrl(config?.OCO_OLLAMA_API_URL);
-    }
-    return ollamaAi;
-  } else if (provider == 'anthropic') {
-    return new AnthropicAi();
-  } else if (provider == 'test') {
-    return new TestAi();
-  } else if (provider == 'gemini') {
-    return new Gemini();  
-  } else if (provider == 'azure') {
-  	return new Azure();
-  } else if( provider == 'flowise'){
-    return new FlowiseAi();
+  const provider = config.OCO_AI_PROVIDER;
+
+  const customHeaders = parseCustomHeaders(config.OCO_API_CUSTOM_HEADERS);
+
+  const DEFAULT_CONFIG = {
+    model: config.OCO_MODEL!,
+    maxTokensOutput: config.OCO_TOKENS_MAX_OUTPUT!,
+    maxTokensInput: config.OCO_TOKENS_MAX_INPUT!,
+    baseURL: config.OCO_API_URL!,
+    apiKey: config.OCO_API_KEY!,
+    customHeaders
+  };
+
+  switch (provider) {
+    case OCO_AI_PROVIDER_ENUM.OLLAMA:
+      return new OllamaEngine(DEFAULT_CONFIG);
+
+    case OCO_AI_PROVIDER_ENUM.ANTHROPIC:
+      return new AnthropicEngine(DEFAULT_CONFIG);
+
+    case OCO_AI_PROVIDER_ENUM.TEST:
+      return new TestAi(config.OCO_TEST_MOCK_TYPE as TestMockType);
+
+    case OCO_AI_PROVIDER_ENUM.GEMINI:
+      return new GeminiEngine(DEFAULT_CONFIG);
+
+    case OCO_AI_PROVIDER_ENUM.AZURE:
+      return new AzureEngine(DEFAULT_CONFIG);
+
+    case OCO_AI_PROVIDER_ENUM.FLOWISE:
+      return new FlowiseEngine(DEFAULT_CONFIG);
+
+    case OCO_AI_PROVIDER_ENUM.GROQ:
+      return new GroqEngine(DEFAULT_CONFIG);
+
+    case OCO_AI_PROVIDER_ENUM.MISTRAL:
+      return new MistralAiEngine(DEFAULT_CONFIG);
+
+    case OCO_AI_PROVIDER_ENUM.MLX:
+      return new MLXEngine(DEFAULT_CONFIG);
+
+    case OCO_AI_PROVIDER_ENUM.DEEPSEEK:
+      return new DeepseekEngine(DEFAULT_CONFIG);
+
+    default:
+      return new OpenAiEngine(DEFAULT_CONFIG);
   }
-  
-  //open ai gpt by default
-  return new OpenAi();
 }

src/utils/git.ts

@@ -80,7 +80,7 @@ export const gitAdd = async ({ files }: { files: string[] }) => {
 
   await execa('git', ['add', ...files]);
 
-  gitAddSpinner.stop('Done');
+  gitAddSpinner.stop(`Staged ${files.length} files`);
 };
 
 export const getDiff = async ({ files }: { files: string[] }) => {

src/utils/removeContentTags.ts

@@ -0,0 +1,51 @@
+/**
+ * Removes content wrapped in specified tags from a string
+ * @param content The content string to process
+ * @param tag The tag name without angle brackets (e.g., 'think' for '<think></think>')
+ * @returns The content with the specified tags and their contents removed, and trimmed
+ */
+export function removeContentTags<T extends string | null | undefined>(content: T, tag: string): T {
+  if (!content || typeof content !== 'string') {
+    return content;
+  }
+  
+  // Dynamic implementation for other cases
+  const openTag = `<${tag}>`;
+  const closeTag = `</${tag}>`;
+  
+  // Parse the content and remove tags
+  let result = '';
+  let skipUntil: number | null = null;
+  let depth = 0;
+  
+  for (let i = 0; i < content.length; i++) {
+    // Check for opening tag
+    if (content.substring(i, i + openTag.length) === openTag) {
+      depth++;
+      if (depth === 1) {
+        skipUntil = content.indexOf(closeTag, i + openTag.length);
+        i = i + openTag.length - 1; // Skip the opening tag
+        continue;
+      }
+    }
+    // Check for closing tag
+    else if (content.substring(i, i + closeTag.length) === closeTag && depth > 0) {
+      depth--;
+      if (depth === 0) {
+        i = i + closeTag.length - 1; // Skip the closing tag
+        skipUntil = null;
+        continue;
+      }
+    }
+    
+    // Only add character if not inside a tag
+    if (skipUntil === null) {
+      result += content[i];
+    }
+  }
+
+  // Normalize multiple spaces/tabs into a single space (preserves newlines), then trim.
+  result = result.replace(/[ \t]+/g, ' ').trim();
+
+  return result as unknown as T;
+}

test/e2e/gitPush.test.ts

@@ -0,0 +1,205 @@
+import path from 'path';
+import 'cli-testing-library/extend-expect';
+import { exec } from 'child_process';
+import { prepareTempDir } from './utils';
+import { promisify } from 'util';
+import { render } from 'cli-testing-library';
+import { resolve } from 'path';
+import { rm } from 'fs';
+const fsExec = promisify(exec);
+const fsRemove = promisify(rm);
+
+/**
+ * git remote -v
+ *
+ * [no remotes]
+ */
+const prepareNoRemoteGitRepository = async (): Promise<{
+  gitDir: string;
+  cleanup: () => Promise<void>;
+}> => {
+  const tempDir = await prepareTempDir();
+  await fsExec('git init test', { cwd: tempDir });
+  const gitDir = path.resolve(tempDir, 'test');
+
+  const cleanup = async () => {
+    return fsRemove(tempDir, { recursive: true });
+  };
+  return {
+    gitDir,
+    cleanup
+  };
+};
+
+/**
+ * git remote -v
+ *
+ * origin  /tmp/remote.git (fetch)
+ * origin  /tmp/remote.git (push)
+ */
+const prepareOneRemoteGitRepository = async (): Promise<{
+  gitDir: string;
+  cleanup: () => Promise<void>;
+}> => {
+  const tempDir = await prepareTempDir();
+  await fsExec('git init --bare remote.git', { cwd: tempDir });
+  await fsExec('git clone remote.git test', { cwd: tempDir });
+  const gitDir = path.resolve(tempDir, 'test');
+
+  const cleanup = async () => {
+    return fsRemove(tempDir, { recursive: true });
+  };
+  return {
+    gitDir,
+    cleanup
+  };
+};
+
+/**
+ * git remote -v
+ *
+ * origin  /tmp/remote.git (fetch)
+ * origin  /tmp/remote.git (push)
+ * other   ../remote2.git (fetch)
+ * other   ../remote2.git (push)
+ */
+const prepareTwoRemotesGitRepository = async (): Promise<{
+  gitDir: string;
+  cleanup: () => Promise<void>;
+}> => {
+  const tempDir = await prepareTempDir();
+  await fsExec('git init --bare remote.git', { cwd: tempDir });
+  await fsExec('git init --bare other.git', { cwd: tempDir });
+  await fsExec('git clone remote.git test', { cwd: tempDir });
+  const gitDir = path.resolve(tempDir, 'test');
+  await fsExec('git remote add other ../other.git', { cwd: gitDir });
+
+  const cleanup = async () => {
+    return fsRemove(tempDir, { recursive: true });
+  };
+  return {
+    gitDir,
+    cleanup
+  };
+};
+
+describe('cli flow to push git branch', () => {
+  it('do nothing when OCO_GITPUSH is set to false', async () => {
+    const { gitDir, cleanup } = await prepareNoRemoteGitRepository();
+
+    await render('echo', [`'console.log("Hello World");' > index.ts`], {
+      cwd: gitDir
+    });
+    await render('git', ['add index.ts'], { cwd: gitDir });
+
+    const { queryByText, findByText, userEvent } = await render(
+      `OCO_AI_PROVIDER='test' OCO_GITPUSH='false' node`,
+      [resolve('./out/cli.cjs')],
+      { cwd: gitDir }
+    );
+    expect(await findByText('Confirm the commit message?')).toBeInTheConsole();
+    userEvent.keyboard('[Enter]');
+
+    expect(
+      await queryByText('Choose a remote to push to')
+    ).not.toBeInTheConsole();
+    expect(
+      await queryByText('Do you want to run `git push`?')
+    ).not.toBeInTheConsole();
+    expect(
+      await queryByText('Successfully pushed all commits to origin')
+    ).not.toBeInTheConsole();
+    expect(
+      await queryByText('Command failed with exit code 1')
+    ).not.toBeInTheConsole();
+
+    await cleanup();
+  });
+
+  it('push and cause error when there is no remote', async () => {
+    const { gitDir, cleanup } = await prepareNoRemoteGitRepository();
+
+    await render('echo', [`'console.log("Hello World");' > index.ts`], {
+      cwd: gitDir
+    });
+    await render('git', ['add index.ts'], { cwd: gitDir });
+
+    const { queryByText, findByText, userEvent } = await render(
+      `OCO_AI_PROVIDER='test' OCO_GITPUSH='true' node`,
+      [resolve('./out/cli.cjs')],
+      { cwd: gitDir }
+    );
+    expect(await findByText('Confirm the commit message?')).toBeInTheConsole();
+    userEvent.keyboard('[Enter]');
+
+    expect(
+      await queryByText('Choose a remote to push to')
+    ).not.toBeInTheConsole();
+    expect(
+      await queryByText('Do you want to run `git push`?')
+    ).not.toBeInTheConsole();
+    expect(
+      await queryByText('Successfully pushed all commits to origin')
+    ).not.toBeInTheConsole();
+
+    expect(
+      await findByText('Command failed with exit code 1')
+    ).toBeInTheConsole();
+
+    await cleanup();
+  });
+
+  it('push when one remote is set', async () => {
+    const { gitDir, cleanup } = await prepareOneRemoteGitRepository();
+
+    await render('echo', [`'console.log("Hello World");' > index.ts`], {
+      cwd: gitDir
+    });
+    await render('git', ['add index.ts'], { cwd: gitDir });
+
+    const { findByText, userEvent } = await render(
+      `OCO_AI_PROVIDER='test' OCO_GITPUSH='true' node`,
+      [resolve('./out/cli.cjs')],
+      { cwd: gitDir }
+    );
+    expect(await findByText('Confirm the commit message?')).toBeInTheConsole();
+    userEvent.keyboard('[Enter]');
+
+    expect(
+      await findByText('Do you want to run `git push`?')
+    ).toBeInTheConsole();
+    userEvent.keyboard('[Enter]');
+
+    expect(
+      await findByText('Successfully pushed all commits to origin')
+    ).toBeInTheConsole();
+
+    await cleanup();
+  });
+
+  it('push when two remotes are set', async () => {
+    const { gitDir, cleanup } = await prepareTwoRemotesGitRepository();
+
+    await render('echo', [`'console.log("Hello World");' > index.ts`], {
+      cwd: gitDir
+    });
+    await render('git', ['add index.ts'], { cwd: gitDir });
+
+    const { findByText, userEvent } = await render(
+      `OCO_AI_PROVIDER='test' OCO_GITPUSH='true' node`,
+      [resolve('./out/cli.cjs')],
+      { cwd: gitDir }
+    );
+    expect(await findByText('Confirm the commit message?')).toBeInTheConsole();
+    userEvent.keyboard('[Enter]');
+
+    expect(await findByText('Choose a remote to push to')).toBeInTheConsole();
+    userEvent.keyboard('[Enter]');
+
+    expect(
+      await findByText('Successfully pushed all commits to origin')
+    ).toBeInTheConsole();
+
+    await cleanup();
+  });
+});

test/e2e/oneFile.test.ts

@@ -9,7 +9,7 @@ it('cli flow to generate commit message for 1 new file (staged)', async () => {
   await render('echo' ,[`'console.log("Hello World");' > index.ts`], { cwd: gitDir });
   await render('git' ,['add index.ts'], { cwd: gitDir });
 
-  const { queryByText, findByText, userEvent } = await render(`OCO_AI_PROVIDER='test' node`, [resolve('./out/cli.cjs')], { cwd: gitDir });
+  const { queryByText, findByText, userEvent } = await render(`OCO_AI_PROVIDER='test' OCO_GITPUSH='true' node`, [resolve('./out/cli.cjs')], { cwd: gitDir });
   expect(await queryByText('No files are staged')).not.toBeInTheConsole();
   expect(await queryByText('Do you want to stage all files and generate commit message?')).not.toBeInTheConsole();
 
@@ -17,7 +17,7 @@ it('cli flow to generate commit message for 1 new file (staged)', async () => {
   expect(await findByText('Confirm the commit message?')).toBeInTheConsole();
   userEvent.keyboard('[Enter]');
 
-  expect(await findByText('Choose a remote to push to')).toBeInTheConsole();
+  expect(await findByText('Do you want to run `git push`?')).toBeInTheConsole();
   userEvent.keyboard('[Enter]');
 
   expect(await findByText('Successfully pushed all commits to origin')).toBeInTheConsole();
@@ -34,7 +34,7 @@ it('cli flow to generate commit message for 1 changed file (not staged)', async
 
   await render('echo' ,[`'console.log("Good night World");' >> index.ts`], { cwd: gitDir });
 
-  const { findByText, userEvent } = await render(`OCO_AI_PROVIDER='test' node`, [resolve('./out/cli.cjs')], { cwd: gitDir });
+  const { findByText, userEvent } = await render(`OCO_AI_PROVIDER='test' OCO_GITPUSH='true' node`, [resolve('./out/cli.cjs')], { cwd: gitDir });
 
   expect(await findByText('No files are staged')).toBeInTheConsole();
   expect(await findByText('Do you want to stage all files and generate commit message?')).toBeInTheConsole();
@@ -46,7 +46,7 @@ it('cli flow to generate commit message for 1 changed file (not staged)', async
 
   expect(await findByText('Successfully committed')).toBeInTheConsole();
 
-  expect(await findByText('Choose a remote to push to')).toBeInTheConsole();
+  expect(await findByText('Do you want to run `git push`?')).toBeInTheConsole();
   userEvent.keyboard('[Enter]');
 
   expect(await findByText('Successfully pushed all commits to origin')).toBeInTheConsole();

test/e2e/prompt-module/commitlint.test.ts

@@ -5,8 +5,8 @@ import { prepareEnvironment, wait } from '../utils';
 import path from 'path';
 
 function getAbsolutePath(relativePath: string) {
-  const scriptDir = path.dirname(__filename);
-  return path.resolve(scriptDir, relativePath);
+  // Use process.cwd() which should be the project root during test execution
+  return path.resolve(process.cwd(), 'test/e2e/prompt-module', relativePath);
 }
 async function setupCommitlint(dir: string, ver: 9 | 18 | 19) {
   let packagePath, packageJsonPath, configPath;
@@ -47,7 +47,7 @@ describe('cli flow to run "oco commitlint force"', () => {
       `
       OCO_TEST_MOCK_TYPE='prompt-module-commitlint-config' \
       OCO_PROMPT_MODULE='@commitlint'  \
-      OCO_AI_PROVIDER='test'  \
+      OCO_AI_PROVIDER='test' OCO_GITPUSH='true' \
       node ${resolve('./out/cli.cjs')} commitlint force \
     `,
       [],
@@ -83,7 +83,7 @@ describe('cli flow to run "oco commitlint force"', () => {
       `
       OCO_TEST_MOCK_TYPE='prompt-module-commitlint-config' \
       OCO_PROMPT_MODULE='@commitlint'  \
-      OCO_AI_PROVIDER='test'  \
+      OCO_AI_PROVIDER='test' OCO_GITPUSH='true' \
       node ${resolve('./out/cli.cjs')} commitlint force \
     `,
       [],
@@ -119,7 +119,7 @@ describe('cli flow to run "oco commitlint force"', () => {
       `
       OCO_TEST_MOCK_TYPE='prompt-module-commitlint-config' \
       OCO_PROMPT_MODULE='@commitlint'  \
-      OCO_AI_PROVIDER='test'  \
+      OCO_AI_PROVIDER='test' OCO_GITPUSH='true' \
       node ${resolve('./out/cli.cjs')} commitlint force \
     `,
       [],
@@ -160,7 +160,7 @@ describe('cli flow to generate commit message using @commitlint prompt-module',
       `
       OCO_TEST_MOCK_TYPE='prompt-module-commitlint-config' \
       OCO_PROMPT_MODULE='@commitlint'  \
-      OCO_AI_PROVIDER='test'  \
+      OCO_AI_PROVIDER='test' OCO_GITPUSH='true' \
       node ${resolve('./out/cli.cjs')} commitlint force \
     `,
       [],
@@ -175,15 +175,13 @@ describe('cli flow to generate commit message using @commitlint prompt-module',
       `
       OCO_TEST_MOCK_TYPE='prompt-module-commitlint-config' \
       OCO_PROMPT_MODULE='@commitlint'  \
-      OCO_AI_PROVIDER='test'  \
+      OCO_AI_PROVIDER='test' OCO_GITPUSH='true' \
       node ${resolve('./out/cli.cjs')} commitlint get \
     `,
       [],
       { cwd: gitDir }
     );
-    expect(
-      await commitlintGet.findByText('[object Object]')
-    ).toBeInTheConsole();
+    expect(await commitlintGet.findByText('consistency')).toBeInTheConsole();
 
     // Run 'oco' using .opencommit-commitlint
     await render('echo', [`'console.log("Hello World");' > index.ts`], {
@@ -195,7 +193,7 @@ describe('cli flow to generate commit message using @commitlint prompt-module',
       `
       OCO_TEST_MOCK_TYPE='commit-message' \
       OCO_PROMPT_MODULE='@commitlint'  \
-      OCO_AI_PROVIDER='test' \
+      OCO_AI_PROVIDER='test' OCO_GITPUSH='true' \
       node ${resolve('./out/cli.cjs')} \
     `,
       [],
@@ -211,7 +209,7 @@ describe('cli flow to generate commit message using @commitlint prompt-module',
     oco.userEvent.keyboard('[Enter]');
 
     expect(
-      await oco.findByText('Choose a remote to push to')
+      await oco.findByText('Do you want to run `git push`?')
     ).toBeInTheConsole();
     oco.userEvent.keyboard('[Enter]');
 

test/e2e/utils.ts

@@ -15,7 +15,7 @@ export const prepareEnvironment = async (): Promise<{
   gitDir: string;
   cleanup: () => Promise<void>;
 }> => {
-  const tempDir = await fsMakeTempDir(path.join(tmpdir(), 'opencommit-test-'));
+  const tempDir = await prepareTempDir();
   // Create a remote git repository int the temp directory. This is necessary to execute the `git push` command
   await fsExec('git init --bare remote.git', { cwd: tempDir }); 
   await fsExec('git clone remote.git test', { cwd: tempDir });
@@ -30,4 +30,8 @@ export const prepareEnvironment = async (): Promise<{
   }
 }
 
+export const prepareTempDir = async(): Promise<string> => {
+  return await fsMakeTempDir(path.join(tmpdir(), 'opencommit-test-'));
+}
+
 export const wait = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));

test/jest-setup.ts

@@ -1,10 +1,11 @@
-import 'cli-testing-library/extend-expect'
-import { configure } from 'cli-testing-library'
 import { jest } from '@jest/globals';
+import 'cli-testing-library/extend-expect';
+import { configure } from 'cli-testing-library';
 
+// Make Jest available globally
 global.jest = jest;
 
 /**
  * Adjusted the wait time for waitFor/findByText to 2000ms, because the default 1000ms makes the test results flaky
  */
-configure({ asyncUtilTimeout: 2000 })
+configure({ asyncUtilTimeout: 2000 });

test/unit/config.test.ts

@@ -1,8 +1,18 @@
-import { getConfig } from '../../src/commands/config';
+import { existsSync, readFileSync, rmSync } from 'fs';
+import {
+  CONFIG_KEYS,
+  DEFAULT_CONFIG,
+  getConfig,
+  setConfig
+} from '../../src/commands/config';
 import { prepareFile } from './utils';
+import { dirname } from 'path';
 
-describe('getConfig', () => {
+describe('config', () => {
   const originalEnv = { ...process.env };
+  let globalConfigFile: { filePath: string; cleanup: () => Promise<void> };
+  let envConfigFile: { filePath: string; cleanup: () => Promise<void> };
+
   function resetEnv(env: NodeJS.ProcessEnv) {
     Object.keys(process.env).forEach((key) => {
       if (!(key in env)) {
@@ -13,93 +23,307 @@ describe('getConfig', () => {
     });
   }
 
-  beforeEach(() => {
+  beforeEach(async () => {
     resetEnv(originalEnv);
+    if (globalConfigFile) await globalConfigFile.cleanup();
+    if (envConfigFile) await envConfigFile.cleanup();
+  });
+
+  afterEach(async () => {
+    if (globalConfigFile) await globalConfigFile.cleanup();
+    if (envConfigFile) await envConfigFile.cleanup();
   });
 
   afterAll(() => {
     resetEnv(originalEnv);
   });
 
-  it('return config values from the global config file', async () => {
-    const configFile = await prepareFile(
-      '.opencommit',
-      `
-OCO_OPENAI_API_KEY="sk-key"
-OCO_ANTHROPIC_API_KEY="secret-key"
-OCO_TOKENS_MAX_INPUT="8192"
-OCO_TOKENS_MAX_OUTPUT="1000"
-OCO_OPENAI_BASE_PATH="/openai/api"
-OCO_DESCRIPTION="true"
-OCO_EMOJI="true"
-OCO_MODEL="gpt-4"
-OCO_LANGUAGE="de"
-OCO_MESSAGE_TEMPLATE_PLACEHOLDER="$m"
-OCO_PROMPT_MODULE="@commitlint"
-OCO_AI_PROVIDER="ollama"
-OCO_GITPUSH="false"
-OCO_ONE_LINE_COMMIT="true"
-`
-    );
-    const config = getConfig({ configPath: configFile.filePath, envPath: '' });
+  const generateConfig = async (
+    fileName: string,
+    content: Record<string, string>
+  ) => {
+    const fileContent = Object.entries(content)
+      .map(([key, value]) => `${key}="${value}"`)
+      .join('\n');
+    return await prepareFile(fileName, fileContent);
+  };
 
-    expect(config).not.toEqual(null);
-    expect(config!['OCO_OPENAI_API_KEY']).toEqual('sk-key');
-    expect(config!['OCO_ANTHROPIC_API_KEY']).toEqual('secret-key');
-    expect(config!['OCO_TOKENS_MAX_INPUT']).toEqual(8192);
-    expect(config!['OCO_TOKENS_MAX_OUTPUT']).toEqual(1000);
-    expect(config!['OCO_OPENAI_BASE_PATH']).toEqual('/openai/api');
-    expect(config!['OCO_DESCRIPTION']).toEqual(true);
-    expect(config!['OCO_EMOJI']).toEqual(true);
-    expect(config!['OCO_MODEL']).toEqual('gpt-4');
-    expect(config!['OCO_LANGUAGE']).toEqual('de');
-    expect(config!['OCO_MESSAGE_TEMPLATE_PLACEHOLDER']).toEqual('$m');
-    expect(config!['OCO_PROMPT_MODULE']).toEqual('@commitlint');
-    expect(() => ['ollama', 'gemini'].includes(config!['OCO_AI_PROVIDER'])).toBeTruthy();
-    expect(config!['OCO_GITPUSH']).toEqual(false);
-    expect(config!['OCO_ONE_LINE_COMMIT']).toEqual(true);
+  describe('getConfig', () => {
+    it('should prioritize local .env over global .opencommit config', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {
+        OCO_API_KEY: 'global-key',
+        OCO_MODEL: 'gpt-3.5-turbo',
+        OCO_LANGUAGE: 'en'
+      });
 
-    await configFile.cleanup();
+      envConfigFile = await generateConfig('.env', {
+        OCO_API_KEY: 'local-key',
+        OCO_LANGUAGE: 'fr'
+      });
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath,
+        envPath: envConfigFile.filePath
+      });
+
+      expect(config).not.toEqual(null);
+      expect(config.OCO_API_KEY).toEqual('local-key');
+      expect(config.OCO_MODEL).toEqual('gpt-3.5-turbo');
+      expect(config.OCO_LANGUAGE).toEqual('fr');
+    });
+
+    it('should fallback to global config when local config is not set', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {
+        OCO_API_KEY: 'global-key',
+        OCO_MODEL: 'gpt-4',
+        OCO_LANGUAGE: 'de',
+        OCO_DESCRIPTION: 'true'
+      });
+
+      envConfigFile = await generateConfig('.env', {
+        OCO_API_URL: 'local-api-url'
+      });
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath,
+        envPath: envConfigFile.filePath
+      });
+
+      expect(config).not.toEqual(null);
+      expect(config.OCO_API_KEY).toEqual('global-key');
+      expect(config.OCO_API_URL).toEqual('local-api-url');
+      expect(config.OCO_MODEL).toEqual('gpt-4');
+      expect(config.OCO_LANGUAGE).toEqual('de');
+      expect(config.OCO_DESCRIPTION).toEqual(true);
+    });
+
+    it('should handle boolean and numeric values correctly', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {
+        OCO_TOKENS_MAX_INPUT: '4096',
+        OCO_TOKENS_MAX_OUTPUT: '500',
+        OCO_GITPUSH: 'true'
+      });
+
+      envConfigFile = await generateConfig('.env', {
+        OCO_TOKENS_MAX_INPUT: '8192',
+        OCO_ONE_LINE_COMMIT: 'false',
+        OCO_OMIT_SCOPE: 'true'
+      });
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath,
+        envPath: envConfigFile.filePath
+      });
+
+      expect(config).not.toEqual(null);
+      expect(config.OCO_TOKENS_MAX_INPUT).toEqual(8192);
+      expect(config.OCO_TOKENS_MAX_OUTPUT).toEqual(500);
+      expect(config.OCO_GITPUSH).toEqual(true);
+      expect(config.OCO_ONE_LINE_COMMIT).toEqual(false);
+      expect(config.OCO_OMIT_SCOPE).toEqual(true);
+    });
+    
+    it('should handle custom HTTP headers correctly', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {
+        OCO_API_CUSTOM_HEADERS: '{"X-Global-Header": "global-value"}'
+      });
+
+      envConfigFile = await generateConfig('.env', {
+        OCO_API_CUSTOM_HEADERS: '{"Authorization": "Bearer token123", "X-Custom-Header": "test-value"}'
+      });
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath,
+        envPath: envConfigFile.filePath
+      });
+
+      expect(config).not.toEqual(null);
+      expect(config.OCO_API_CUSTOM_HEADERS).toEqual({"Authorization": "Bearer token123", "X-Custom-Header": "test-value"});
+      
+      // No need to parse JSON again since it's already an object
+      const parsedHeaders = config.OCO_API_CUSTOM_HEADERS;
+      expect(parsedHeaders).toHaveProperty('Authorization', 'Bearer token123');
+      expect(parsedHeaders).toHaveProperty('X-Custom-Header', 'test-value');
+      expect(parsedHeaders).not.toHaveProperty('X-Global-Header');
+    });
+
+    it('should handle empty local config correctly', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {
+        OCO_API_KEY: 'global-key',
+        OCO_MODEL: 'gpt-4',
+        OCO_LANGUAGE: 'es'
+      });
+
+      envConfigFile = await generateConfig('.env', {});
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath,
+        envPath: envConfigFile.filePath
+      });
+
+      expect(config).not.toEqual(null);
+      expect(config.OCO_API_KEY).toEqual('global-key');
+      expect(config.OCO_MODEL).toEqual('gpt-4');
+      expect(config.OCO_LANGUAGE).toEqual('es');
+    });
+
+    it('should override global config with null values in local .env', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {
+        OCO_API_KEY: 'global-key',
+        OCO_MODEL: 'gpt-4',
+        OCO_LANGUAGE: 'es'
+      });
+
+      envConfigFile = await generateConfig('.env', {
+        OCO_API_KEY: 'null'
+      });
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath,
+        envPath: envConfigFile.filePath
+      });
+
+      expect(config).not.toEqual(null);
+      expect(config.OCO_API_KEY).toEqual(null);
+    });
+
+    it('should handle empty global config', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {});
+      envConfigFile = await generateConfig('.env', {});
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath,
+        envPath: envConfigFile.filePath
+      });
+
+      expect(config).not.toEqual(null);
+      expect(config.OCO_API_KEY).toEqual(undefined);
+    });
   });
 
-  it('return config values from the local env file', async () => {
-    const envFile = await prepareFile(
-      '.env',
-      `
-OCO_OPENAI_API_KEY="sk-key"
-OCO_ANTHROPIC_API_KEY="secret-key"
-OCO_TOKENS_MAX_INPUT="8192"
-OCO_TOKENS_MAX_OUTPUT="1000"
-OCO_OPENAI_BASE_PATH="/openai/api"
-OCO_DESCRIPTION="true"
-OCO_EMOJI="true"
-OCO_MODEL="gpt-4"
-OCO_LANGUAGE="de"
-OCO_MESSAGE_TEMPLATE_PLACEHOLDER="$m"
-OCO_PROMPT_MODULE="@commitlint"
-OCO_AI_PROVIDER="ollama"
-OCO_GITPUSH="false"
-OCO_ONE_LINE_COMMIT="true"
-    `
-    );
-    const config = getConfig({ configPath: '', envPath: envFile.filePath });
+  describe('setConfig', () => {
+    beforeEach(async () => {
+      // we create and delete the file to have the parent directory, but not the file, to test the creation of the file
+      globalConfigFile = await generateConfig('.opencommit', {});
+      rmSync(globalConfigFile.filePath);
+    });
 
-    expect(config).not.toEqual(null);
-    expect(config!['OCO_OPENAI_API_KEY']).toEqual('sk-key');
-    expect(config!['OCO_ANTHROPIC_API_KEY']).toEqual('secret-key');
-    expect(config!['OCO_TOKENS_MAX_INPUT']).toEqual(8192);
-    expect(config!['OCO_TOKENS_MAX_OUTPUT']).toEqual(1000);
-    expect(config!['OCO_OPENAI_BASE_PATH']).toEqual('/openai/api');
-    expect(config!['OCO_DESCRIPTION']).toEqual(true);
-    expect(config!['OCO_EMOJI']).toEqual(true);
-    expect(config!['OCO_MODEL']).toEqual('gpt-4');
-    expect(config!['OCO_LANGUAGE']).toEqual('de');
-    expect(config!['OCO_MESSAGE_TEMPLATE_PLACEHOLDER']).toEqual('$m');
-    expect(config!['OCO_PROMPT_MODULE']).toEqual('@commitlint');
-    expect(() => ['ollama', 'gemini'].includes(config!['OCO_AI_PROVIDER'])).toBeTruthy();
-    expect(config!['OCO_GITPUSH']).toEqual(false);
-    expect(config!['OCO_ONE_LINE_COMMIT']).toEqual(true);
+    it('should create .opencommit file with DEFAULT CONFIG if it does not exist on first setConfig run', async () => {
+      const isGlobalConfigFileExist = existsSync(globalConfigFile.filePath);
+      expect(isGlobalConfigFileExist).toBe(false);
 
-    await envFile.cleanup();
+      await setConfig(
+        [[CONFIG_KEYS.OCO_API_KEY, 'persisted-key_1']],
+        globalConfigFile.filePath
+      );
+
+      const fileContent = readFileSync(globalConfigFile.filePath, 'utf8');
+      expect(fileContent).toContain('OCO_API_KEY=persisted-key_1');
+      Object.entries(DEFAULT_CONFIG).forEach(([key, value]) => {
+        expect(fileContent).toContain(`${key}=${value}`);
+      });
+    });
+
+    it('should set new config values', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {});
+      await setConfig(
+        [
+          [CONFIG_KEYS.OCO_API_KEY, 'new-key'],
+          [CONFIG_KEYS.OCO_MODEL, 'gpt-4']
+        ],
+        globalConfigFile.filePath
+      );
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath
+      });
+      expect(config.OCO_API_KEY).toEqual('new-key');
+      expect(config.OCO_MODEL).toEqual('gpt-4');
+    });
+
+    it('should update existing config values', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {
+        OCO_API_KEY: 'initial-key'
+      });
+      await setConfig(
+        [[CONFIG_KEYS.OCO_API_KEY, 'updated-key']],
+        globalConfigFile.filePath
+      );
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath
+      });
+      expect(config.OCO_API_KEY).toEqual('updated-key');
+    });
+
+    it('should handle boolean and numeric values correctly', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {});
+      await setConfig(
+        [
+          [CONFIG_KEYS.OCO_TOKENS_MAX_INPUT, '8192'],
+          [CONFIG_KEYS.OCO_DESCRIPTION, 'true'],
+          [CONFIG_KEYS.OCO_ONE_LINE_COMMIT, 'false']
+        ],
+        globalConfigFile.filePath
+      );
+
+      const config = getConfig({
+        globalPath: globalConfigFile.filePath
+      });
+      expect(config.OCO_TOKENS_MAX_INPUT).toEqual(8192);
+      expect(config.OCO_DESCRIPTION).toEqual(true);
+      expect(config.OCO_ONE_LINE_COMMIT).toEqual(false);
+    });
+
+    it('should throw an error for unsupported config keys', async () => {
+      globalConfigFile = await generateConfig('.opencommit', {});
+
+      try {
+        await setConfig(
+          [['UNSUPPORTED_KEY', 'value']],
+          globalConfigFile.filePath
+        );
+        throw new Error('NEVER_REACHED');
+      } catch (error) {
+        expect(error.message).toContain(
+          'Unsupported config key: UNSUPPORTED_KEY'
+        );
+        expect(error.message).not.toContain('NEVER_REACHED');
+      }
+    });
+
+    it('should persist changes to the config file', async () => {
+      const isGlobalConfigFileExist = existsSync(globalConfigFile.filePath);
+      expect(isGlobalConfigFileExist).toBe(false);
+
+      await setConfig(
+        [[CONFIG_KEYS.OCO_API_KEY, 'persisted-key']],
+        globalConfigFile.filePath
+      );
+
+      const fileContent = readFileSync(globalConfigFile.filePath, 'utf8');
+      expect(fileContent).toContain('OCO_API_KEY=persisted-key');
+    });
+
+    it('should set multiple configs in a row and keep the changes', async () => {
+      const isGlobalConfigFileExist = existsSync(globalConfigFile.filePath);
+      expect(isGlobalConfigFileExist).toBe(false);
+
+      await setConfig(
+        [[CONFIG_KEYS.OCO_API_KEY, 'persisted-key']],
+        globalConfigFile.filePath
+      );
+
+      const fileContent1 = readFileSync(globalConfigFile.filePath, 'utf8');
+      expect(fileContent1).toContain('OCO_API_KEY=persisted-key');
+
+      await setConfig(
+        [[CONFIG_KEYS.OCO_MODEL, 'gpt-4']],
+        globalConfigFile.filePath
+      );
+
+      const fileContent2 = readFileSync(globalConfigFile.filePath, 'utf8');
+      expect(fileContent2).toContain('OCO_MODEL=gpt-4');
+    });
   });
-});
+});

test/unit/gemini.test.ts

@@ -1,80 +1,69 @@
-import { Gemini } from '../../src/engine/gemini';
-import { ChatCompletionRequestMessage } from 'openai';
+import { GeminiEngine } from '../../src/engine/gemini';
+
 import { GenerativeModel, GoogleGenerativeAI } from '@google/generative-ai';
-import { ConfigType, getConfig } from '../../src/commands/config';
+import {
+  ConfigType,
+  getConfig,
+  OCO_AI_PROVIDER_ENUM
+} from '../../src/commands/config';
+import { OpenAI } from 'openai';
 
 describe('Gemini', () => {
-  let gemini: Gemini;
+  let gemini: GeminiEngine;
   let mockConfig: ConfigType;
   let mockGoogleGenerativeAi: GoogleGenerativeAI;
   let mockGenerativeModel: GenerativeModel;
   let mockExit: jest.SpyInstance<never, [code?: number | undefined], any>;
-  let mockWarmup: jest.SpyInstance<any, unknown[], any>;
-  
-  const noop: (code?: number | undefined) => never = (code?: number | undefined) => {};
-  
+
+  const noop: (...args: any[]) => any = (...args: any[]) => {};
+
   const mockGemini = () => {
-    gemini = new Gemini();
-  }
-  
+    mockConfig = getConfig() as ConfigType;
+
+    gemini = new GeminiEngine({
+      apiKey: mockConfig.OCO_API_KEY,
+      model: mockConfig.OCO_MODEL
+    });
+  };
+
   const oldEnv = process.env;
 
   beforeEach(() => {
     jest.resetModules();
     process.env = { ...oldEnv };
-    
+
     jest.mock('@google/generative-ai');
     jest.mock('../src/commands/config');
-    
+
     jest.mock('@clack/prompts', () => ({
       intro: jest.fn(),
-      outro: jest.fn(),
+      outro: jest.fn()
     }));
-    
-    if (mockWarmup) mockWarmup.mockRestore();
-    
+
     mockExit = jest.spyOn(process, 'exit').mockImplementation();
+
     mockConfig = getConfig() as ConfigType;
-    
-    mockConfig.OCO_AI_PROVIDER = 'gemini';
-    mockConfig.OCO_GEMINI_API_KEY = 'mock-api-key';
+
+    mockConfig.OCO_AI_PROVIDER = OCO_AI_PROVIDER_ENUM.GEMINI;
+    mockConfig.OCO_API_KEY = 'mock-api-key';
     mockConfig.OCO_MODEL = 'gemini-1.5-flash';
-    
-    mockGoogleGenerativeAi = new GoogleGenerativeAI(mockConfig.OCO_GEMINI_API_KEY);    
-    mockGenerativeModel = mockGoogleGenerativeAi.getGenerativeModel({ model: mockConfig.OCO_MODEL, });
+
+    mockGoogleGenerativeAi = new GoogleGenerativeAI(mockConfig.OCO_API_KEY);
+    mockGenerativeModel = mockGoogleGenerativeAi.getGenerativeModel({
+      model: mockConfig.OCO_MODEL
+    });
   });
-  
+
   afterEach(() => {
     gemini = undefined as any;
-  })
-  
+  });
+
   afterAll(() => {
     mockExit.mockRestore();
     process.env = oldEnv;
   });
 
-  it('should initialize with correct config', () => {
-    mockGemini();
-    // gemini = new Gemini();
-    expect(gemini).toBeDefined();
-  });
-
-  it('should warmup correctly', () => {
-    mockWarmup = jest.spyOn(Gemini.prototype as any, 'warmup').mockImplementation(noop);
-    mockGemini();
-    expect(gemini).toBeDefined();
-  });
-
-  it('should exit process if OCO_GEMINI_API_KEY is not set and command is not config', () => {
-    process.env.OCO_GEMINI_API_KEY = undefined;
-    process.env.OCO_AI_PROVIDER = 'gemini';
-    
-    mockGemini();
-    
-    expect(mockExit).toHaveBeenCalledWith(1);
-  });
-
-  it('should exit process if model is not supported and command is not config', () => {
+  it.skip('should exit process if OCO_GEMINI_API_KEY is not set and command is not config', () => {
     process.env.OCO_GEMINI_API_KEY = undefined;
     process.env.OCO_AI_PROVIDER = 'gemini';
 
@@ -82,24 +71,26 @@ describe('Gemini', () => {
 
     expect(mockExit).toHaveBeenCalledWith(1);
   });
-  
+
   it('should generate commit message', async () => {
-    const mockGenerateContent = jest.fn().mockResolvedValue({ response: { text: () => 'generated content' } });
+    const mockGenerateContent = jest
+      .fn()
+      .mockResolvedValue({ response: { text: () => 'generated content' } });
     mockGenerativeModel.generateContent = mockGenerateContent;
-    
-    mockWarmup = jest.spyOn(Gemini.prototype as any, 'warmup').mockImplementation(noop);
+
     mockGemini();
-    
-    const messages: ChatCompletionRequestMessage[] = [
-      { role: 'system', content: 'system message' },
-      { role: 'assistant', content: 'assistant message' },
-    ];
-    
-    jest.spyOn(gemini, 'generateCommitMessage').mockImplementation(async () => 'generated content');
+
+    const messages: Array<OpenAI.Chat.Completions.ChatCompletionMessageParam> =
+      [
+        { role: 'system', content: 'system message' },
+        { role: 'assistant', content: 'assistant message' }
+      ];
+
+    jest
+      .spyOn(gemini, 'generateCommitMessage')
+      .mockImplementation(async () => 'generated content');
     const result = await gemini.generateCommitMessage(messages);
 
     expect(result).toEqual('generated content');
-    expect(mockWarmup).toHaveBeenCalled();
   });
-  
-});
+});

test/unit/removeContentTags.test.ts

@@ -0,0 +1,57 @@
+import { removeContentTags } from '../../src/utils/removeContentTags';
+
+describe('removeContentTags', () => {
+  it('should remove content wrapped in specified tags', () => {
+    const content = 'This is <think>something to hide</think> visible content';
+    const result = removeContentTags(content, 'think');
+    expect(result).toBe('This is visible content');
+  });
+
+  it('should handle multiple tag occurrences', () => {
+    const content = '<think>hidden</think> visible <think>also hidden</think> text';
+    const result = removeContentTags(content, 'think');
+    expect(result).toBe('visible text');
+  });
+
+  it('should handle multiline content within tags', () => {
+    const content = 'Start <think>hidden\nover multiple\nlines</think> End';
+    const result = removeContentTags(content, 'think');
+    expect(result).toBe('Start End');
+  });
+
+  it('should return content as is when tag is not found', () => {
+    const content = 'Content without any tags';
+    const result = removeContentTags(content, 'think');
+    expect(result).toBe('Content without any tags');
+  });
+
+  it('should work with different tag names', () => {
+    const content = 'This is <custom>something to hide</custom> visible content';
+    const result = removeContentTags(content, 'custom');
+    expect(result).toBe('This is visible content');
+  });
+
+  it('should handle null content', () => {
+    const content = null;
+    const result = removeContentTags(content, 'think');
+    expect(result).toBe(null);
+  });
+
+  it('should handle undefined content', () => {
+    const content = undefined;
+    const result = removeContentTags(content, 'think');
+    expect(result).toBe(undefined);
+  });
+
+  it('should trim the result', () => {
+    const content = '  <think>hidden</think> visible  ';
+    const result = removeContentTags(content, 'think');
+    expect(result).toBe('visible');
+  });
+
+  it('should handle nested tags correctly', () => {
+    const content = 'Outside <think>Inside <think>Nested</think></think> End';
+    const result = removeContentTags(content, 'think');
+    expect(result).toBe('Outside End');
+  });
+});

test/unit/utils.ts

@@ -1,7 +1,7 @@
-import path from 'path';
-import { mkdtemp, rm, writeFile } from 'fs';
-import { promisify } from 'util';
+import { existsSync, mkdtemp, rm, writeFile } from 'fs';
 import { tmpdir } from 'os';
+import path from 'path';
+import { promisify } from 'util';
 const fsMakeTempDir = promisify(mkdtemp);
 const fsRemove = promisify(rm);
 const fsWriteFile = promisify(writeFile);
@@ -20,8 +20,11 @@ export async function prepareFile(
   const filePath = path.resolve(tempDir, fileName);
   await fsWriteFile(filePath, content);
   const cleanup = async () => {
-    return fsRemove(tempDir, { recursive: true });
+    if (existsSync(tempDir)) {
+      await fsRemove(tempDir, { recursive: true });
+    }
   };
+
   return {
     filePath,
     cleanup

tsconfig.json

@@ -3,10 +3,10 @@
     "target": "ES2020",
     "lib": ["ES6", "ES2020"],
 
-    "module": "CommonJS",
-    
+    "module": "NodeNext",
+
     "resolveJsonModule": true,
-    "moduleResolution": "Node",
+    "moduleResolution": "NodeNext",
 
     "allowJs": true,
 
@@ -21,9 +21,7 @@
 
     "skipLibCheck": true
   },
-  "include": [
-    "test/jest-setup.ts"
-  ],
+  "include": ["test/jest-setup.ts"],
   "exclude": ["node_modules"],
   "ts-node": {
     "esm": true,