3.0.15

* test: ✅ add the first E2E test and configuration to CI (#316)

* add tests

* Add push config (#220)

* feat: add instructions and support for configuring gpt-4-turbo (#320)

* 3.0.12

* build

* feat: add 'gpt-4-turbo' to supported models in README and config validation

---------

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

* ✅ fix the broken E2E tests due to the addition of OCO_GITPUSH (#321)

* test(oneFile.test.ts): update test expectations to match new push prompt text

* build

* Feat: Add Claude 3 support (#318)

* 3.0.12

* build

* feat: anthropic claude 3 support

* fix: add system prompt

* fix: type check

* fix: package version

* fix: update anthropic for dependency bug fix

* feat: update build files

* feat: update version number

---------

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

* 🐛bug fix: enable to use the new format of OpenAI's project API Key (#328)

* fix(config.ts): remove validation for OCO_OPENAI_API_KEY length to accommodate variable key lengths

* build

* ♻️ refactor(config.ts): Addition of UnitTest environment and unittest for commands/config.ts#getConfig (#330)

* feat(jest.config.ts): update jest preset for TS ESM support and ignore patterns
feat(package.json): add test:unit script with NODE_OPTIONS for ESM
refactor(src/commands/config.ts): improve dotenv usage with dynamic paths
feat(src/commands/config.ts): allow custom config and env paths in getConfig
refactor(src/commands/config.ts): streamline environment variable access

feat(test/unit): add unit tests for config handling and utility functions

- Implement unit tests for `getConfig` function to ensure correct behavior
  in various scenarios including default values, global config, and local
  env file precedence.
- Add utility function `prepareFile` for creating temporary files during
  tests, facilitating testing of file-based configurations.

* feat(e2e.yml): add unit-test job to GitHub Actions for running unit tests on pull requests

* ci(test.yml): add GitHub Actions workflow for unit and e2e tests on pull requests

* refactor(config.ts): streamline environment variable access using process.env directly
test(config.test.ts): add setup and teardown for environment variables in tests to ensure test isolation

* feat(package.json): add `test:all` script to run all tests in Docker
refactor(package.json): consolidate Docker build steps into `test:docker-build` script for DRY principle
fix(package.json): ensure `test:unit:docker` and `test:e2e:docker` scripts use the same Docker image and remove container after run
chore(test/Dockerfile): remove default CMD to allow dynamic test script execution in Docker

* refactor(config.test.ts): anonymize API keys in tests for better security practices

* feat(config.test.ts): add tests for OCO_ANTHROPIC_API_KEY configuration

* refactor(config.ts): streamline path imports and remove unused DotenvParseOutput

- Simplify path module imports by removing default import and using named imports for `pathJoin` and `pathResolve`.
- Remove unused `DotenvParseOutput` import to clean up the code.

* refactor(config.test.ts): simplify API key mock values for clarity in tests

* test(config.test.ts): remove tests for default config values and redundant cases

- Removed tests that checked for default config values when no config or env files are present, as these scenarios are now handled differently.
- Eliminated tests for empty global config and local env files to streamline testing focus on actual config loading logic.
- Removed test for prioritizing local env over global config due to changes in config loading strategy, simplifying the configuration management.

* new version

---------

Co-authored-by: Takanori Matsumoto <matscube@gmail.com>
Co-authored-by: Moret84 <aurelienrivet@hotmail.fr>
Co-authored-by: yowatari <4982161+YOwatari@users.noreply.github.com>
Co-authored-by: metavind <94786679+metavind@users.noreply.github.com>

.dockerignore

@@ -0,0 +1 @@
+.env

.eslintrc.json

@@ -21,8 +21,8 @@
   "rules": {
     "prettier/prettier": "error",
     "no-console": "error",
-    "sort-imports": "off",
     "import/order": "off",
+    "sort-imports": "off",
     "simple-import-sort/imports": "error",
     "simple-import-sort/exports": "error",
     "import/first": "error",

.github/CONTRIBUTING.md

@@ -9,7 +9,7 @@ Thanks for considering contributing to the project.
 3. Create a new branch for your changes.
 4. Make your changes and commit them with descriptive commit messages.
 5. Push your changes to your forked repository.
-6. Create a pull request from your branch to the `dev` branch.
+6. Create a pull request from your branch to the `dev` branch. Not `master` branch, PR to `dev` branch, please.
 
 ## Getting started
 

.github/workflows/stale.yml

@@ -1,28 +0,0 @@
-# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
-#
-# You can adjust the behavior by modifying this file.
-# For more information, see:
-# https://github.com/actions/stale
-name: Mark stale issues and pull requests
-
-on:
-  schedule:
-  - cron: '27 21 * * *'
-
-jobs:
-  stale:
-
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-      pull-requests: write
-
-    steps:
-    - uses: actions/stale@v5
-      with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }}
-        days-before-stale: 40
-        stale-issue-message: 'Stale issue message'
-        stale-pr-message: 'Stale pull request message'
-        stale-issue-label: 'no-issue-activity'
-        stale-pr-label: 'no-pr-activity'

.github/workflows/test.yml

@@ -0,0 +1,46 @@
+name: Testing
+
+on: [pull_request]
+
+jobs:
+  unit-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install dependencies
+      run: npm install
+    - name: Run Unit Tests
+      run: npm run test:unit
+  e2e-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install git
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y git
+        git --version
+    - name: Setup git
+      run: |
+        git config --global user.email "test@example.com"
+        git config --global user.name "Test User"
+    - name: Install dependencies
+      run: npm install
+    - name: Build
+      run: npm run build
+    - name: Run E2E Tests
+      run: npm run test:e2e

.gitignore

@@ -1,9 +1,7 @@
 node_modules/
 coverage/
-out/
 temp/
 build/
-dist/
 application.log
 .DS_Store
 /*.env

.npmignore

@@ -0,0 +1 @@
+out/github-action.cjs

.opencommitignore

@@ -0,0 +1 @@
+out

.prettierignore

@@ -1,2 +1,3 @@
 /build
-/dist
+/dist
+/out

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Dima Sukharev
+Copyright (c) Dima Sukharev, https://github.com/di-sukharev
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

README.md

@@ -2,12 +2,12 @@
   <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/io_Y_oi"><img src="https://img.shields.io/twitter/follow/io_Y_oi?style=flat&label=io_Y_oi&logo=twitter&color=0bf&logoColor=fff" align="center"></a>
-    </h4>
+    <h4 align="center">Follow the bird <a href="https://twitter.com/_sukharev_"><img src="https://img.shields.io/twitter/follow/_sukharev_?style=flat&label=_sukharev_&logo=twitter&color=0bf&logoColor=fff" align="center"></a>
   </div>
-	<h2>GPT CLI to auto-generate impressive commits in 1 second</h2>
+	<h2>Auto-generate meaningful commits in a second</h2>
 	<p>Killing lame commits with AI 🤯🔫</p>
 	<a href="https://www.npmjs.com/package/opencommit"><img src="https://img.shields.io/npm/v/opencommit" alt="Current version"></a>
+  <h4 align="center">🪩 Winner of <a href="https://twitter.com/_sukharev_/status/1683448136973582336">GitHub 2023 hackathon</a> 🪩</h4>
 </div>
 
 ---
@@ -16,9 +16,11 @@
     <img src=".github/opencommit-example.png" alt="OpenCommit example"/>
 </div>
 
-All the commits in this repo are done with OpenCommit — look into [the commits](https://github.com/di-sukharev/opencommit/commit/eae7618d575ee8d2e9fff5de56da79d40c4bc5fc) to see how OpenCommit works. Emoji and long commit description text is 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.
 
-## Setup
+## Setup OpenCommit as a CLI tool
+
+You can use OpenCommit by simply running it via the CLI like this `oco`. 2 seconds and your staged changes are committed with a meaningful message.
 
 1. Install OpenCommit globally to use in any repository:
 
@@ -26,15 +28,19 @@ All the commits in this repo are done with OpenCommit — look into [the commits
    npm install -g opencommit
    ```
 
-2. Get your API key from [OpenAI](https://platform.openai.com/account/api-keys). Make sure you add payment details, so API works.
+   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.
 
 3. Set the key to OpenCommit config:
 
    ```sh
-   opencommit config set OPENAI_API_KEY=<your_api_key>
+   oco config set OCO_OPENAI_API_KEY=<your_api_key>
    ```
 
-   Your api key is stored locally in `~/.opencommit` config file.
+   Your API key is stored locally in the `~/.opencommit` config file.
 
 ## Usage
 
@@ -45,82 +51,186 @@ git add <files...>
 opencommit
 ```
 
-You can also use the `oc` shortcut:
+You can also use the `oco` shortcut:
 
 ```sh
 git add <files...>
-oc
+oco
 ```
 
-## Features
+Link to the GitMoji specification: https://gitmoji.dev/
 
-### Switch to GPT-4
+You can also run it with local model through ollama:
 
-By default OpenCommit uses GPT-3.5-turbo (ChatGPT).
+- install and start ollama
+- run `ollama run mistral` (do this only once, to pull model)
+- run (in your project directory):
+
+```sh
+git add <files...>
+OCO_AI_PROVIDER='ollama' opencommit
+```
+
+### Flags
+
+There are multiple optional flags that can be used with the `oco` command:
+
+#### Use Full GitMoji Specification
+
+This flag can only be used if the `OCO_EMOJI` configuration item is set to `true`. This flag allows users to use all emojis in the GitMoji specification, By default, the GitMoji full specification is set to `false`, which only includes 10 emojis (🐛✨📝🚀✅♻️⬆️🔧🌐💡).
+This is due to limit the number of tokens sent in each request. However, if you would like to use the full GitMoji specification, you can use the `--fgm` flag.
+
+```
+oco --fgm
+```
+
+## Configuration
+
+### Local per repo configuration
+
+Create a `.env` file and add OpenCommit config variables there like this:
+
+```env
+OCO_OPENAI_API_KEY=<your OpenAI API token>
+OCO_TOKENS_MAX_INPUT=<max model token limit (default: 4096)>
+OCO_TOKENS_MAX_OUTPUT=<max response tokens (default: 500)>
+OCO_OPENAI_BASE_PATH=<may be used to set proxy path to OpenAI api>
+OCO_DESCRIPTION=<postface a message with ~3 sentences description of the changes>
+OCO_EMOJI=<boolean, add GitMoji>
+OCO_MODEL=<either 'gpt-4', 'gpt-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_LANGUAGE=<locale, scroll to the bottom to see options>
+OCO_MESSAGE_TEMPLATE_PLACEHOLDER=<message template placeholder, default: '$msg'>
+OCO_PROMPT_MODULE=<either conventional-commit or @commitlint, default: conventional-commit>
+OCO_ONE_LINE_COMMIT=<one line commit message, default: false>
+```
+
+### Global config for all repos
+
+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.
+
+Simply set any of the variables above like this:
+
+```sh
+oco config set OCO_MODEL=gpt-4
+```
+
+Configure [GitMoji](https://gitmoji.dev/) to preface a message.
+
+```sh
+oco config set OCO_EMOJI=true
+```
+
+To remove preface emojis:
+
+```sh
+oco config set OCO_EMOJI=false
+```
+
+### Switch to GPT-4 or other models
+
+By default, OpenCommit uses `gpt-3.5-turbo` model.
 
 You may switch to GPT-4 which performs better, but costs ~x15 times more 🤠
 
 ```sh
-oc config set model=gpt-4
+oco config set OCO_MODEL=gpt-4
 ```
 
-Make sure you do lowercase `gpt-4`.
-
-### Preface commits with emoji 🤠
-
-[GitMoji](https://gitmoji.dev/) convention is used.
-
-To add emoji:
+or for as a cheaper option:
 
 ```sh
-oc config set emoji=true
+oco config set OCO_MODEL=gpt-3.5-turbo
 ```
 
-To remove emoji:
+or for GPT-4 Turbo (Preview) which is more capable, has knowledge of world events up to April 2023, a 128k context window and 2-3x cheaper vs GPT-4:
 
 ```sh
-oc config set emoji=false
+oco config set OCO_MODEL=gpt-4-0125-preview
 ```
 
-### Postface commits with descriptions of changes
+Make sure that you spell it `gpt-4` (lowercase) and that you have API access to the 4th model. Even if you have ChatGPT+, that doesn't necessarily mean that you have API access to GPT-4.
 
-To add descriptions:
+### Locale configuration
 
-```sh
-oc config set description=true
-```
-
-To remove description:
-
-```sh
-oc config set description=false
-```
-
-### Internationalization support
-
-To specify the language used to generate commit messages:
+To globally specify the language used to generate commit messages:
 
 ```sh
 # de, German ,Deutsch
-oc config set language=de
-oc config set language=German
-oc config set language=Deutsch
+oco config set OCO_LANGUAGE=de
+oco config set OCO_LANGUAGE=German
+oco config set OCO_LANGUAGE=Deutsch
 
 # fr, French, française
-oc config set language=fr
-oc config set language=French
-oc config set language=française
+oco config set OCO_LANGUAGE=fr
+oco config set OCO_LANGUAGE=French
+oco config set OCO_LANGUAGE=française
 ```
 
-The default language set is **English**  
+The default language setting is **English**
 All available languages are currently listed in the [i18n](https://github.com/di-sukharev/opencommit/tree/master/src/i18n) folder
 
-### Git flags
+### Push to git
 
-The `opencommit` or `oc` commands can be used in place of the `git commit -m "${generatedMessage}"` command. This means that any regular flags that are used with the `git commit` command will also be applied when using `opencommit` or `oc`.
+Pushing to git is on by default but if you would like to turn it off just use:
 
 ```sh
-oc --no-verify
+oc config set OCO_GITPUSH=false
+```
+
+### 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.
+
+You can set this option by running the following command:
+
+```sh
+oco config set OCO_PROMPT_MODULE=<module>
+```
+
+Replace `<module>` with either `conventional-commit` or `@commitlint`.
+
+#### Example:
+
+To switch to using th` '@commitlint` prompt module, run:
+
+```sh
+oco config set OCO_PROMPT_MODULE=@commitlint
+```
+
+To switch back to the default conventional-commit message generator, run:
+
+```sh
+oco config set OCO_PROMPT_MODULE=conventional-commit
+```
+
+#### Integrating with `@commitlint`
+
+The integration between `@commitlint` and OpenCommit is done automatically the first time OpenCommit is run with `OCO_PROMPT_MODULE` set to `@commitlint`. However, if you need to force set or reset the configuration for `@commitlint`, you can run the following command:
+
+```sh
+oco commitlint force
+```
+
+To view the generated configuration for `@commitlint`, you can use this command:
+
+```sh
+oco commitlint get
+```
+
+This allows you to ensure that the configuration is set up as desired.
+
+Additionally, the integration creates a file named `.opencommit-commitlint` which contains the prompts used for the local `@commitlint` configuration. You can modify this file to fine-tune the example commit message generated by OpenAI. This gives you the flexibility to make adjustments based on your preferences or project guidelines.
+
+OpenCommit generates a file named `.opencommit-commitlint` in your project directory which contains the prompts used for the local `@commitlint` configuration. You can modify this file to fine-tune the example commit message generated by OpenAI. If the local `@commitlint` configuration changes, this file will be updated the next time OpenCommit is run.
+
+This offers you greater control over the generated commit messages, allowing for customization that aligns with your project's conventions.
+
+## Git flags
+
+The `opencommit` or `oco` commands can be used in place of the `git commit -m "${generatedMessage}"` command. This means that any regular flags that are used with the `git commit` command will also be applied when using `opencommit` or `oco`.
+
+```sh
+oco --no-verify
 ```
 
 is translated to :
@@ -129,33 +239,68 @@ is translated to :
 git commit -m "${generatedMessage}" --no-verify
 ```
 
+To include a message in the generated message, you can utilize the template function, for instance:
+
+```sh
+oco '#205: $msg’
+```
+
+> opencommit examines placeholders in the parameters, allowing you to append additional information before and after the placeholders, such as the relevant Issue or Pull Request. Similarly, you have the option to customize the OCO_MESSAGE_TEMPLATE_PLACEHOLDER configuration item, for example, simplifying it to $m!"
+
+### Message Template Placeholder Config
+
+#### Overview
+
+The `OCO_MESSAGE_TEMPLATE_PLACEHOLDER` feature in the `opencommit` tool allows users to embed a custom message within the generated commit message using a template function. This configuration is designed to enhance the flexibility and customizability of commit messages, making it easier for users to include relevant information directly within their commits.
+
+#### Implementation Details
+
+In our codebase, the implementation of this feature can be found in the following segment:
+
+```javascript
+commitMessage = messageTemplate.replace(
+  config?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER,
+  commitMessage
+);
+```
+
+This line is responsible for replacing the placeholder in the `messageTemplate` with the actual `commitMessage`.
+
+#### Usage
+
+For instance, using the command `oco '$msg #205’`, users can leverage this feature. The provided code represents the backend mechanics of such commands, ensuring that the placeholder is replaced with the appropriate commit message.
+
+#### Committing with the Message
+
+Once users have generated their desired commit message, they can proceed to commit using the generated message. By understanding the feature's full potential and its implementation details, users can confidently use the generated messages for their commits.
+
 ### Ignore files
 
-You can ignore files from submission to OpenAI by creating a `.opencommitignore` file. For example:
+You can remove files from being sent to OpenAI by creating a `.opencommitignore` file. For example:
 
 ```ignorelang
 path/to/large-asset.zip
 **/*.jpg
 ```
 
-This is useful for preventing opencommit from uploading artifacts and large files.
+This helps prevent opencommit from uploading artifacts and large files.
 
 By default, opencommit ignores files matching: `*-lock.*` and `*.lock`
 
-## Git hook
+## Git hook (KILLER FEATURE)
 
-You can set OpenCommit as Git [`prepare-commit-msg`](https://git-scm.com/docs/githooks#_prepare_commit_msg) hook. Hook integrates with you IDE Source Control and allows you edit the message before commit.
+You can set OpenCommit as Git [`prepare-commit-msg`](https://git-scm.com/docs/githooks#_prepare_commit_msg) hook. Hook integrates with your IDE Source Control and allows you to edit the message before committing.
 
 To set the hook:
 
 ```sh
-oc hook set
+oco hook set
 ```
 
 To unset the hook:
 
 ```sh
-oc hook unset
+oco hook unset
 ```
 
 To use the hook:
@@ -167,6 +312,70 @@ git commit
 
 Or follow the process of your IDE Source Control feature, when it calls `git commit` command — OpenCommit will integrate into the flow.
 
+## Setup OpenCommit as a GitHub Action (BETA) 🔥
+
+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`.
+
+Create a file `.github/workflows/opencommit.yml` with the contents below:
+
+```yml
+name: 'OpenCommit Action'
+
+on:
+  push:
+    # this list of branches is often enough,
+    # but you may still ignore other public branches
+    branches-ignore: [main master dev development release]
+
+jobs:
+  opencommit:
+    timeout-minutes: 10
+    name: OpenCommit
+    runs-on: ubuntu-latest
+    permissions: write-all
+    steps:
+      - name: Setup Node.js Environment
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: di-sukharev/opencommit@github-action-v1.0.4
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+        env:
+          # 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 }}
+
+          # customization
+          OCO_TOKENS_MAX_INPUT: 4096
+          OCO_TOKENS_MAX_OUTPUT: 500
+          OCO_OPENAI_BASE_PATH: ''
+          OCO_DESCRIPTION: false
+          OCO_EMOJI: false
+          OCO_MODEL: gpt-3.5-turbo
+          OCO_LANGUAGE: en
+          OCO_PROMPT_MODULE: conventional-commit
+```
+
+That is it. Now when you push to any branch in your repo — all NEW commits are being improved by your never-tired AI.
+
+Make sure you exclude public collaboration branches (`main`, `dev`, `etc`) in `branches-ignore`, so OpenCommit does not rebase commits there while improving the messages.
+
+Interactive rebase (`rebase -i`) changes commits' SHA, so the commit history in remote becomes different from your local branch history. This is okay if you work on the branch alone, but may be inconvenient for other collaborators.
+
 ## Payments
 
-You pay for your own requests to OpenAI API. OpenCommit uses ChatGPT (3.5-turbo) official model, that is ~15x times cheaper than GPT-4.
+You pay for your requests to OpenAI API on your own.
+
+OpenCommit stores your key locally.
+
+OpenCommit by default uses 3.5-turbo model, it should not exceed $0.10 per casual working day.
+
+You may switch to gpt-4, it's better, but more expensive.

action.yml

@@ -0,0 +1,29 @@
+name: 'OpenCommit — improve commits with AI 🧙'
+description: 'Replaces lame commit messages with meaningful AI-generated messages when you push to remote'
+author: 'https://github.com/di-sukharev'
+repo: 'https://github.com/di-sukharev/opencommit/tree/github-action'
+branding:
+  icon: 'git-commit'
+  color: 'green'
+keywords:
+  [
+    'git',
+    'chatgpt',
+    'gpt',
+    'ai',
+    'openai',
+    'opencommit',
+    'aicommit',
+    'aicommits',
+    'gptcommit',
+    'commit'
+  ]
+
+inputs:
+  GITHUB_TOKEN:
+    description: 'GitHub token'
+    required: true
+
+runs:
+  using: 'node16'
+  main: 'out/github-action.cjs'

esbuild.config.js

@@ -1,14 +1,24 @@
-import { build } from 'esbuild'
-import fs from 'fs'    
+import { build } from 'esbuild';
+import fs from 'fs';
 
 await build({
-    entryPoints: ['./src/cli.ts'],
-    bundle: true,
-    platform: 'node',
-    format: 'cjs',
-    outfile: './out/cli.cjs',
+  entryPoints: ['./src/cli.ts'],
+  bundle: true,
+  platform: 'node',
+  format: 'cjs',
+  outfile: './out/cli.cjs'
 });
 
-const wasmFile = fs.readFileSync('./node_modules/@dqbd/tiktoken/lite/tiktoken_bg.wasm')
+await build({
+  entryPoints: ['./src/github-action.ts'],
+  bundle: true,
+  platform: 'node',
+  format: 'cjs',
+  outfile: './out/github-action.cjs'
+});
 
-fs.writeFileSync('./out/tiktoken_bg.wasm', wasmFile)
+const wasmFile = fs.readFileSync(
+  './node_modules/@dqbd/tiktoken/lite/tiktoken_bg.wasm'
+);
+
+fs.writeFileSync('./out/tiktoken_bg.wasm', wasmFile);

jest.config.ts

@@ -0,0 +1,28 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+import type { Config } from 'jest';
+
+const config: Config = {
+  testTimeout: 100_000,
+  coverageProvider: 'v8',
+  moduleDirectories: ['node_modules', 'src'],
+  preset: 'ts-jest/presets/js-with-ts-esm',
+  setupFilesAfterEnv: ['<rootDir>/test/jest-setup.ts'],
+  testEnvironment: 'node',
+  testRegex: ['.*\\.test\\.ts$'],
+  transformIgnorePatterns: ['node_modules/(?!cli-testing-library)'],
+  transform: {
+    '^.+\\.(ts|tsx)$': [
+      'ts-jest',
+      {
+        diagnostics: false,
+        useESM: true
+      }
+    ]
+  }
+};
+
+export default config;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "opencommit",
-  "version": "2.0.7",
-  "description": "GPT CLI to auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
+  "version": "3.0.15",
+  "description": "Auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
   "keywords": [
     "git",
     "chatgpt",
@@ -12,12 +12,12 @@
     "aicommit",
     "aicommits",
     "gptcommit",
-    "commit"
+    "commit",
+    "ollama"
   ],
   "main": "cli.js",
   "bin": {
     "opencommit": "./out/cli.cjs",
-    "oc": "./out/cli.cjs",
     "oco": "./out/cli.cjs"
   },
   "repository": {
@@ -27,7 +27,8 @@
   "author": "https://github.com/di-sukharev",
   "license": "MIT",
   "files": [
-    "out/**/*"
+    "out/cli.cjs",
+    "out/tiktoken_bg.wasm"
   ],
   "release": {
     "branches": [
@@ -40,31 +41,52 @@
   "scripts": {
     "watch": "npm run -S build -- --sourcemap --watch",
     "start": "node ./out/cli.cjs",
+    "ollama:start": "OCO_AI_PROVIDER='ollama' node ./out/cli.cjs",
     "dev": "ts-node ./src/cli.ts",
     "build": "rimraf out && node esbuild.config.js",
-    "deploy": "npm run build && npm version patch && npm publish --tag latest",
+    "build:push": "npm run build && git add . && git commit -m 'build' && git push",
+    "deploy": "npm version patch && npm run build:push && git push --tags && npm publish --tag latest",
     "lint": "eslint src --ext ts && tsc --noEmit",
-    "format": "prettier --write src"
+    "format": "prettier --write src",
+    "test:all": "npm run test:unit:docker && npm run test:e2e:docker",
+    "test:docker-build": "docker build -t oco-test -f test/Dockerfile .",
+    "test:unit": "NODE_OPTIONS=--experimental-vm-modules jest test/unit",
+    "test:unit:docker": "npm run test:docker-build && DOCKER_CONTENT_TRUST=0 docker run --rm oco-test npm run test:unit",
+    "test:e2e": "jest test/e2e",
+    "test:e2e:docker": "npm run test:docker-build && DOCKER_CONTENT_TRUST=0 docker run --rm oco-test npm run test:e2e"
   },
   "devDependencies": {
+    "@commitlint/types": "^17.4.4",
     "@types/ini": "^1.3.31",
     "@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",
+    "cli-testing-library": "^2.0.2",
     "dotenv": "^16.0.3",
     "esbuild": "^0.15.18",
     "eslint": "^8.28.0",
+    "jest": "^29.7.0",
     "prettier": "^2.8.4",
+    "ts-jest": "^29.1.2",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.3"
   },
   "dependencies": {
+    "@actions/core": "^1.10.0",
+    "@actions/exec": "^1.1.1",
+    "@actions/github": "^5.1.1",
+    "@anthropic-ai/sdk": "^0.19.2",
     "@clack/prompts": "^0.6.1",
     "@dqbd/tiktoken": "^1.0.2",
+    "@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",
+    "crypto": "^1.0.1",
     "execa": "^7.0.0",
     "ignore": "^5.2.4",
     "ini": "^3.0.1",

src/CommandsEnum.ts

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

src/api.ts

@@ -1,97 +0,0 @@
-import { intro, outro } from '@clack/prompts';
-import axios from 'axios';
-import chalk from 'chalk';
-import {
-  ChatCompletionRequestMessage,
-  Configuration as OpenAiApiConfiguration,
-  OpenAIApi
-} from 'openai';
-
-import { CONFIG_MODES, getConfig } from './commands/config';
-
-const config = getConfig();
-
-let apiKey = config?.OPENAI_API_KEY;
-let basePath = config?.OPENAI_BASE_PATH;
-let maxTokens = config?.OPENAI_MAX_TOKENS;
-
-const [command, mode] = process.argv.slice(2);
-
-if (!apiKey && command !== 'config' && mode !== CONFIG_MODES.set) {
-  intro('opencommit');
-
-  outro(
-    'OPENAI_API_KEY is not set, please run `oc config set OPENAI_API_KEY=<your token>. Make sure you add payment details, so API works.`'
-  );
-  outro(
-    'For help look into README https://github.com/di-sukharev/opencommit#setup'
-  );
-
-  process.exit(1);
-}
-
-const MODEL = config?.model || 'gpt-3.5-turbo';
-
-class OpenAi {
-  private openAiApiConfiguration = new OpenAiApiConfiguration({
-    apiKey: apiKey
-  });
-  private openAI!: OpenAIApi;
-
-  constructor() {
-    if (basePath) {
-      this.openAiApiConfiguration.basePath = basePath;
-    }
-    this.openAI = new OpenAIApi(this.openAiApiConfiguration);
-  }
-
-  public generateCommitMessage = async (
-    messages: Array<ChatCompletionRequestMessage>
-  ): Promise<string | undefined> => {
-    try {
-      const { data } = await this.openAI.createChatCompletion({
-        model: MODEL,
-        messages,
-        temperature: 0,
-        top_p: 0.1,
-        max_tokens: maxTokens ?? 196
-      });
-
-      const message = data.choices[0].message;
-
-      return message?.content;
-    } catch (error: unknown) {
-      outro(`${chalk.red('✖')} ${error}`);
-
-      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'
-        );
-      }
-
-      process.exit(1);
-    }
-  };
-}
-
-export const getOpenCommitLatestVersion = async (): Promise<
-  string | undefined
-> => {
-  try {
-    const { data } = await axios.get(
-      'https://unpkg.com/opencommit/package.json'
-    );
-    return data.version;
-  } catch (_) {
-    outro('Error while getting the latest version of opencommit');
-    return undefined;
-  }
-};
-
-export const api = new OpenAi();

src/cli.ts

@@ -1,13 +1,14 @@
 #!/usr/bin/env node
 
 import { cli } from 'cleye';
-import packageJSON from '../package.json' assert { type: 'json' };
 
+import packageJSON from '../package.json';
+import { commit } from './commands/commit';
+import { commitlintConfigCommand } from './commands/commitlint';
 import { configCommand } from './commands/config';
 import { hookCommand, isHookCalled } from './commands/githook.js';
 import { prepareCommitMessageHook } from './commands/prepare-commit-msg-hook';
-import { commit } from './commands/commit';
-// import { checkIsLatestVersion } from './utils/checkIsLatestVersion';
+import { checkIsLatestVersion } from './utils/checkIsLatestVersion';
 
 const extraArgs = process.argv.slice(2);
 
@@ -15,18 +16,20 @@ cli(
   {
     version: packageJSON.version,
     name: 'opencommit',
-    commands: [configCommand, hookCommand],
-    flags: {},
+    commands: [configCommand, hookCommand, commitlintConfigCommand],
+    flags: {
+      fgm: Boolean
+    },
     ignoreArgv: (type) => type === 'unknown-flag' || type === 'argument',
     help: { description: packageJSON.description }
   },
-  async () => {
-    // await checkIsLatestVersion();
+  async ({ flags }) => {
+    await checkIsLatestVersion();
 
     if (await isHookCalled()) {
       prepareCommitMessageHook();
     } else {
-      commit(extraArgs);
+      commit(extraArgs, false, flags.fgm);
     }
   },
   extraArgs

src/commands/README.md

@@ -0,0 +1,9 @@
+# @commitlint Module for opencommit
+
+1. Load commitlint configuration within tree.
+2. Generate a commit with commitlint prompt:
+   - Will not run if hash is the same.
+   - Infer a prompt for each commitlint rule.
+   - Ask OpenAI to generate consistency with embedded commitlint rules.
+   - Store configuration close to commitlint configuration.
+3. Replace conventional-commit prompt with commitlint prompt.

src/commands/commit.ts

@@ -1,8 +1,17 @@
+import chalk from 'chalk';
 import { execa } from 'execa';
+
 import {
-  GenerateCommitMessageErrorEnum,
-  generateCommitMessageWithChatCompletion
-} from '../generateCommitMessageFromGitDiff';
+  confirm,
+  intro,
+  isCancel,
+  multiselect,
+  outro,
+  select,
+  spinner
+} from '@clack/prompts';
+
+import { generateCommitMessageByDiff } from '../generateCommitMessageFromGitDiff';
 import {
   assertGitRepo,
   getChangedFiles,
@@ -10,141 +19,161 @@ import {
   getStagedFiles,
   gitAdd
 } from '../utils/git';
-import {
-  spinner,
-  confirm,
-  outro,
-  isCancel,
-  intro,
-  multiselect,
-  select
-} from '@clack/prompts';
-import chalk from 'chalk';
 import { trytm } from '../utils/trytm';
+import { getConfig } from './config';
+
+const config = getConfig();
 
 const getGitRemotes = async () => {
   const { stdout } = await execa('git', ['remote']);
   return stdout.split('\n').filter((remote) => Boolean(remote.trim()));
 };
 
+// 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))
+      return extraArgs[key];
+  }
+  return false;
+};
+
 const generateCommitMessageFromGitDiff = async (
   diff: string,
-  extraArgs: string[]
+  extraArgs: string[],
+  fullGitMojiSpec: boolean
 ): Promise<void> => {
   await assertGitRepo();
-
   const commitSpinner = spinner();
   commitSpinner.start('Generating the commit message');
-  const commitMessage = await generateCommitMessageWithChatCompletion(diff);
 
-  // TODO: show proper error messages
-  if (typeof commitMessage !== 'string') {
-    const errorMessages = {
-      [GenerateCommitMessageErrorEnum.emptyMessage]:
-        'empty openAI response, weird, try again',
-      [GenerateCommitMessageErrorEnum.internalError]:
-        'internal error, try again',
-      [GenerateCommitMessageErrorEnum.tooMuchTokens]:
-        'too much tokens in git diff, stage and commit files in parts'
-    };
+  try {
+    let commitMessage = await generateCommitMessageByDiff(
+      diff,
+      fullGitMojiSpec
+    );
 
-    outro(`${chalk.red('✖')} ${errorMessages[commitMessage.error]}`);
-    process.exit(1);
-  }
+    const messageTemplate = checkMessageTemplate(extraArgs);
+    if (
+      config?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER &&
+      typeof messageTemplate === 'string'
+    ) {
+      const messageTemplateIndex = extraArgs.indexOf(messageTemplate);
+      extraArgs.splice(messageTemplateIndex, 1);
 
-  commitSpinner.stop('📝 Commit message generated');
+      commitMessage = messageTemplate.replace(
+        config?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER,
+        commitMessage
+      );
+    }
 
-  outro(
-    `Commit message:
+    commitSpinner.stop('📝 Commit message generated');
+
+    outro(
+      `Generated commit message:
 ${chalk.grey('——————————————————')}
 ${commitMessage}
 ${chalk.grey('——————————————————')}`
-  );
+    );
 
-  const isCommitConfirmedByUser = await confirm({
-    message: 'Confirm the commit message?'
-  });
+    const isCommitConfirmedByUser = await confirm({
+      message: 'Confirm the commit message?'
+    });
 
-  if (isCommitConfirmedByUser && !isCancel(isCommitConfirmedByUser)) {
-    const { stdout } = await execa('git', [
-      'commit',
-      '-m',
-      commitMessage,
-      ...extraArgs
-    ]);
+    if (isCommitConfirmedByUser && !isCancel(isCommitConfirmedByUser)) {
+      const { stdout } = await execa('git', [
+        'commit',
+        '-m',
+        commitMessage,
+        ...extraArgs
+      ]);
 
-    outro(`${chalk.green('✔')} successfully committed`);
+      outro(`${chalk.green('✔')} Successfully committed`);
 
-    outro(stdout);
+      outro(stdout);
 
-    const remotes = await getGitRemotes();
+      const remotes = await getGitRemotes();
 
-    if (!remotes.length) {
-      const { stdout } = await execa('git', ['push']);
-      if (stdout) outro(stdout);
-      process.exit(0);
-    }
-
-    if (remotes.length === 1) {
-      const isPushConfirmedByUser = await confirm({
-        message: 'Do you want to run `git push`?'
-      });
-
-      if (isPushConfirmedByUser && !isCancel(isPushConfirmedByUser)) {
-        const pushSpinner = spinner();
-
-        pushSpinner.start(`Running \`git push ${remotes[0]}\``);
-
-        const { stdout } = await execa('git', [
-          'push',
-          '--verbose',
-          remotes[0]
-        ]);
-
-        pushSpinner.stop(
-          `${chalk.green('✔')} successfully pushed all commits to ${remotes[0]}`
-        );
+      // user isn't pushing, return early
+      if (config?.OCO_GITPUSH === false)
+          return
 
+      if (!remotes.length) {
+        const { stdout } = await execa('git', ['push']);
         if (stdout) outro(stdout);
-      } else {
-        outro('`git push` aborted');
         process.exit(0);
       }
-    } else {
-      const selectedRemote = (await select({
-        message: 'Choose a remote to push to',
-        options: remotes.map((remote) => ({ value: remote, label: remote }))
-      })) as string;
 
-      if (!isCancel(selectedRemote)) {
-        const pushSpinner = spinner();
+      if (remotes.length === 1 && config?.OCO_GITPUSH !== true) {
+        const isPushConfirmedByUser = await confirm({
+          message: 'Do you want to run `git push`?'
+        });
 
-        pushSpinner.start(`Running \`git push ${selectedRemote}\``);
+        if (isPushConfirmedByUser && !isCancel(isPushConfirmedByUser)) {
+          const pushSpinner = spinner();
 
-        const { stdout } = await execa('git', ['push', selectedRemote]);
+          pushSpinner.start(`Running 'git push ${remotes[0]}'`);
 
-        pushSpinner.stop(
-          `${chalk.green(
-            '✔'
-          )} successfully pushed all commits to ${selectedRemote}`
-        );
+          const { stdout } = await execa('git', [
+            'push',
+            '--verbose',
+            remotes[0]
+          ]);
 
-        if (stdout) outro(stdout);
-      } else outro(`${chalk.gray('✖')} process cancelled`);
+          pushSpinner.stop(
+            `${chalk.green('✔')} Successfully pushed all commits to ${
+              remotes[0]
+            }`
+          );
+
+          if (stdout) outro(stdout);
+        } else {
+          outro('`git push` aborted');
+          process.exit(0);
+        }
+      } else {
+        const selectedRemote = (await select({
+          message: 'Choose a remote to push to',
+          options: remotes.map((remote) => ({ value: remote, label: remote }))
+        })) as string;
+
+        if (!isCancel(selectedRemote)) {
+          const pushSpinner = spinner();
+
+          pushSpinner.start(`Running 'git push ${selectedRemote}'`);
+
+          const { stdout } = await execa('git', ['push', selectedRemote]);
+
+          pushSpinner.stop(
+            `${chalk.green(
+              '✔'
+            )} Successfully pushed all commits to ${selectedRemote}`
+          );
+
+          if (stdout) outro(stdout);
+        } else outro(`${chalk.gray('✖')} process cancelled`);
+      }
     }
+  } catch (error) {
+    commitSpinner.stop('📝 Commit message generated');
+
+    const err = error as Error;
+    outro(`${chalk.red('✖')} ${err?.message || err}`);
+    process.exit(1);
   }
 };
 
 export async function commit(
   extraArgs: string[] = [],
-  isStageAllFlag: Boolean = false
+  isStageAllFlag: Boolean = false,
+  fullGitMojiSpec: boolean = false
 ) {
   if (isStageAllFlag) {
     const changedFiles = await getChangedFiles();
 
     if (changedFiles) await gitAdd({ files: changedFiles });
     else {
-      outro('No changes detected, write some code and run `oc` again');
+      outro('No changes detected, write some code and run `oco` again');
       process.exit(1);
     }
   }
@@ -177,7 +206,7 @@ export async function commit(
       isStageAllAndCommitConfirmedByUser &&
       !isCancel(isStageAllAndCommitConfirmedByUser)
     ) {
-      await commit(extraArgs, true);
+      await commit(extraArgs, true, fullGitMojiSpec);
       process.exit(1);
     }
 
@@ -195,7 +224,7 @@ export async function commit(
       await gitAdd({ files });
     }
 
-    await commit(extraArgs, false);
+    await commit(extraArgs, false, fullGitMojiSpec);
     process.exit(1);
   }
 
@@ -208,7 +237,8 @@ export async function commit(
   const [, generateCommitError] = await trytm(
     generateCommitMessageFromGitDiff(
       await getDiff({ files: stagedFiles }),
-      extraArgs
+      extraArgs,
+      fullGitMojiSpec
     )
   );
 

src/commands/commitlint.ts

@@ -0,0 +1,46 @@
+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';
+
+export enum CONFIG_MODES {
+  get = 'get',
+  force = 'force'
+}
+
+export const commitlintConfigCommand = command(
+  {
+    name: COMMANDS.commitlint,
+    parameters: ['<mode>']
+  },
+  async (argv) => {
+    intro('opencommit — configure @commitlint');
+    try {
+      const { mode } = argv._;
+
+      if (mode === CONFIG_MODES.get) {
+        const commitLintConfig = await getCommitlintLLMConfig();
+
+        outro(commitLintConfig.toString());
+
+        return;
+      }
+
+      if (mode === CONFIG_MODES.force) {
+        await configureCommitlintIntegration(true);
+        return;
+      }
+
+      throw new Error(
+        `Unsupported mode: ${mode}. Valid modes are: "force" and "get"`
+      );
+    } catch (error) {
+      outro(`${chalk.red('✖')} ${error}`);
+      process.exit(1);
+    }
+  }
+);

src/commands/config.ts

@@ -1,21 +1,31 @@
-import { command } from 'cleye';
-import { join as pathJoin } from 'path';
-import { parse as iniParse, stringify as iniStringify } from 'ini';
-import { existsSync, writeFileSync, readFileSync } from 'fs';
-import { homedir } from 'os';
-import { intro, outro } from '@clack/prompts';
 import chalk from 'chalk';
+import { command } from 'cleye';
+import * as dotenv from 'dotenv';
+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';
 
 export enum CONFIG_KEYS {
-  OPENAI_API_KEY = 'OPENAI_API_KEY',
-  OPENAI_MAX_TOKENS = 'OPENAI_MAX_TOKENS',
-  OPENAI_BASE_PATH = 'OPENAI_BASE_PATH',
-  description = 'description',
-  emoji = 'emoji',
-  model = 'model',
-  language = 'language'
+  OCO_OPENAI_API_KEY = 'OCO_OPENAI_API_KEY',
+  OCO_ANTHROPIC_API_KEY = 'OCO_ANTHROPIC_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_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'
 }
 
 export enum CONFIG_MODES {
@@ -23,6 +33,36 @@ export enum CONFIG_MODES {
   set = 'set'
 }
 
+export const MODEL_LIST = {
+  openai: ['gpt-3.5-turbo',
+          'gpt-3.5-turbo-0125',
+          'gpt-4',
+          'gpt-4-turbo',
+          'gpt-4-1106-preview',
+          'gpt-4-turbo-preview',
+          'gpt-4-0125-preview'],
+
+  anthropic: ['claude-3-haiku-20240307',
+              'claude-3-sonnet-20240229',
+              'claude-3-opus-20240229']
+}
+
+const getDefaultModel = (provider: string | undefined): string => {
+  switch (provider) {
+    case 'ollama':
+      return '';
+    case 'anthropic':
+      return MODEL_LIST.anthropic[0];
+    default:
+      return MODEL_LIST.openai[0];
+  }
+};
+
+export enum DEFAULT_TOKEN_LIMITS {
+  DEFAULT_MAX_TOKENS_INPUT = 4096,
+  DEFAULT_MAX_TOKENS_OUTPUT = 500
+}
+
 const validateConfig = (
   key: string,
   condition: any,
@@ -38,25 +78,35 @@ const validateConfig = (
 };
 
 export const configValidators = {
-  [CONFIG_KEYS.OPENAI_API_KEY](value: any) {
-    validateConfig(CONFIG_KEYS.OPENAI_API_KEY, value, 'Cannot be empty');
+  [CONFIG_KEYS.OCO_OPENAI_API_KEY](value: any, config: any = {}) {
+    //need api key unless running locally with ollama
     validateConfig(
-      CONFIG_KEYS.OPENAI_API_KEY,
-      value.startsWith('sk-'),
-      'Must start with "sk-"'
+      'OpenAI API_KEY',
+      value || config.OCO_ANTHROPIC_API_KEY || config.OCO_AI_PROVIDER == 'ollama' || config.OCO_AI_PROVIDER == 'test',
+      'You need to provide an OpenAI/Anthropic API key'
     );
     validateConfig(
-      CONFIG_KEYS.OPENAI_API_KEY,
-      value.length === 51,
-      'Must be 51 characters long'
+      CONFIG_KEYS.OCO_OPENAI_API_KEY,
+      value.startsWith('sk-'),
+      'Must start with "sk-"'
     );
 
     return value;
   },
 
-  [CONFIG_KEYS.description](value: any) {
+  [CONFIG_KEYS.OCO_ANTHROPIC_API_KEY](value: any, config: any = {}) {
     validateConfig(
-      CONFIG_KEYS.description,
+      'ANTHROPIC_API_KEY',
+      value || config.OCO_OPENAI_API_KEY || config.OCO_AI_PROVIDER == 'ollama' || config.OCO_AI_PROVIDER == 'test',
+      'You need to provide an OpenAI/Anthropic API key'
+    );
+
+    return value;
+  },
+
+  [CONFIG_KEYS.OCO_DESCRIPTION](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_DESCRIPTION,
       typeof value === 'boolean',
       'Must be true or false'
     );
@@ -64,19 +114,47 @@ export const configValidators = {
     return value;
   },
 
-  [CONFIG_KEYS.OPENAI_MAX_TOKENS](value: any) {
+  [CONFIG_KEYS.OCO_TOKENS_MAX_INPUT](value: any) {
+    // If the value is a string, convert it to a number.
+    if (typeof value === 'string') {
+      value = parseInt(value);
+      validateConfig(
+        CONFIG_KEYS.OCO_TOKENS_MAX_INPUT,
+        !isNaN(value),
+        'Must be a number'
+      );
+    }
     validateConfig(
-      CONFIG_KEYS.OPENAI_MAX_TOKENS,
-      typeof value === 'number',
+      CONFIG_KEYS.OCO_TOKENS_MAX_INPUT,
+      value ? typeof value === 'number' : undefined,
       'Must be a number'
     );
 
     return value;
   },
 
-  [CONFIG_KEYS.emoji](value: any) {
+  [CONFIG_KEYS.OCO_TOKENS_MAX_OUTPUT](value: any) {
+    // If the value is a string, convert it to a number.
+    if (typeof value === 'string') {
+      value = parseInt(value);
+      validateConfig(
+        CONFIG_KEYS.OCO_TOKENS_MAX_OUTPUT,
+        !isNaN(value),
+        'Must be a number'
+      );
+    }
     validateConfig(
-      CONFIG_KEYS.emoji,
+      CONFIG_KEYS.OCO_TOKENS_MAX_OUTPUT,
+      value ? typeof value === 'number' : undefined,
+      'Must be a number'
+    );
+
+    return value;
+  },
+
+  [CONFIG_KEYS.OCO_EMOJI](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_EMOJI,
       typeof value === 'boolean',
       'Must be true or false'
     );
@@ -84,59 +162,157 @@ export const configValidators = {
     return value;
   },
 
-  [CONFIG_KEYS.language](value: any) {
+  [CONFIG_KEYS.OCO_LANGUAGE](value: any) {
     validateConfig(
-      CONFIG_KEYS.language,
+      CONFIG_KEYS.OCO_LANGUAGE,
       getI18nLocal(value),
       `${value} is not supported yet`
     );
     return getI18nLocal(value);
   },
 
-  [CONFIG_KEYS.OPENAI_BASE_PATH](value: any) {
+  [CONFIG_KEYS.OCO_OPENAI_BASE_PATH](value: any) {
     validateConfig(
-      CONFIG_KEYS.OPENAI_BASE_PATH,
-      typeof value == 'string',
-      `${value} is not supported yet`
+      CONFIG_KEYS.OCO_OPENAI_BASE_PATH,
+      typeof value === 'string',
+      'Must be string'
     );
     return value;
   },
 
-  [CONFIG_KEYS.model](value: any) {
+  [CONFIG_KEYS.OCO_MODEL](value: any) {
     validateConfig(
-      CONFIG_KEYS.OPENAI_BASE_PATH,
-      value === 'gpt-3.5-turbo' || value === 'gpt-4',
-      `${value} is not supported yet, use 'gpt-4' or 'gpt-3.5-turbo' (default)`
+      CONFIG_KEYS.OCO_MODEL,
+      [...MODEL_LIST.openai, ...MODEL_LIST.anthropic].includes(value),
+      `${value} is not supported yet, use 'gpt-4', 'gpt-4-turbo', 'gpt-3.5-turbo' (default), 'gpt-3.5-turbo-0125', 'gpt-4-1106-preview', 'gpt-4-turbo-preview', 'gpt-4-0125-preview', 'claude-3-opus-20240229', 'claude-3-sonnet-20240229' or 'claude-3-haiku-20240307'`
     );
     return value;
-  }
+  },
+
+  [CONFIG_KEYS.OCO_MESSAGE_TEMPLATE_PLACEHOLDER](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_MESSAGE_TEMPLATE_PLACEHOLDER,
+      value.startsWith('$'),
+      `${value} must start with $, for example: '$msg'`
+    );
+    return value;
+  },
+
+  [CONFIG_KEYS.OCO_PROMPT_MODULE](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_PROMPT_MODULE,
+      ['conventional-commit', '@commitlint'].includes(value),
+      `${value} is not supported yet, use '@commitlint' or 'conventional-commit' (default)`
+    );
+    return value;
+  },
+
+  [CONFIG_KEYS.OCO_GITPUSH](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_GITPUSH,
+      typeof value === 'boolean',
+      'Must be true or false'
+    );
+    return value;
+  },
+
+  [CONFIG_KEYS.OCO_AI_PROVIDER](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_AI_PROVIDER,
+      [
+        '',
+        'openai',
+        'anthropic',
+        'ollama',
+        'test'
+      ].includes(value),
+      `${value} is not supported yet, use 'ollama' 'anthropic' or 'openai' (default)`
+    );
+    return value;
+  },
+
+  [CONFIG_KEYS.OCO_ONE_LINE_COMMIT](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_ONE_LINE_COMMIT,
+      typeof value === 'boolean',
+      'Must be true or false'
+    );
+
+    return value;
+  },
 };
 
 export type ConfigType = {
   [key in CONFIG_KEYS]?: any;
 };
 
-const configPath = pathJoin(homedir(), '.opencommit');
+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_TOKENS_MAX_INPUT: process.env.OCO_TOKENS_MAX_INPUT
+      ? Number(process.env.OCO_TOKENS_MAX_INPUT)
+      : undefined,
+    OCO_TOKENS_MAX_OUTPUT: process.env.OCO_TOKENS_MAX_OUTPUT
+      ? Number(process.env.OCO_TOKENS_MAX_OUTPUT)
+      : undefined,
+    OCO_OPENAI_BASE_PATH: process.env.OCO_OPENAI_BASE_PATH,
+    OCO_DESCRIPTION: process.env.OCO_DESCRIPTION === 'true' ? true : false,
+    OCO_EMOJI: process.env.OCO_EMOJI === 'true' ? true : false,
+    OCO_MODEL: process.env.OCO_MODEL || 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
+  };
 
-export const getConfig = (): ConfigType | null => {
   const configExists = existsSync(configPath);
-  if (!configExists) return null;
+  if (!configExists) return configFromEnv;
 
   const configFile = readFileSync(configPath, 'utf8');
   const config = iniParse(configFile);
 
   for (const configKey of Object.keys(config)) {
-    const validValue = configValidators[configKey as CONFIG_KEYS](
-      config[configKey]
-    );
+    if (
+      ['null', 'undefined'].includes(config[configKey])
+    ) {
+      config[configKey] = undefined;
+      continue;
+    }
+    try {
+      const validator = configValidators[configKey as CONFIG_KEYS];
+      const validValue = validator(
+        config[configKey] ?? configFromEnv[configKey as CONFIG_KEYS],
+        config
+      );
 
-    config[configKey] = validValue;
+      config[configKey] = validValue;
+    } catch (error) {
+      outro(`Unknown '${configKey}' config option.`);
+      outro(
+        `Manually fix the '.env' file or global '~/.opencommit' config file.`
+      );
+      process.exit(1);
+    }
   }
 
   return config;
 };
 
-export const setConfig = (keyValues: [key: string, value: string][]) => {
+export const setConfig = (keyValues: [key: string, value: string][], configPath: string = defaultConfigPath) => {
   const config = getConfig() || {};
 
   for (const [configKey, configValue] of keyValues) {
@@ -159,7 +335,7 @@ export const setConfig = (keyValues: [key: string, value: string][]) => {
 
   writeFileSync(configPath, iniStringify(config), 'utf8');
 
-  outro(`${chalk.green('✔')} config successfully set`);
+  outro(`${chalk.green('✔')} Config successfully set`);
 };
 
 export const configCommand = command(

src/commands/githook.ts

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

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

@@ -1,9 +1,11 @@
-import fs from 'fs/promises';
 import chalk from 'chalk';
+import fs from 'fs/promises';
+
 import { intro, outro, spinner } from '@clack/prompts';
+
+import { generateCommitMessageByDiff } from '../generateCommitMessageFromGitDiff';
 import { getChangedFiles, getDiff, getStagedFiles, gitAdd } from '../utils/git';
 import { getConfig } from './config';
-import { generateCommitMessageWithChatCompletion } from '../generateCommitMessageFromGitDiff';
 
 const [messageFilePath, commitSource] = process.argv.slice(2);
 
@@ -24,7 +26,7 @@ export const prepareCommitMessageHook = async (
 
       if (changedFiles) await gitAdd({ files: changedFiles });
       else {
-        outro('No changes detected, write some code and run `oc` again');
+        outro('No changes detected, write some code and run `oco` again');
         process.exit(1);
       }
     }
@@ -37,7 +39,7 @@ export const prepareCommitMessageHook = async (
 
     const config = getConfig();
 
-    if (!config?.OPENAI_API_KEY) {
+    if (!config?.OCO_OPENAI_API_KEY) {
       throw new Error(
         'No OPEN_AI_API exists. Set your OPEN_AI_API=<key> in ~/.opencommit'
       );
@@ -45,13 +47,11 @@ export const prepareCommitMessageHook = async (
 
     const spin = spinner();
     spin.start('Generating commit message');
-    const commitMessage = await generateCommitMessageWithChatCompletion(
+
+    const commitMessage = await generateCommitMessageByDiff(
       await getDiff({ files: staged })
     );
-    if (typeof commitMessage !== 'string') {
-      spin.stop('Error');
-      throw new Error(commitMessage.error);
-    } else spin.stop('Done');
+    spin.stop('Done');
 
     const fileContent = await fs.readFile(messageFilePath);
 

src/engine/Engine.ts

@@ -0,0 +1,7 @@
+import { ChatCompletionRequestMessage } from 'openai';
+
+export interface AiEngine {
+  generateCommitMessage(
+    messages: Array<ChatCompletionRequestMessage>
+  ): Promise<string | undefined>;
+}

src/engine/anthropic.ts

@@ -0,0 +1,124 @@
+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 { GenerateCommitMessageErrorEnum } from '../generateCommitMessageFromGitDiff';
+import { tokenCount } from '../utils/tokenCount';
+import { AiEngine } from './Engine';
+import { MODEL_LIST } from '../commands/config';
+
+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 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_LIST.anthropic.includes(MODEL) &&
+    command !== 'config' &&
+    mode !== CONFIG_MODES.set) {
+  outro(
+    `${chalk.red('✖')} Unsupported model ${MODEL} for Anthropic. Supported models are: ${MODEL_LIST.anthropic.join(
+      ', '
+    )}`
+  );
+  process.exit(1);
+}
+
+class AnthropicAi implements AiEngine {
+  private anthropicAiApiConfiguration = {
+    apiKey: apiKey
+  };
+  private anthropicAI!: Anthropic;
+
+  constructor() {
+    this.anthropicAI = new Anthropic(this.anthropicAiApiConfiguration);
+  }
+
+  public generateCommitMessage = async (
+    messages: Array<ChatCompletionRequestMessage>
+  ): 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 params: MessageCreateParamsNonStreaming = {
+      model: MODEL,
+      system: systemMessage,
+      messages: restMessages,
+      temperature: 0,
+      top_p: 0.1,
+      max_tokens: MAX_TOKENS_OUTPUT
+    };
+    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) {
+        throw new Error(GenerateCommitMessageErrorEnum.tooMuchTokens);
+      }
+
+      const data  = await this.anthropicAI.messages.create(params);
+
+      const message = data?.content[0].text;
+
+      return message;
+    } 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 anthropicAiError = error.response.data.error;
+
+        if (anthropicAiError?.message) outro(anthropicAiError.message);
+        outro(
+          'For help look into README https://github.com/di-sukharev/opencommit#setup'
+        );
+      }
+
+      throw err;
+    }
+  };
+}
+
+export const anthropicAi = new AnthropicAi();

src/engine/ollama.ts

@@ -0,0 +1,38 @@
+import axios, { AxiosError } from 'axios';
+import { ChatCompletionRequestMessage } from 'openai';
+import { AiEngine } from './Engine';
+
+export class OllamaAi implements AiEngine {
+  async generateCommitMessage(
+    messages: Array<ChatCompletionRequestMessage>
+  ): Promise<string | undefined> {
+    const model = 'mistral'; // todo: allow other models
+
+    //console.log(messages);
+    //process.exit()
+
+    const url = 'http://localhost:11434/api/chat';
+    const p = {
+      model,
+      messages,
+      options: {temperature: 0, top_p: 0.1},
+      stream: false
+    };
+    try {
+      const response = await axios.post(url, p, {
+        headers: {
+          'Content-Type': 'application/json'
+        }
+      });
+
+      const message = response.data.message;
+
+      return message?.content;
+    } catch (err: any) {
+      const message = err.response?.data?.error ?? err.message;
+      throw new Error('local model issues. details: ' + message);
+    }
+  }
+}
+
+export const ollamaAi = new OllamaAi();

src/engine/openAi.ts

@@ -0,0 +1,129 @@
+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 { GenerateCommitMessageErrorEnum } from '../generateCommitMessageFromGitDiff';
+import { tokenCount } from '../utils/tokenCount';
+import { AiEngine } from './Engine';
+import { MODEL_LIST } from '../commands/config';
+
+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_OPENAI_API_KEY;
+
+const [command, mode] = process.argv.slice(2);
+
+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_LIST.openai.includes(MODEL) &&
+    command !== 'config' &&
+    mode !== CONFIG_MODES.set) {
+  outro(
+    `${chalk.red('✖')} Unsupported model ${MODEL} for OpenAI. Supported models are: ${MODEL_LIST.openai.join(
+      ', '
+    )}`
+  );
+
+  process.exit(1);
+}
+
+class OpenAi implements AiEngine {
+  private openAiApiConfiguration = new OpenAiApiConfiguration({
+    apiKey: apiKey
+  });
+  private openAI!: OpenAIApi;
+
+  constructor() {
+    if (basePath) {
+      this.openAiApiConfiguration.basePath = basePath;
+    }
+    this.openAI = new OpenAIApi(this.openAiApiConfiguration);
+  }
+
+  public generateCommitMessage = async (
+    messages: Array<ChatCompletionRequestMessage>
+  ): Promise<string | undefined> => {
+    const params = {
+      model: MODEL,
+      messages,
+      temperature: 0,
+      top_p: 0.1,
+      max_tokens: MAX_TOKENS_OUTPUT
+    };
+    try {
+      const REQUEST_TOKENS = messages
+        .map((msg) => tokenCount(msg.content) + 4)
+        .reduce((a, b) => a + b, 0);
+
+      if (REQUEST_TOKENS > MAX_TOKENS_INPUT - MAX_TOKENS_OUTPUT) {
+        throw new Error(GenerateCommitMessageErrorEnum.tooMuchTokens);
+      }
+
+      const { data } = await this.openAI.createChatCompletion(params);
+
+      const message = data.choices[0].message;
+
+      return message?.content;
+    } 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'
+        );
+      }
+
+      throw err;
+    }
+  };
+}
+
+export const api = new OpenAi();

src/engine/testAi.ts

@@ -0,0 +1,12 @@
+import { ChatCompletionRequestMessage } from 'openai';
+import { AiEngine } from './Engine';
+
+export class TestAi implements AiEngine {
+  async generateCommitMessage(
+    messages: Array<ChatCompletionRequestMessage>
+  ): Promise<string | undefined> {
+    return 'test commit message';
+  }
+}
+
+export const testAi = new TestAi();

src/generateCommitMessageFromGitDiff.ts

@@ -2,62 +2,23 @@ import {
   ChatCompletionRequestMessage,
   ChatCompletionRequestMessageRoleEnum
 } from 'openai';
-import { api } from './api';
-import { getConfig } from './commands/config';
+
+import { DEFAULT_TOKEN_LIMITS, getConfig } from './commands/config';
+import { getMainCommitPrompt } from './prompts';
 import { mergeDiffs } from './utils/mergeDiffs';
-import { i18n, I18nLocals } from './i18n';
 import { tokenCount } from './utils/tokenCount';
+import { getEngine } from './utils/engine';
 
 const config = getConfig();
-const translation = i18n[(config?.language as I18nLocals) || 'en'];
+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 INIT_MESSAGES_PROMPT: Array<ChatCompletionRequestMessage> = [
-  {
-    role: ChatCompletionRequestMessageRoleEnum.System,
-    // prettier-ignore
-    content: `You are to act as the author of a commit message in git. Your mission is to create clean and comprehensive commit messages in the conventional commit convention and explain WHAT were the changes and WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you convert it into a commit message.
-${config?.emoji? 'Use GitMoji convention to preface the commit.': 'Do not preface the commit with anything.'}
-${config?.description  ? 'Add a short description of WHY the changes are done after the commit message. Don\'t start it with "This commit", just describe the changes.': "Don't add any descriptions to the commit, only commit message."}
-Use the present tense. Lines must not be longer than 74 characters. Use ${translation.localLanguage} to answer.`
-  },
-  {
-    role: ChatCompletionRequestMessageRoleEnum.User,
-    content: `diff --git a/src/server.ts b/src/server.ts
-index ad4db42..f3b18a9 100644
---- a/src/server.ts
-+++ b/src/server.ts
-@@ -10,7 +10,7 @@
-import {
-  initWinstonLogger();
-  
-  const app = express();
- -const port = 7799;
- +const PORT = 7799;
-  
-  app.use(express.json());
-  
-@@ -34,6 +34,6 @@
-app.use((_, res, next) => {
-  // ROUTES
-  app.use(PROTECTED_ROUTER_URL, protectedRouter);
-  
- -app.listen(port, () => {
- -  console.log(\`Server listening on port \${port}\`);
- +app.listen(process.env.PORT || PORT, () => {
- +  console.log(\`Server listening on port \${PORT}\`);
-  });`
-  },
-  {
-    role: ChatCompletionRequestMessageRoleEnum.Assistant,
-    content: `${config?.emoji ? '🐛 ' : ''}${translation.commitFix}
-${config?.emoji ? '✨ ' : ''}${translation.commitFeat}
-${config?.description ? translation.commitDescription : ''}`
-  }
-];
+const generateCommitMessageChatCompletionPrompt = async (
+  diff: string,
+  fullGitMojiSpec: boolean
+): Promise<Array<ChatCompletionRequestMessage>> => {
+  const INIT_MESSAGES_PROMPT = await getMainCommitPrompt(fullGitMojiSpec);
 
-const generateCommitMessageChatCompletionPrompt = (
-  diff: string
-): Array<ChatCompletionRequestMessage> => {
   const chatContextAsCompletionRequest = [...INIT_MESSAGES_PROMPT];
 
   chatContextAsCompletionRequest.push({
@@ -71,51 +32,64 @@ const generateCommitMessageChatCompletionPrompt = (
 export enum GenerateCommitMessageErrorEnum {
   tooMuchTokens = 'TOO_MUCH_TOKENS',
   internalError = 'INTERNAL_ERROR',
-  emptyMessage = 'EMPTY_MESSAGE'
+  emptyMessage = 'EMPTY_MESSAGE',
+  outputTokensTooHigh = `Token limit exceeded, OCO_TOKENS_MAX_OUTPUT must not be much higher than the default ${DEFAULT_TOKEN_LIMITS.DEFAULT_MAX_TOKENS_OUTPUT} tokens.`
 }
 
-interface GenerateCommitMessageError {
-  error: GenerateCommitMessageErrorEnum;
-}
+const ADJUSTMENT_FACTOR = 20;
 
-const INIT_MESSAGES_PROMPT_LENGTH = INIT_MESSAGES_PROMPT.map(
-  (msg) => tokenCount(msg.content) + 4
-).reduce((a, b) => a + b, 0);
-
-const MAX_REQ_TOKENS = 3900 - INIT_MESSAGES_PROMPT_LENGTH;
-
-export const generateCommitMessageWithChatCompletion = async (
-  diff: string
-): Promise<string | GenerateCommitMessageError> => {
+export const generateCommitMessageByDiff = async (
+  diff: string,
+  fullGitMojiSpec: boolean
+): Promise<string> => {
   try {
-    if (tokenCount(diff) >= MAX_REQ_TOKENS) {
-      const commitMessagePromises = getCommitMsgsPromisesFromFileDiffs(
+    const INIT_MESSAGES_PROMPT = await getMainCommitPrompt(fullGitMojiSpec);
+
+    const INIT_MESSAGES_PROMPT_LENGTH = INIT_MESSAGES_PROMPT.map(
+      (msg) => tokenCount(msg.content) + 4
+    ).reduce((a, b) => a + b, 0);
+
+    const MAX_REQUEST_TOKENS =
+      MAX_TOKENS_INPUT -
+      ADJUSTMENT_FACTOR -
+      INIT_MESSAGES_PROMPT_LENGTH -
+      MAX_TOKENS_OUTPUT;
+
+    if (tokenCount(diff) >= MAX_REQUEST_TOKENS) {
+      const commitMessagePromises = await getCommitMsgsPromisesFromFileDiffs(
         diff,
-        MAX_REQ_TOKENS
+        MAX_REQUEST_TOKENS,
+        fullGitMojiSpec
       );
 
-      const commitMessages = await Promise.all(commitMessagePromises);
+      const commitMessages = [];
+      for (const promise of commitMessagePromises) {
+        commitMessages.push(await promise);
+        await delay(2000);
+      }
 
       return commitMessages.join('\n\n');
-    } else {
-      const messages = generateCommitMessageChatCompletionPrompt(diff);
-
-      const commitMessage = await api.generateCommitMessage(messages);
-
-      if (!commitMessage)
-        return { error: GenerateCommitMessageErrorEnum.emptyMessage };
-
-      return commitMessage;
     }
+
+    const messages = await generateCommitMessageChatCompletionPrompt(diff, fullGitMojiSpec);
+
+    const engine = getEngine()
+    const commitMessage = await engine.generateCommitMessage(messages);
+
+    if (!commitMessage)
+      throw new Error(GenerateCommitMessageErrorEnum.emptyMessage);
+
+    return commitMessage;
   } catch (error) {
-    return { error: GenerateCommitMessageErrorEnum.internalError };
+    throw error;
   }
 };
 
 function getMessagesPromisesByChangesInFile(
   fileDiff: string,
   separator: string,
-  maxChangeLength: number
+  maxChangeLength: number,
+  fullGitMojiSpec: boolean
 ) {
   const hunkHeaderSeparator = '@@ ';
   const [fileHeader, ...fileDiffByLines] = fileDiff.split(hunkHeaderSeparator);
@@ -126,25 +100,74 @@ function getMessagesPromisesByChangesInFile(
     maxChangeLength
   );
 
-  const lineDiffsWithHeader = mergedChanges.map(
-    (change) => fileHeader + change
+  const lineDiffsWithHeader = [];
+  for (const change of mergedChanges) {
+    const totalChange = fileHeader + change;
+    if (tokenCount(totalChange) > maxChangeLength) {
+      // If the totalChange is too large, split it into smaller pieces
+      const splitChanges = splitDiff(totalChange, maxChangeLength);
+      lineDiffsWithHeader.push(...splitChanges);
+    } else {
+      lineDiffsWithHeader.push(totalChange);
+    }
+  }
+
+  const engine = getEngine()
+  const commitMsgsFromFileLineDiffs = lineDiffsWithHeader.map(
+    async (lineDiff) => {
+      const messages = await generateCommitMessageChatCompletionPrompt(
+        separator + lineDiff,
+        fullGitMojiSpec
+      );
+
+      return engine.generateCommitMessage(messages);
+    }
   );
 
-  const commitMsgsFromFileLineDiffs = lineDiffsWithHeader.map((lineDiff) => {
-    const messages = generateCommitMessageChatCompletionPrompt(
-      separator + lineDiff
-    );
-
-    return api.generateCommitMessage(messages);
-  });
-
   return commitMsgsFromFileLineDiffs;
 }
 
-export function getCommitMsgsPromisesFromFileDiffs(
+function splitDiff(diff: string, maxChangeLength: number) {
+  const lines = diff.split('\n');
+  const splitDiffs = [];
+  let currentDiff = '';
+
+  if (maxChangeLength <= 0) {
+    throw new Error(GenerateCommitMessageErrorEnum.outputTokensTooHigh);
+  }
+
+  for (let line of lines) {
+    // If a single line exceeds maxChangeLength, split it into multiple lines
+    while (tokenCount(line) > maxChangeLength) {
+      const subLine = line.substring(0, maxChangeLength);
+      line = line.substring(maxChangeLength);
+      splitDiffs.push(subLine);
+    }
+
+    // Check the tokenCount of the currentDiff and the line separately
+    if (tokenCount(currentDiff) + tokenCount('\n' + line) > maxChangeLength) {
+      // If adding the next line would exceed the maxChangeLength, start a new diff
+      splitDiffs.push(currentDiff);
+      currentDiff = line;
+    } else {
+      // Otherwise, add the line to the current diff
+      currentDiff += '\n' + line;
+    }
+  }
+
+  // Add the last diff
+  if (currentDiff) {
+    splitDiffs.push(currentDiff);
+  }
+
+  return splitDiffs;
+}
+
+export const getCommitMsgsPromisesFromFileDiffs = async (
   diff: string,
-  maxDiffLength: number
-) {
+  maxDiffLength: number,
+  fullGitMojiSpec: boolean
+) => {
   const separator = 'diff --git ';
 
   const diffByFiles = diff.split(separator).slice(1);
@@ -160,17 +183,25 @@ export function getCommitMsgsPromisesFromFileDiffs(
       const messagesPromises = getMessagesPromisesByChangesInFile(
         fileDiff,
         separator,
-        maxDiffLength
+        maxDiffLength,
+        fullGitMojiSpec
       );
 
       commitMessagePromises.push(...messagesPromises);
     } else {
-      const messages = generateCommitMessageChatCompletionPrompt(
-        separator + fileDiff
+      const messages = await generateCommitMessageChatCompletionPrompt(
+        separator + fileDiff,
+        fullGitMojiSpec
       );
 
-      commitMessagePromises.push(api.generateCommitMessage(messages));
+      const engine = getEngine()
+      commitMessagePromises.push(engine.generateCommitMessage(messages));
     }
   }
+
   return commitMessagePromises;
+};
+
+function delay(ms: number) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
 }

src/github-action.ts

@@ -0,0 +1,228 @@
+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 { generateCommitMessageByDiff } from './generateCommitMessageFromGitDiff';
+import { randomIntFromInterval } from './utils/randomIntFromInterval';
+import { sleep } from './utils/sleep';
+
+// This should be a token with access to your repository scoped in as a secret.
+// The YML workflow will need to set GITHUB_TOKEN with the GitHub Secret Token
+// GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+// https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token#about-the-github_token-secret
+const GITHUB_TOKEN = core.getInput('GITHUB_TOKEN');
+const octokit = github.getOctokit(GITHUB_TOKEN);
+const context = github.context;
+const owner = context.repo.owner;
+const repo = context.repo.repo;
+
+type SHA = string;
+type Diff = string;
+
+async function getCommitDiff(commitSha: string) {
+  const diffResponse = await octokit.request<string>(
+    'GET /repos/{owner}/{repo}/commits/{ref}',
+    {
+      owner,
+      repo,
+      ref: commitSha,
+      headers: {
+        Accept: 'application/vnd.github.v3.diff'
+      }
+    }
+  );
+  return { sha: commitSha, diff: diffResponse.data };
+}
+
+interface DiffAndSHA {
+  sha: SHA;
+  diff: Diff;
+}
+
+interface MsgAndSHA {
+  sha: SHA;
+  msg: string;
+}
+
+// send only 3-4 size chunks of diffs in steps,
+// because openAI restricts "too many requests" at once with 429 error
+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)
+  );
+
+  let improvedMessagesAndSHAs: MsgAndSHA[] = [];
+  for (let step = 0; step < improvePromises.length; step += chunkSize) {
+    const chunkOfPromises = improvePromises.slice(step, step + chunkSize);
+
+    try {
+      const chunkOfImprovedMessages = await Promise.all(chunkOfPromises);
+
+      const chunkOfImprovedMessagesBySha = chunkOfImprovedMessages.map(
+        (improvedMsg, i) => {
+          const index = improvedMessagesAndSHAs.length;
+          const sha = diffsAndSHAs![index + i].sha;
+
+          return { sha, msg: improvedMsg };
+        }
+      );
+
+      improvedMessagesAndSHAs.push(...chunkOfImprovedMessagesBySha);
+
+      // sometimes openAI errors with 429 code (too many requests),
+      // so lets sleep a bit
+      const sleepFor =
+        1000 * randomIntFromInterval(1, 5) + 100 * randomIntFromInterval(1, 5);
+
+      outro(
+        `Improved ${chunkOfPromises.length} messages. Sleeping for ${sleepFor}`
+      );
+
+      await sleep(sleepFor);
+    } catch (error) {
+      outro(error as string);
+
+      // if sleeping in try block still fails with 429,
+      // openAI wants at least 1 minute before next request
+      const sleepFor = 60000 + 1000 * randomIntFromInterval(1, 5);
+      outro(`Retrying after sleeping for ${sleepFor}`);
+      await sleep(sleepFor);
+
+      // go to previous step
+      step -= chunkSize;
+    }
+  }
+
+  return improvedMessagesAndSHAs;
+}
+
+const getDiffsBySHAs = async (SHAs: string[]) => {
+  const diffPromises = SHAs.map((sha) => getCommitDiff(sha));
+
+  const diffs = await Promise.all(diffPromises).catch((error) => {
+    outro(`Error in Promise.all(getCommitDiffs(SHAs)): ${error}.`);
+    throw error;
+  });
+
+  return diffs;
+};
+
+async function improveCommitMessages(
+  commitsToImprove: { id: string; message: string }[]
+): Promise<void> {
+  if (commitsToImprove.length) {
+    outro(`Found ${commitsToImprove.length} commits to improve.`);
+  } else {
+    outro('No new commits found.');
+    return;
+  }
+
+  outro('Fetching commit diffs by SHAs.');
+  const commitSHAsToImprove = commitsToImprove.map((commit) => commit.id);
+  const diffsWithSHAs = await getDiffsBySHAs(commitSHAsToImprove);
+  outro('Done.');
+
+  const improvedMessagesWithSHAs = await improveMessagesInChunks(diffsWithSHAs);
+
+  console.log(
+    `Improved ${improvedMessagesWithSHAs.length} commits: `,
+    improvedMessagesWithSHAs
+  );
+
+  // Check if there are actually any changes in the commit messages
+  const messagesChanged = improvedMessagesWithSHAs.some(
+    ({ sha, msg }, index) => msg !== commitsToImprove[index].message
+  );
+
+  if (!messagesChanged) {
+    console.log('No changes in commit messages detected, skipping rebase');
+    return;
+  }
+
+  const createCommitMessageFile = (message: string, index: number) =>
+    writeFileSync(`./commit-${index}.txt`, message);
+  improvedMessagesWithSHAs.forEach(({ msg }, i) =>
+    createCommitMessageFile(msg, i)
+  );
+
+  writeFileSync(`./count.txt`, '0');
+
+  writeFileSync(
+    './rebase-exec.sh',
+    `#!/bin/bash
+    count=$(cat count.txt)
+    git commit --amend -F commit-$count.txt
+    echo $(( count + 1 )) > count.txt`
+  );
+
+  await exec.exec(`chmod +x ./rebase-exec.sh`);
+
+  await exec.exec(
+    'git',
+    ['rebase', `${commitsToImprove[0].id}^`, '--exec', './rebase-exec.sh'],
+    {
+      env: {
+        GIT_SEQUENCE_EDITOR: 'sed -i -e "s/^pick/reword/g"',
+        GIT_COMMITTER_NAME: process.env.GITHUB_ACTOR!,
+        GIT_COMMITTER_EMAIL: `${process.env.GITHUB_ACTOR}@users.noreply.github.com`
+      }
+    }
+  );
+
+  const deleteCommitMessageFile = (index: number) =>
+    unlinkSync(`./commit-${index}.txt`);
+  commitsToImprove.forEach((_commit, i) => deleteCommitMessageFile(i));
+
+  unlinkSync('./count.txt');
+  unlinkSync('./rebase-exec.sh');
+
+  outro('Force pushing non-interactively rebased commits into remote.');
+
+  await exec.exec('git', ['status']);
+
+  // Force push the rebased commits
+  await exec.exec('git', ['push', `--force`]);
+
+  outro('Done 🧙');
+}
+
+async function run() {
+  intro('OpenCommit — improving lame commit messages');
+
+  try {
+    if (github.context.eventName === 'push') {
+      outro(`Processing commits in a Push event`);
+
+      const payload = github.context.payload as PushEvent;
+
+      const commits = payload.commits;
+
+      // Set local Git user identity for future git history manipulations
+      if (payload.pusher.email)
+        await exec.exec('git', ['config', 'user.email', payload.pusher.email]);
+
+      await exec.exec('git', ['config', 'user.name', payload.pusher.name]);
+
+      await exec.exec('git', ['status']);
+      await exec.exec('git', ['log', '--oneline']);
+
+      await improveCommitMessages(commits);
+    } else {
+      outro('Wrong action.');
+      core.error(
+        `OpenCommit was called on ${github.context.payload.action}. OpenCommit is supposed to be used on "push" action.`
+      );
+    }
+  } catch (error: any) {
+    const err = error?.message || error;
+    core.setFailed(err);
+  }
+}
+
+run();

src/i18n/index.ts

@@ -1,22 +1,22 @@
-import en from '../i18n/en.json' assert { type: 'json' };
-import cs from '../i18n/cs.json' assert { type: 'json' };
-import de from '../i18n/de.json' assert { type: 'json' };
-import fr from '../i18n/fr.json' assert { type: 'json' };
-import it from '../i18n/it.json' assert { type: 'json' };
-import ko from '../i18n/ko.json' assert { type: 'json' };
-import zh_CN from '../i18n/zh_CN.json' assert { type: 'json' };
-import zh_TW from '../i18n/zh_TW.json' assert { type: 'json' };
-import ja from '../i18n/ja.json' assert { type: 'json' };
-import pt_br from '../i18n/pt_br.json' assert { type: 'json' };
-import vi_VN from '../i18n/vi_VN.json' assert { type: 'json' };
-import es_ES from '../i18n/es_ES.json' assert { type: 'json' };
-import sv from '../i18n/sv.json' assert { type: 'json' };
-import nl from '../i18n/nl.json' assert { type: 'json' };
-import ru from '../i18n/ru.json' assert { type: 'json' };
-import id_ID from '../i18n/id_ID.json' assert { type: 'json' };
-import pl from '../i18n/pl.json' assert { type: 'json' };
-import tr from '../i18n/tr.json' assert { type: 'json' };
-import th from '../i18n/th.json' assert { type: 'json' };
+import cs from '../i18n/cs.json';
+import de from '../i18n/de.json';
+import en from '../i18n/en.json';
+import es_ES from '../i18n/es_ES.json';
+import fr from '../i18n/fr.json';
+import id_ID from '../i18n/id_ID.json';
+import it from '../i18n/it.json';
+import ja from '../i18n/ja.json';
+import ko from '../i18n/ko.json';
+import nl from '../i18n/nl.json';
+import pl from '../i18n/pl.json';
+import pt_br from '../i18n/pt_br.json';
+import ru from '../i18n/ru.json';
+import sv from '../i18n/sv.json';
+import th from '../i18n/th.json';
+import tr from '../i18n/tr.json';
+import vi_VN from '../i18n/vi_VN.json';
+import zh_CN from '../i18n/zh_CN.json';
+import zh_TW from '../i18n/zh_TW.json';
 
 export enum I18nLocals {
   'en' = 'en',
@@ -36,7 +36,7 @@ export enum I18nLocals {
   'id_ID' = 'id_ID',
   'pl' = 'pl',
   'tr' = 'tr',
-  'th' = 'th',
+  'th' = 'th'
 }
 
 export const i18n = {

src/modules/commitlint/config.ts

@@ -0,0 +1,84 @@
+import { spinner } from '@clack/prompts';
+
+import { getConfig } from '../../commands/config';
+import { i18n, I18nLocals } from '../../i18n';
+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'];
+
+export const configureCommitlintIntegration = async (force = false) => {
+  const spin = spinner();
+  spin.start('Loading @commitlint configuration');
+
+  const fileExists = await utils.commitlintLLMConfigExists();
+
+  let commitLintConfig = await getCommitLintPWDConfig();
+
+  // debug complete @commitlint configuration
+  // await fs.writeFile(
+  //   `${OPENCOMMIT_COMMITLINT_CONFIG}-commitlint-debug`,
+  //   JSON.stringify(commitLintConfig, null, 2)
+  // );
+
+  const hash = await computeHash(JSON.stringify(commitLintConfig));
+
+  spin.stop(`Read @commitlint configuration (hash: ${hash})`);
+
+  if (fileExists) {
+    // Check if we need to update the prompts.
+    const { hash: existingHash } = await utils.getCommitlintLLMConfig();
+    if (hash === existingHash && !force) {
+      spin.stop(
+        'Hashes are the same, no need to update the config. Run "force" command to bypass.'
+      );
+      return;
+    }
+  }
+
+  spin.start('Generating consistency with given @commitlint rules');
+
+  const prompts = inferPromptsFromCommitlintConfig(commitLintConfig);
+
+  const consistencyPrompts =
+    commitlintPrompts.GEN_COMMITLINT_CONSISTENCY_PROMPT(prompts);
+
+  // debug prompt which will generate a consistency
+  // await fs.writeFile(
+  //   `${COMMITLINT_LLM_CONFIG}-debug`,
+  //   consistencyPrompts.map((p) => p.content)
+  // );
+
+  const engine = getEngine()
+  let consistency =
+    (await engine.generateCommitMessage(consistencyPrompts)) || '{}';
+
+  // Cleanup the consistency answer. Sometimes 'gpt-3.5-turbo' sends rule's back.
+  prompts.forEach((prompt) => (consistency = consistency.replace(prompt, '')));
+
+  // sometimes consistency is preceded by explanatory text like "Here is your JSON:"
+  consistency = utils.getJSONBlock(consistency);
+  
+  // ... remaining might be extra set of "\n"
+  consistency = utils.removeDoubleNewlines(consistency);
+
+  const commitlintLLMConfig: CommitlintLLMConfig = {
+    hash,
+    prompts,
+    consistency: {
+      [translation.localLanguage]: {
+        ...JSON.parse(consistency as string)
+      }
+    }
+  };
+
+  await utils.writeCommitlintLLMConfig(commitlintLLMConfig);
+
+  spin.stop(`Done - please review contents of ${COMMITLINT_LLM_CONFIG_PATH}`);
+};

src/modules/commitlint/constants.ts

@@ -0,0 +1 @@
+export const COMMITLINT_LLM_CONFIG_PATH = `${process.env.PWD}/.opencommit-commitlint`;

src/modules/commitlint/crypto.ts

@@ -0,0 +1,15 @@
+import crypto from 'crypto';
+
+export const computeHash = async (
+  content: string,
+  algorithm: string = 'sha256'
+): Promise<string> => {
+  try {
+    const hash = crypto.createHash(algorithm);
+    hash.update(content);
+    return hash.digest('hex');
+  } catch (error) {
+    console.error('Error while computing hash:', error);
+    throw error;
+  }
+};

src/modules/commitlint/prompts.ts

@@ -0,0 +1,284 @@
+import chalk from 'chalk';
+import {
+  ChatCompletionRequestMessage,
+  ChatCompletionRequestMessageRoleEnum
+} from 'openai';
+
+import { outro } from '@clack/prompts';
+import {
+  PromptConfig,
+  QualifiedConfig,
+  RuleConfigSeverity,
+  RuleConfigTuple
+} from '@commitlint/types';
+
+import { getConfig } from '../../commands/config';
+import { i18n, I18nLocals } from '../../i18n';
+import { IDENTITY, INIT_DIFF_PROMPT } from '../../prompts';
+
+const config = getConfig();
+const translation = i18n[(config?.OCO_LANGUAGE as I18nLocals) || 'en'];
+
+type DeepPartial<T> = {
+  [P in keyof T]?: {
+    [K in keyof T[P]]?: T[P][K];
+  };
+};
+
+type PromptFunction = (
+  applicable: string,
+  value: any,
+  prompt: DeepPartial<PromptConfig>
+) => string;
+
+type PromptResolverFunction = (
+  key: string,
+  applicable: string,
+  value: any,
+  prompt?: DeepPartial<PromptConfig>
+) => string;
+
+/**
+ * Extracts more contexte for each type-enum.
+ * IDEA: replicate the concept for scopes and refactor to a generic feature.
+ */
+const getTypeRuleExtraDescription = (
+  type: string,
+  prompt?: DeepPartial<PromptConfig>
+) => prompt?.questions?.type?.enum?.[type]?.description;
+
+/*
+IDEA: Compress llm readable prompt for each section of commit message: one line for header, one line for scope, etc.
+  - The type must be in lowercase and should be one of the following values: featuring, fixing, documenting, styling, refactoring, testing, chores, perf, build, ci, revert.
+  - The scope should not be empty and provide context for the change (e.g., module or file changed).
+  - The subject should not be empty, should not end with a period, and should provide a concise description of the change. It should not be in sentence-case, start-case, pascal-case, or upper-case.
+*/
+const llmReadableRules: {
+  [ruleName: string]: PromptResolverFunction;
+} = {
+  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: 
+  - ${value.join('\n  - ')}.`
+        : `${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: 
+  - ${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)
+      ? value
+          .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) =>
+    `The ${key} should ${applicable} have ${value} characters or less.`,
+  minLengthRule: (key, applicable, value: string) =>
+    `The ${key} should ${applicable} have ${value} characters or more.`
+};
+
+/**
+ * TODO: Validate rules to every rule in the @commitlint configuration.
+ * IDEA: Plugins can extend the list of rule. Provide user with a way to infer or extend when "No prompt handler for rule".
+ */
+const rulesPrompts: {
+  [ruleName: string]: PromptFunction;
+} = {
+  'body-case': (applicable: string, value: string | Array<string>) =>
+    llmReadableRules.caseRule('body', applicable, value),
+  'body-empty': (applicable: string) =>
+    llmReadableRules.emptyRule('body', applicable, undefined),
+  'body-full-stop': (applicable: string, value: string) =>
+    llmReadableRules.fullStopRule('body', applicable, value),
+  'body-leading-blank': (applicable: string) =>
+    llmReadableRules.blankline('body', applicable, undefined),
+  'body-max-length': (applicable: string, value: string) =>
+    llmReadableRules.maxLengthRule('body', applicable, value),
+  'body-max-line-length': (applicable: string, value: string) =>
+    `Each line of the body should ${applicable} have ${value} characters or less.`,
+  'body-min-length': (applicable: string, value: string) =>
+    llmReadableRules.minLengthRule('body', applicable, value),
+  'footer-case': (applicable: string, value: string | Array<string>) =>
+    llmReadableRules.caseRule('footer', applicable, value),
+  'footer-empty': (applicable: string) =>
+    llmReadableRules.emptyRule('footer', applicable, undefined),
+  'footer-leading-blank': (applicable: string) =>
+    llmReadableRules.blankline('footer', applicable, undefined),
+  'footer-max-length': (applicable: string, value: string) =>
+    llmReadableRules.maxLengthRule('footer', applicable, value),
+  'footer-max-line-length': (applicable: string, value: string) =>
+    `Each line of the footer should ${applicable} have ${value} characters or less.`,
+  'footer-min-length': (applicable: string, value: string) =>
+    llmReadableRules.minLengthRule('footer', applicable, value),
+  'header-case': (applicable: string, value: string | Array<string>) =>
+    llmReadableRules.caseRule('header', applicable, value),
+  'header-full-stop': (applicable: string, value: string) =>
+    llmReadableRules.fullStopRule('header', applicable, value),
+  'header-max-length': (applicable: string, value: string) =>
+    llmReadableRules.maxLengthRule('header', applicable, value),
+  'header-min-length': (applicable: string, value: string) =>
+    llmReadableRules.minLengthRule('header', applicable, value),
+  'references-empty': (applicable: string) =>
+    llmReadableRules.emptyRule('references section', applicable, undefined),
+  'scope-case': (applicable: string, value: string | Array<string>) =>
+    llmReadableRules.caseRule('scope', applicable, value),
+  'scope-empty': (applicable: string) =>
+    llmReadableRules.emptyRule('scope', applicable, undefined),
+  'scope-enum': (applicable: string, value: string | Array<string>) =>
+    llmReadableRules.enumRule('type', applicable, value),
+  'scope-max-length': (applicable: string, value: string) =>
+    llmReadableRules.maxLengthRule('scope', applicable, value),
+  'scope-min-length': (applicable: string, value: string) =>
+    llmReadableRules.minLengthRule('scope', applicable, value),
+  'signed-off-by': (applicable: string, value: string) =>
+    `The commit message should ${applicable} have a "Signed-off-by" line with the value "${value}".`,
+  'subject-case': (applicable: string, value: string | Array<string>) =>
+    llmReadableRules.caseRule('subject', applicable, value),
+  'subject-empty': (applicable: string) =>
+    llmReadableRules.emptyRule('subject', applicable, undefined),
+  'subject-full-stop': (applicable: string, value: string) =>
+    llmReadableRules.fullStopRule('subject', applicable, value),
+  'subject-max-length': (applicable: string, value: string) =>
+    llmReadableRules.maxLengthRule('subject', applicable, value),
+  'subject-min-length': (applicable: string, value: string) =>
+    llmReadableRules.minLengthRule('subject', applicable, value),
+  'type-case': (applicable: string, value: string | Array<string>) =>
+    llmReadableRules.caseRule('type', applicable, value),
+  'type-empty': (applicable: string) =>
+    llmReadableRules.emptyRule('type', applicable, undefined),
+  'type-enum': (applicable: string, value: string | Array<string>, prompt) =>
+    llmReadableRules.enumTypeRule('type', applicable, value, prompt),
+  'type-max-length': (applicable: string, value: string) =>
+    llmReadableRules.maxLengthRule('type', applicable, value),
+  'type-min-length': (applicable: string, value: string) =>
+    llmReadableRules.minLengthRule('type', applicable, value)
+};
+
+const getPrompt = (
+  ruleName: string,
+  ruleConfig: RuleConfigTuple<unknown>,
+  prompt: DeepPartial<PromptConfig>
+) => {
+  const [severity, applicable, value] = ruleConfig;
+
+  // Should we exclude "Disabled" properties?
+  // Is this used to disable a subjacent rule when extending presets?
+  if (severity === RuleConfigSeverity.Disabled) return null;
+
+  const promptFn = rulesPrompts[ruleName];
+  if (promptFn) {
+    return promptFn(applicable, value, prompt);
+  }
+
+  // Plugins may add their custom rules.
+  // We might want to call OpenAI to build this rule's llm-readable prompt.
+  outro(`${chalk.red('✖')} No prompt handler for rule "${ruleName}".`);
+  return `Please manualy set the prompt for rule "${ruleName}".`;
+};
+
+export const inferPromptsFromCommitlintConfig = (
+  config: QualifiedConfig
+): string[] => {
+  const { rules, prompt } = config;
+  if (!rules) return [];
+  return Object.keys(rules)
+    .map((ruleName) =>
+      getPrompt(ruleName, rules[ruleName] as RuleConfigTuple<unknown>, prompt)
+    )
+    .filter((prompt) => prompt !== null) as string[];
+};
+
+/**
+ * Breaking down commit message structure for conventional commit, and mapping bits with
+ * 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 = `
+- 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. 
+
+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>\`
+- ${prompts.join('\n- ')}
+
+JSON Output Format:
+- The JSON output should contain the commit messages for a bug fix and a new feature in the following format:
+\`\`\`json
+{
+  "localLanguage": "${translation.localLanguage}",
+  "commitFix": "<Header of commit for bug fix>",
+  "commitFeat": "<Header of commit for feature>",
+  "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.
+- 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. 
+
+Example Git Diff is to follow:`
+  },
+  INIT_DIFF_PROMPT
+];
+
+/**
+ * Prompt to have LLM generate a message using @commitlint rules.
+ *
+ * @param language
+ * @param prompts
+ * @returns
+ */
+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."}
+Use the present tense. Use ${language} to answer.
+${ config?.OCO_ONE_LINE_COMMIT ? 'Craft a concise commit message that encapsulates all changes made, with an emphasis on the primary updates. If the modifications share a common theme or scope, mention it succinctly; otherwise, leave the scope out to maintain focus. The goal is to provide a clear and unified overview of the changes in a one single message, without diverging into a list of commit per file change.' : ""}
+    
+You will strictly follow the following conventions to generate the content of the commit message:
+- ${prompts.join('\n- ')}
+
+The conventions refers to the following structure of commit message:
+${STRUCTURE_OF_COMMIT}
+    
+    `
+});
+
+export const commitlintPrompts = {
+  INIT_MAIN_PROMPT,
+  GEN_COMMITLINT_CONSISTENCY_PROMPT
+};

src/modules/commitlint/pwd-commitlint.ts

@@ -0,0 +1,25 @@
+import path from 'path';
+
+const nodeModulesPath = path.join(
+  process.env.PWD || process.cwd(),
+  'node_modules',
+  '@commitlint',
+  'load'
+);
+
+/**
+ *  This code is loading the configuration for the `@commitlint` package from the current working
+ * directory (`process.env.PWD`) by requiring the `load` module from the `@commitlint` package.
+ *
+ * @returns
+ */
+export const getCommitLintPWDConfig = async () => {
+  const load = require(nodeModulesPath).default;
+
+  if (load && typeof load === 'function') {
+    return await load();
+  }
+
+  // @commitlint/load is not a function
+  return null;
+};

src/modules/commitlint/types.ts

@@ -0,0 +1,11 @@
+import { i18n } from '../../i18n';
+
+export type ConsistencyPrompt = (typeof i18n)[keyof typeof i18n];
+
+export type CommitlintLLMConfig = {
+  hash: string;
+  prompts: string[];
+  consistency: {
+    [key: string]: ConsistencyPrompt;
+  };
+};

src/modules/commitlint/utils.ts

@@ -0,0 +1,57 @@
+import fs from 'fs/promises';
+
+import { COMMITLINT_LLM_CONFIG_PATH } from './constants';
+import { CommitlintLLMConfig } from './types';
+
+/**
+ * Removes the "\n" only if occurring twice
+ */
+export const removeDoubleNewlines = (input: string): string => {
+  const pattern = /\\n\\n/g;
+  if (pattern.test(input)) {
+    const newInput = input.replace(pattern, '');
+    return removeDoubleNewlines(newInput);
+  }
+
+  return input;
+};
+
+export const getJSONBlock = (input: string): string => {
+  const jsonIndex = input.search('```json');
+  if(jsonIndex > -1) {
+    input = input.slice(jsonIndex + 8);
+    const endJsonIndex = consistency.search('```');
+    input = input.slice(0, endJsonIndex); 
+  }
+  return input;
+};
+  
+export const commitlintLLMConfigExists = async (): Promise<boolean> => {
+  let exists;
+  try {
+    await fs.access(COMMITLINT_LLM_CONFIG_PATH);
+    exists = true;
+  } catch (e) {
+    exists = false;
+  }
+
+  return exists;
+};
+
+export const writeCommitlintLLMConfig = async (
+  commitlintLLMConfig: CommitlintLLMConfig
+): Promise<void> => {
+  await fs.writeFile(
+    COMMITLINT_LLM_CONFIG_PATH,
+    JSON.stringify(commitlintLLMConfig, null, 2)
+  );
+};
+
+export const getCommitlintLLMConfig =
+  async (): Promise<CommitlintLLMConfig> => {
+    const content = await fs.readFile(COMMITLINT_LLM_CONFIG_PATH);
+    const commitLintLLMConfig = JSON.parse(
+      content.toString()
+    ) as CommitlintLLMConfig;
+    return commitLintLLMConfig;
+};

src/prompts.ts

@@ -0,0 +1,207 @@
+import {
+  ChatCompletionRequestMessage,
+  ChatCompletionRequestMessageRoleEnum
+} from 'openai';
+
+import { note } from '@clack/prompts';
+
+import { getConfig } from './commands/config';
+import { i18n, I18nLocals } from './i18n';
+import { configureCommitlintIntegration } from './modules/commitlint/config';
+import { commitlintPrompts } from './modules/commitlint/prompts';
+import { ConsistencyPrompt } from './modules/commitlint/types';
+import * as utils from './modules/commitlint/utils';
+import { removeConventionalCommitWord } from './utils/removeConventionalCommitWord';
+
+const config = getConfig();
+const translation = i18n[(config?.OCO_LANGUAGE as I18nLocals) || 'en'];
+
+export const IDENTITY =
+  'You are to act as the author of a commit message in git.';
+
+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.`
+});
+
+export const INIT_DIFF_PROMPT: ChatCompletionRequestMessage = {
+  role: ChatCompletionRequestMessageRoleEnum.User,
+  content: `diff --git a/src/server.ts b/src/server.ts
+    index ad4db42..f3b18a9 100644
+    --- a/src/server.ts
+    +++ b/src/server.ts
+    @@ -10,7 +10,7 @@
+    import {
+        initWinstonLogger();
+        
+        const app = express();
+        -const port = 7799;
+        +const PORT = 7799;
+        
+        app.use(express.json());
+        
+        @@ -34,6 +34,6 @@
+        app.use((_, res, next) => {
+            // ROUTES
+            app.use(PROTECTED_ROUTER_URL, protectedRouter);
+            
+            -app.listen(port, () => {
+                -  console.log(\`Server listening on port \${port}\`);
+                +app.listen(process.env.PORT || PORT, () => {
+                    +  console.log(\`Server listening on port \${PORT}\`);
+                });`
+};
+
+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 : ''}`
+});
+
+export const getMainCommitPrompt = async (
+  fullGitMojiSpec: boolean
+): Promise<ChatCompletionRequestMessage[]> => {
+  switch (config?.OCO_PROMPT_MODULE) {
+    case '@commitlint':
+      if (!(await utils.commitlintLLMConfigExists())) {
+        note(
+          `OCO_PROMPT_MODULE is @commitlint but you haven't generated consistency for this project yet.`
+        );
+        await configureCommitlintIntegration();
+      }
+
+      // Replace example prompt with a prompt that's generated by OpenAI for the commitlint config.
+      const commitLintConfig = await utils.getCommitlintLLMConfig();
+
+      return [
+        commitlintPrompts.INIT_MAIN_PROMPT(
+          translation.localLanguage,
+          commitLintConfig.prompts
+        ),
+        INIT_DIFF_PROMPT,
+        INIT_CONSISTENCY_PROMPT(
+          commitLintConfig.consistency[
+            translation.localLanguage
+          ] as ConsistencyPrompt
+        )
+      ];
+
+    default:
+      // conventional-commit
+      return [
+        INIT_MAIN_PROMPT(translation.localLanguage, fullGitMojiSpec),
+        INIT_DIFF_PROMPT,
+        INIT_CONSISTENCY_PROMPT(translation)
+      ];
+  }
+};

src/utils/checkIsLatestVersion.ts

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

src/utils/engine.ts

@@ -0,0 +1,19 @@
+import { AiEngine } from '../engine/Engine';
+import { api } from '../engine/openAi';
+import { getConfig } from '../commands/config';
+import { ollamaAi } from '../engine/ollama';
+import { anthropicAi } from '../engine/anthropic'
+import { testAi } from '../engine/testAi';
+
+export function getEngine(): AiEngine {
+  const config = getConfig();
+  if (config?.OCO_AI_PROVIDER == 'ollama') {
+    return ollamaAi;
+  } else if (config?.OCO_AI_PROVIDER == 'anthropic') {
+    return anthropicAi;
+  } else if (config?.OCO_AI_PROVIDER == 'test') {
+    return testAi;
+  }
+  //open ai gpt by default
+  return api;
+}

src/utils/git.ts

@@ -1,8 +1,9 @@
 import { execa } from 'execa';
-import { outro, spinner } from '@clack/prompts';
 import { readFileSync } from 'fs';
 import ignore, { Ignore } from 'ignore';
 
+import { outro, spinner } from '@clack/prompts';
+
 export const assertGitRepo = async () => {
   try {
     await execa('git', ['rev-parse']);
@@ -25,13 +26,11 @@ export const getOpenCommitIgnore = (): Ignore => {
   return ig;
 };
 
-export const getCoreHooksPath = async(): Promise<string> => {
-  const { stdout } = await execa('git', [
-    'config',
-    'core.hooksPath']);
+export const getCoreHooksPath = async (): Promise<string> => {
+  const { stdout } = await execa('git', ['config', 'core.hooksPath']);
 
   return stdout;
-}
+};
 
 export const getStagedFiles = async (): Promise<string[]> => {
   const { stdout: gitDir } = await execa('git', [
@@ -76,19 +75,30 @@ export const getChangedFiles = async (): Promise<string[]> => {
 
 export const gitAdd = async ({ files }: { files: string[] }) => {
   const gitAddSpinner = spinner();
+
   gitAddSpinner.start('Adding files to commit');
+
   await execa('git', ['add', ...files]);
+
   gitAddSpinner.stop('Done');
 };
 
 export const getDiff = async ({ files }: { files: string[] }) => {
   const lockFiles = files.filter(
-    (file) => file.includes('.lock') || file.includes('-lock.')
+    (file) =>
+      file.includes('.lock') ||
+      file.includes('-lock.') ||
+      file.includes('.svg') ||
+      file.includes('.png') ||
+      file.includes('.jpg') ||
+      file.includes('.jpeg') ||
+      file.includes('.webp') ||
+      file.includes('.gif')
   );
 
   if (lockFiles.length) {
     outro(
-      `Some files are '.lock' files which are excluded by default from 'git diff'. No commit messages are generated for this files:\n${lockFiles.join(
+      `Some files are excluded by default from 'git diff'. No commit messages are generated for this files:\n${lockFiles.join(
         '\n'
       )}`
     );

src/utils/mergeDiffs.ts

@@ -1,4 +1,5 @@
 import { tokenCount } from './tokenCount';
+
 export function mergeDiffs(arr: string[], maxStringLength: number): string[] {
   const mergedArr: string[] = [];
   let currentItem: string = arr[0];

src/utils/randomIntFromInterval.ts

@@ -0,0 +1,4 @@
+export function randomIntFromInterval(min: number, max: number) {
+  // min and max included
+  return Math.floor(Math.random() * (max - min + 1) + min);
+}

src/utils/removeConventionalCommitWord.ts

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

src/utils/sleep.ts

@@ -0,0 +1,3 @@
+export function sleep(ms: number) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}

src/utils/tokenCount.ts

@@ -1,5 +1,5 @@
+import cl100k_base from '@dqbd/tiktoken/encoders/cl100k_base.json';
 import { Tiktoken } from '@dqbd/tiktoken/lite';
-import cl100k_base from '@dqbd/tiktoken/encoders/cl100k_base.json' assert { type: 'json' };
 
 export function tokenCount(content: string): number {
   const encoding = new Tiktoken(

src/version.ts

@@ -0,0 +1,14 @@
+import { outro } from "@clack/prompts";
+import { execa } from "execa";
+
+export const getOpenCommitLatestVersion = async (): Promise<
+  string | undefined
+> => {
+  try {
+    const { stdout } = await execa('npm', ['view', 'opencommit', 'version']);
+    return stdout;
+  } catch (_) {
+    outro('Error while getting the latest version of opencommit');
+    return undefined;
+  }
+};

test/Dockerfile

@@ -0,0 +1,19 @@
+FROM ubuntu:latest
+
+RUN apt-get update && apt-get install -y curl git
+
+# Install Node.js v20
+RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash -
+RUN apt-get install -y nodejs
+
+# Setup git
+RUN git config --global user.email "test@example.com"
+RUN git config --global user.name "Test User"
+
+COPY . /app
+WORKDIR /app
+
+RUN ls -la
+
+RUN npm install
+RUN npm run build

test/e2e/noChanges.test.ts

@@ -0,0 +1,13 @@
+import { resolve } from 'path'
+import { render } from 'cli-testing-library'
+import 'cli-testing-library/extend-expect';
+import { prepareEnvironment } from './utils';
+
+it('cli flow when there are no changes', async () => {
+  const { gitDir, cleanup } = await prepareEnvironment();
+
+  const { findByText } = await render(`OCO_AI_PROVIDER='test' node`, [resolve('./out/cli.cjs')], { cwd: gitDir });
+  expect(await findByText('No changes detected')).toBeInTheConsole();
+
+  await cleanup();
+});

test/e2e/oneFile.test.ts

@@ -0,0 +1,56 @@
+import { resolve } from 'path'
+import { render } from 'cli-testing-library'
+import 'cli-testing-library/extend-expect';
+import { prepareEnvironment } from './utils';
+
+it('cli flow to generate commit message for 1 new file (staged)', async () => {
+  const { gitDir, cleanup } = await prepareEnvironment();
+
+  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 });
+
+  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();
+
+  expect(await findByText('Generating the commit message')).toBeInTheConsole();
+  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();
+});
+
+it('cli flow to generate commit message for 1 changed file (not staged)', async () => {
+  const { gitDir, cleanup } = await prepareEnvironment();
+
+  await render('echo' ,[`'console.log("Hello World");' > index.ts`], { cwd: gitDir });
+  await render('git' ,['add index.ts'], { cwd: gitDir });
+  await render('git' ,[`commit -m 'add new file'`], { cwd: gitDir });
+
+  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 });
+
+  expect(await findByText('No files are staged')).toBeInTheConsole();
+  expect(await findByText('Do you want to stage all files and generate commit message?')).toBeInTheConsole();
+  userEvent.keyboard('[Enter]');
+
+  expect(await findByText('Generating the commit message')).toBeInTheConsole();
+  expect(await findByText('Confirm the commit message?')).toBeInTheConsole();
+  userEvent.keyboard('[Enter]');
+
+  expect(await findByText('Successfully committed')).toBeInTheConsole();
+
+  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/utils.ts

@@ -0,0 +1,31 @@
+import path from 'path'
+import { mkdtemp, rm } from 'fs'
+import { promisify } from 'util';
+import { tmpdir } from 'os';
+import { exec } from 'child_process';
+const fsMakeTempDir = promisify(mkdtemp);
+const fsExec = promisify(exec);
+const fsRemove = promisify(rm);
+
+/**
+ * Prepare the environment for the test
+ * Create a temporary git repository in the temp directory
+ */
+export const prepareEnvironment = async (): Promise<{
+  gitDir: string;
+  cleanup: () => Promise<void>;
+}> => {
+  const tempDir = await fsMakeTempDir(path.join(tmpdir(), 'opencommit-test-'));
+  // 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 });
+  const gitDir = path.resolve(tempDir, 'test');
+
+  const cleanup = async () => {
+    return fsRemove(tempDir, { recursive: true });
+  }
+  return {
+    gitDir,
+    cleanup,
+  }
+}

test/jest-setup.ts

@@ -0,0 +1,7 @@
+import 'cli-testing-library/extend-expect'
+import { configure } from 'cli-testing-library'
+
+/**
+ * Adjusted the wait time for waitFor/findByText to 2000ms, because the default 1000ms makes the test results flaky
+ */
+configure({ asyncUtilTimeout: 2000 })

test/unit/config.test.ts

@@ -0,0 +1,105 @@
+import { getConfig } from '../../src/commands/config';
+import { prepareFile } from './utils';
+
+describe('getConfig', () => {
+  const originalEnv = { ...process.env };
+  function resetEnv(env: NodeJS.ProcessEnv) {
+    Object.keys(process.env).forEach((key) => {
+      if (!(key in env)) {
+        delete process.env[key];
+      } else {
+        process.env[key] = env[key];
+      }
+    });
+  }
+
+  beforeEach(() => {
+    resetEnv(originalEnv);
+  });
+
+  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: '' });
+
+    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(config!['OCO_AI_PROVIDER']).toEqual('ollama');
+    expect(config!['OCO_GITPUSH']).toEqual(false);
+    expect(config!['OCO_ONE_LINE_COMMIT']).toEqual(true);
+
+    await configFile.cleanup();
+  });
+
+  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 });
+
+    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(config!['OCO_AI_PROVIDER']).toEqual('ollama');
+    expect(config!['OCO_GITPUSH']).toEqual(false);
+    expect(config!['OCO_ONE_LINE_COMMIT']).toEqual(true);
+
+    await envFile.cleanup();
+  });
+});

test/unit/utils.ts

@@ -0,0 +1,29 @@
+import path from 'path';
+import { mkdtemp, rm, writeFile } from 'fs';
+import { promisify } from 'util';
+import { tmpdir } from 'os';
+const fsMakeTempDir = promisify(mkdtemp);
+const fsRemove = promisify(rm);
+const fsWriteFile = promisify(writeFile);
+
+/**
+ * Prepare tmp file for the test
+ */
+export async function prepareFile(
+  fileName: string,
+  content: string
+): Promise<{
+  filePath: string;
+  cleanup: () => Promise<void>;
+}> {
+  const tempDir = await fsMakeTempDir(path.join(tmpdir(), 'opencommit-test-'));
+  const filePath = path.resolve(tempDir, fileName);
+  await fsWriteFile(filePath, content);
+  const cleanup = async () => {
+    return fsRemove(tempDir, { recursive: true });
+  };
+  return {
+    filePath,
+    cleanup
+  };
+}

tsconfig.json

@@ -5,8 +5,8 @@
 
     "module": "ESNext",
     // "rootDir": "./src",
-    "moduleResolution": "node",
     "resolveJsonModule": true,
+    "moduleResolution": "node",
 
     "allowJs": true,
 
@@ -21,6 +21,9 @@
 
     "skipLibCheck": true
   },
+  "include": [
+    "test/jest-setup.ts"
+  ],
   "exclude": ["node_modules"],
   "ts-node": {
     "esm": true,