3.0.5

The README.md file has been updated to include alternative ways to run OpenCommit via the `npx opencommit` and `bunx opencommit` commands. This provides users with more options to execute the tool without the need for a global installation.

.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

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

.github/ISSUE_TEMPLATE/bug.yaml

@@ -0,0 +1,91 @@
+name: 🐞 Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["bug", "triage"]
+assignees:
+  - octocat
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: input
+    id: opencommit-version
+    attributes:
+      label: Opencommit Version
+      description: What version of our software are you running?
+      placeholder: ex. 1.1.22
+    validations:
+      required: true
+  - type: input
+    id: node-version
+    attributes:
+      label: Node Version
+      description: What version of node are you running?
+      placeholder: ex. 19.8.1
+    validations:
+      required: true
+  - type: input
+    id: npm-version
+    attributes:
+      label: NPM Version
+      description: What version of npm are you running?
+      placeholder: ex. 9.6.2
+    validations:
+      required: true
+  - type: dropdown
+    id: OS
+    attributes:
+      label: What OS are you seeing the problem on?
+      multiple: true
+      options:
+        - Mac
+        - Windows
+        - Other Linux Distro
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+      value: "A bug happened!"
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you expected to happen!
+    validations:
+      required: true   
+  - type: textarea
+    id: current-behavior
+    attributes:
+      label: Current Behavior
+      description: Also tell us, what is currently happening?
+      placeholder: Tell us what is happening now.
+    validations:
+      required: true
+  - type: textarea
+    id: possible-solution
+    attributes:
+      label: Possible Solution
+      description: Do you have a solution for the issue?
+      placeholder: Tell us what the solution could look like.
+    validations:
+      required: false
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps to Reproduce
+      description: Tell us how to reproduce the issue?
+      placeholder: Tell us how to reproduce the issue?
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell

.github/ISSUE_TEMPLATE/featureRequest.yaml

@@ -0,0 +1,48 @@
+---
+name: 🛠️ Feature Request
+description: Suggest an idea to help us improve Opencommit
+title: "[Feature]: "
+labels:
+  - "feature_request"
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Thanks :heart: for taking the time to fill out this feature request report!**
+        We kindly ask that you search to see if an issue [already exists](https://github.com/di-sukharev/opencommit/issues?q=is%3Aissue+sort%3Acreated-desc+) for your feature.
+
+        We are also happy to accept contributions from our users. For more details see [here](https://github.com/di-sukharev/opencommit/blob/master/.github/CONTRIBUTING.md).
+
+  - type: textarea
+    attributes:
+      label: Description
+      description: |
+        A clear and concise description of the feature you're interested in.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Suggested Solution
+      description: |
+        Describe the solution you'd like. A clear and concise description of what you want to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Alternatives
+      description: |
+        Describe alternatives you've considered.
+        A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: |
+        Add any other context about the problem here.
+    validations:
+      required: false

.github/TODO.md

@@ -0,0 +1,11 @@
+# TODOs
+
+- [x] set prepare-commit-msg hook
+- [] show "new version available" message, look into this commit e146d4d cli.ts file
+- [] make bundle smaller by properly configuring esbuild
+- [] [build for both mjs and cjs](https://snyk.io/blog/best-practices-create-modern-npm-package/)
+- [] do // TODOs in the code
+- [x] batch small files in one request
+- [] add tests
+- [] optimize prompt, maybe no prompt would be cleaner
+- [] try setting max commit msg length, maybe it will make commits short and more concise

.github/workflows/codeql.yml

@@ -0,0 +1,76 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '21 16 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/dependency-review.yml

@@ -0,0 +1,20 @@
+# Dependency Review Action
+#
+# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
+#
+# Source repository: https://github.com/actions/dependency-review-action
+# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v3
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v2

.github/workflows/stale.yml

@@ -0,0 +1,28 @@
+# 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'

.gitignore

@@ -1,13 +1,13 @@
 node_modules/
 coverage/
-out/
 temp/
 build/
-dist/
 application.log
 .DS_Store
 /*.env
 logfile.log
 uncaughtExceptions.log
 .vscode
-src/*.json
+src/*.json
+.idea
+test.ts

.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">Author <a href="https://github.com/di-sukharev">@di-sukharev</a> <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 1 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"><a href="https://twitter.com/_sukharev_/status/1683448136973582336">🪩 Winner of GitHub 2023 HACKATHON 🪩</a></h4>
 </div>
 
 ---
@@ -16,90 +16,260 @@
     <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
 
-> The minimum supported version of Node.js is the latest v14. Check your Node.js version with `node --version`.
+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:
+1. Install OpenCommit globally to use in any repository:
 
    ```sh
    npm install -g opencommit
    ```
 
-2. Get your API key from [OpenAI](https://platform.openai.com/account/api-keys)
+   Alternatively run it via `npx opencommit` or `bunx opencommit`
 
-3. Set the key to opencommit config:
+   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
 
-You can call `opencommit` directly to generate a commit message for your staged changes:
+You can call OpenCommit directly to generate a commit message for your staged changes:
 
 ```sh
 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
+You can also run it with local model through ollama:
 
-### Preface commits with emoji 🤠
-
-[GitMoji](https://gitmoji.dev/) convention is used.
-
-To add emoji:
+- install and start ollama
+- run `ollama run mistral` (do this only once, to pull model)
+- run (in your project directory):
 
 ```sh
-oc config set emoji=true
+git add <files...>
+AI_PROVIDER='ollama' opencommit
 ```
 
-To remove emoji:
+## 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_OPENAI_MAX_TOKENS=<max response tokens from OpenAI API>
+OCO_OPENAI_BASE_PATH=<may be used to set proxy path to OpenAI api>
+OCO_DESCRIPTION=<postface a message with ~3 sentences description of the changes>
+OCO_EMOJI=<boolean, add GitMoji>
+OCO_MODEL=<either 'gpt-4', 'gpt-3.5-turbo-16k' (default), 'gpt-3.5-turbo-0613' or 'gpt-3.5-turbo'>
+OCO_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>
+```
+
+### 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
-oc config set emoji=false
+oco config set OCO_MODEL=gpt-4
 ```
 
-### Postface commits with descriptions of changes
-
-To add descriptions:
+Configure [GitMoji](https://gitmoji.dev/) to preface a message.
 
 ```sh
-oc config set description=true
+oco config set OCO_EMOJI=true
 ```
 
-To remove description:
+To remove preface emojis:
 
 ```sh
-oc config set description=false
+oco config set OCO_EMOJI=false
 ```
 
-## Git hook
+### Switch to GPT-4 or other models
 
-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.
+By default, OpenCommit uses `gpt-3.5-turbo-16k` model.
+
+You may switch to GPT-4 which performs better, but costs ~x15 times more 🤠
+
+```sh
+oco config set OCO_MODEL=gpt-4
+```
+
+or for as a cheaper option:
+
+```sh
+oco config set OCO_MODEL=gpt-3.5-turbo
+```
+
+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.
+
+### Locale configuration
+
+To globally specify the language used to generate commit messages:
+
+```sh
+# de, German ,Deutsch
+oco config set OCO_LANGUAGE=de
+oco config set OCO_LANGUAGE=German
+oco config set OCO_LANGUAGE=Deutsch
+
+# fr, French, française
+oco config set OCO_LANGUAGE=fr
+oco config set OCO_LANGUAGE=French
+oco config set OCO_LANGUAGE=française
+```
+
+The default language setting is **English**
+All available languages are currently listed in the [i18n](https://github.com/di-sukharev/opencommit/tree/master/src/i18n) folder
+
+### 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 :
+
+```sh
+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 remove files from being sent to OpenAI by creating a `.opencommitignore` file. For example:
+
+```ignorelang
+path/to/large-asset.zip
+**/*.jpg
+```
+
+This helps prevent opencommit from uploading artifacts and large files.
+
+By default, opencommit ignores files matching: `*-lock.*` and `*.lock`
+
+## 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 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:
@@ -111,6 +281,69 @@ 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_OPENAI_MAX_TOKENS: 500
+          OCO_OPENAI_BASE_PATH: ''
+          OCO_DESCRIPTION: false
+          OCO_EMOJI: false
+          OCO_MODEL: gpt-3.5-turbo-16k
+          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 official model, that is ~10x times cheaper than GPT-3.
+You pay for your requests to OpenAI API on your own.
+
+OpenCommit stores your key locally.
+
+OpenCommit by default uses 3.5-turbo-16k model, it should not exceed $0.10 per casual working day.
+
+You may switch to gpt-4, it's better, but more expensive.

TODO.md

@@ -1,8 +0,0 @@
-# TODOs
-
-- [] make bundle smaller by properly configuring esbuild
-- [] [build for both mjs and cjs](https://snyk.io/blog/best-practices-create-modern-npm-package/)
-- [] do // TODOs in the code
-- [] batch small files in one request
-- [] add tests
-- [] make hook work

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

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

package.json

@@ -1,7 +1,7 @@
 {
   "name": "opencommit",
-  "version": "1.0.12",
-  "description": "GPT CLI to auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
+  "version": "3.0.5",
+  "description": "Auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
   "keywords": [
     "git",
     "chatgpt",
@@ -12,21 +12,23 @@
     "aicommit",
     "aicommits",
     "gptcommit",
-    "commit"
+    "commit",
+    "ollama"
   ],
   "main": "cli.js",
   "bin": {
     "opencommit": "./out/cli.cjs",
-    "oc": "./out/cli.cjs"
+    "oco": "./out/cli.cjs"
   },
   "repository": {
     "url": "https://github.com/di-sukharev/opencommit"
   },
   "type": "module",
   "author": "https://github.com/di-sukharev",
-  "license": "ISC",
+  "license": "MIT",
   "files": [
-    "out/**/*"
+    "out/cli.cjs",
+    "out/tiktoken_bg.wasm"
   ],
   "release": {
     "branches": [
@@ -39,12 +41,16 @@
   "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 && esbuild ./src/cli.ts --bundle --outfile=out/cli.cjs --format=cjs --platform=node",
-    "deploy": "npm run build && npm version patch && npm publish",
-    "lint": "eslint src --ext ts && tsc --noEmit"
+    "build": "rimraf out && node esbuild.config.js",
+    "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"
   },
   "devDependencies": {
+    "@commitlint/types": "^17.4.4",
     "@types/ini": "^1.3.31",
     "@types/inquirer": "^9.0.3",
     "@types/node": "^16.18.14",
@@ -53,15 +59,25 @@
     "dotenv": "^16.0.3",
     "esbuild": "^0.15.18",
     "eslint": "^8.28.0",
+    "prettier": "^2.8.4",
     "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",
     "@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",
     "inquirer": "^9.1.4",
     "openai": "^3.2.1"

src/CommandsEnum.ts

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

src/api.ts

@@ -1,65 +0,0 @@
-import { intro, outro } from '@clack/prompts';
-import {
-  ChatCompletionRequestMessage,
-  Configuration as OpenAiApiConfiguration,
-  OpenAIApi
-} from 'openai';
-
-import { getConfig } from './commands/config';
-
-const config = getConfig();
-
-let apiKey = config?.OPENAI_API_KEY;
-
-if (!apiKey) {
-  intro('opencommit');
-
-  outro(
-    'OPENAI_API_KEY is not set, please run `oc config set OPENAI_API_KEY=<your token>`'
-  );
-  outro(
-    'For help Look into README https://github.com/di-sukharev/opencommit#setup'
-  );
-}
-
-// if (!apiKey) {
-//   intro('opencommit');
-//   const apiKey = await text({
-//     message: 'input your OPENAI_API_KEY'
-//   });
-
-//   setConfig([[CONFIG_KEYS.OPENAI_API_KEY as string, apiKey as any]]);
-
-//   outro('OPENAI_API_KEY is set');
-// }
-
-class OpenAi {
-  private openAiApiConfiguration = new OpenAiApiConfiguration({
-    apiKey: apiKey
-  });
-
-  private openAI = new OpenAIApi(this.openAiApiConfiguration);
-
-  public generateCommitMessage = async (
-    messages: Array<ChatCompletionRequestMessage>
-  ): Promise<string | undefined> => {
-    try {
-      const { data } = await this.openAI.createChatCompletion({
-        model: 'gpt-3.5-turbo',
-        messages,
-        temperature: 0,
-        top_p: 0.1,
-        max_tokens: 196
-      });
-
-      const message = data.choices[0].message;
-
-      return message?.content;
-    } catch (error) {
-      // console.error('openAI api error', { error });
-      throw error;
-    }
-  };
-}
-
-export const api = new OpenAi();

src/cli.ts

@@ -1,38 +1,34 @@
 #!/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 { execa } from 'execa';
-import { outro } from '@clack/prompts';
+import { checkIsLatestVersion } from './utils/checkIsLatestVersion';
 
-const rawArgv = process.argv.slice(2);
+const extraArgs = process.argv.slice(2);
 
 cli(
   {
     version: packageJSON.version,
     name: 'opencommit',
-    commands: [configCommand, hookCommand],
+    commands: [configCommand, hookCommand, commitlintConfigCommand],
     flags: {},
     ignoreArgv: (type) => type === 'unknown-flag' || type === 'argument',
     help: { description: packageJSON.description }
   },
   async () => {
-    if (isHookCalled) {
-      await prepareCommitMessageHook();
-    } else {
-      await commit();
-      const { stdout } = await execa('npm', ['view', 'opencommit', 'version']);
+    await checkIsLatestVersion();
 
-      if (stdout !== packageJSON.version)
-        outro(
-          'new opencommit version is available, update with `npm i -g opencommit`'
-        );
+    if (await isHookCalled()) {
+      prepareCommitMessageHook();
+    } else {
+      commit(extraArgs);
     }
   },
-  rawArgv
+  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,98 +1,190 @@
-import { execa } from 'execa';
-import {
-  GenerateCommitMessageErrorEnum,
-  generateCommitMessageWithChatCompletion
-} from '../generateCommitMessageFromGitDiff';
-import { assertGitRepo, getStagedGitDiff } from '../utils/git';
-import { spinner, confirm, outro, isCancel, intro } from '@clack/prompts';
 import chalk from 'chalk';
+import { execa } from 'execa';
+
+import {
+  confirm,
+  intro,
+  isCancel,
+  multiselect,
+  outro,
+  select,
+  spinner
+} from '@clack/prompts';
+
+import { generateCommitMessageByDiff } from '../generateCommitMessageFromGitDiff';
+import {
+  assertGitRepo,
+  getChangedFiles,
+  getDiff,
+  getStagedFiles,
+  gitAdd
+} from '../utils/git';
+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
+  diff: string,
+  extraArgs: string[]
 ): Promise<void> => {
   await assertGitRepo();
-
   const commitSpinner = spinner();
   commitSpinner.start('Generating the commit message');
-  const commitMessage = await generateCommitMessageWithChatCompletion(diff);
 
-  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);
 
-    outro(`${chalk.red('✖')} ${errorMessages[commitMessage.error]}`);
-    process.exit(1);
-  }
+    const messageTemplate = checkMessageTemplate(extraArgs);
+    if (
+      config?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER &&
+      typeof messageTemplate === 'string'
+    ) {
+      commitMessage = messageTemplate.replace(
+        config?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER,
+        commitMessage
+      );
+    }
 
-  commitSpinner.stop('📝 Commit message generated');
+    commitSpinner.stop('📝 Commit message generated');
 
-  outro(
-    `Commit message:
+    outro(
+      `Generated commit message:
 ${chalk.grey('——————————————————')}
 ${commitMessage}
 ${chalk.grey('——————————————————')}`
-  );
-
-  const isCommitConfirmedByUser = await confirm({
-    message: 'Confirm the commit message'
-  });
-
-  if (isCommitConfirmedByUser && !isCancel(isCommitConfirmedByUser)) {
-    const { stdout } = await execa('git', ['commit', '-m', commitMessage]);
-    outro(`${chalk.green('✔')} successfully committed`);
-    outro(stdout);
-    const isPushConfirmedByUser = await confirm({
-      message: 'Do you want to run `git push`?'
-    });
-
-    if (isPushConfirmedByUser && !isCancel(isPushConfirmedByUser)) {
-      const pushSpinner = spinner();
-
-      pushSpinner.start('Running `git push`');
-      const { stdout } = await execa('git', ['push']);
-      pushSpinner.stop(`${chalk.green('✔')} successfully pushed all commits`);
-
-      if (stdout) outro(stdout);
-    }
-  } else outro(`${chalk.gray('✖')} process cancelled`);
-};
-
-export async function commit(isStageAllFlag = false) {
-  intro('open-commit');
-
-  const stagedFilesSpinner = spinner();
-  stagedFilesSpinner.start('Counting staged files');
-  const staged = await getStagedGitDiff(isStageAllFlag);
-
-  if (!staged && isStageAllFlag) {
-    outro(
-      `${chalk.red(
-        'No changes detected'
-      )} — write some code, stage the files ${chalk
-        .hex('0000FF')
-        .bold('`git add .`')} and rerun ${chalk
-        .hex('0000FF')
-        .bold('`oc`')} command.`
     );
 
+    const isCommitConfirmedByUser = await confirm({
+      message: 'Confirm the commit message?'
+    });
+
+    if (isCommitConfirmedByUser && !isCancel(isCommitConfirmedByUser)) {
+      const { stdout } = await execa('git', [
+        'commit',
+        '-m',
+        commitMessage,
+        ...extraArgs
+      ]);
+
+      outro(`${chalk.green('✔')} Successfully committed`);
+
+      outro(stdout);
+
+      const remotes = await getGitRemotes();
+
+      if (!remotes.length) {
+        const { stdout } = await execa('git', ['push']);
+        if (stdout) outro(stdout);
+        process.exit(0);
+      }
+
+      if (remotes.length === 1) {
+        const isPushConfirmedByUser = await confirm({
+          message: 'Do you want to run `git push`?'
+        });
+
+        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]
+            }`
+          );
+
+          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
+) {
+  if (isStageAllFlag) {
+    const changedFiles = await getChangedFiles();
+
+    if (changedFiles) await gitAdd({ files: changedFiles });
+    else {
+      outro('No changes detected, write some code and run `oco` again');
+      process.exit(1);
+    }
+  }
+
+  const [stagedFiles, errorStagedFiles] = await trytm(getStagedFiles());
+  const [changedFiles, errorChangedFiles] = await trytm(getChangedFiles());
+
+  if (!changedFiles?.length && !stagedFiles?.length) {
+    outro(chalk.red('No changes detected'));
     process.exit(1);
   }
 
-  if (!staged) {
-    outro(
-      `${chalk.red('Nothing to commit')} — stage the files ${chalk
-        .hex('0000FF')
-        .bold('`git add .`')} and rerun ${chalk
-        .hex('0000FF')
-        .bold('`oc`')} command.`
-    );
+  intro('open-commit');
+  if (errorChangedFiles ?? errorStagedFiles) {
+    outro(`${chalk.red('✖')} ${errorChangedFiles ?? errorStagedFiles}`);
+    process.exit(1);
+  }
 
+  const stagedFilesSpinner = spinner();
+
+  stagedFilesSpinner.start('Counting staged files');
+
+  if (!stagedFiles.length) {
     stagedFilesSpinner.stop('No files are staged');
     const isStageAllAndCommitConfirmedByUser = await confirm({
       message: 'Do you want to stage all files and generate commit message?'
@@ -102,17 +194,45 @@ export async function commit(isStageAllFlag = false) {
       isStageAllAndCommitConfirmedByUser &&
       !isCancel(isStageAllAndCommitConfirmedByUser)
     ) {
-      await commit(true);
+      await commit(extraArgs, true);
+      process.exit(1);
     }
 
+    if (stagedFiles.length === 0 && changedFiles.length > 0) {
+      const files = (await multiselect({
+        message: chalk.cyan('Select the files you want to add to the commit:'),
+        options: changedFiles.map((file) => ({
+          value: file,
+          label: file
+        }))
+      })) as string[];
+
+      if (isCancel(files)) process.exit(1);
+
+      await gitAdd({ files });
+    }
+
+    await commit(extraArgs, false);
     process.exit(1);
   }
 
   stagedFilesSpinner.stop(
-    `${staged.files.length} staged files:\n${staged.files
+    `${stagedFiles.length} staged files:\n${stagedFiles
       .map((file) => `  ${file}`)
       .join('\n')}`
   );
 
-  await generateCommitMessageFromGitDiff(staged.diff);
+  const [, generateCommitError] = await trytm(
+    generateCommitMessageFromGitDiff(
+      await getDiff({ files: stagedFiles }),
+      extraArgs
+    )
+  );
+
+  if (generateCommitError) {
+    outro(`${chalk.red('✖')} ${generateCommitError}`);
+    process.exit(1);
+  }
+
+  process.exit(0);
 }

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,15 +1,36 @@
-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 } from 'path';
+
+import { intro, outro } from '@clack/prompts';
+
+import { COMMANDS } from '../CommandsEnum';
+import { getI18nLocal } from '../i18n';
+
+dotenv.config();
 
 export enum CONFIG_KEYS {
-  OPENAI_API_KEY = 'OPENAI_API_KEY',
-  description = 'description',
-  emoji = 'emoji'
+  OCO_OPENAI_API_KEY = 'OCO_OPENAI_API_KEY',
+  OCO_OPENAI_MAX_TOKENS = 'OCO_OPENAI_MAX_TOKENS',
+  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',
+}
+
+export const DEFAULT_MODEL_TOKEN_LIMIT = 4096;
+
+export enum CONFIG_MODES {
+  get = 'get',
+  set = 'set'
 }
 
 const validateConfig = (
@@ -18,44 +39,133 @@ const validateConfig = (
   validationMessage: string
 ) => {
   if (!condition) {
-    throw new Error(`Unsupported config key ${key}: ${validationMessage}`);
+    outro(
+      `${chalk.red('✖')} Unsupported config key ${key}: ${validationMessage}`
+    );
+
+    process.exit(1);
   }
 };
 
 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('API_KEY', value || config.OCO_AI_PROVIDER == 'ollama', 'You need to provide an API key');
     validateConfig(
-      CONFIG_KEYS.OPENAI_API_KEY,
+      CONFIG_KEYS.OCO_OPENAI_API_KEY,
       value.startsWith('sk-'),
       'Must start with "sk-"'
     );
     validateConfig(
-      CONFIG_KEYS.OPENAI_API_KEY,
-      value.length === 51,
+      CONFIG_KEYS.OCO_OPENAI_API_KEY,
+      config[CONFIG_KEYS.OCO_OPENAI_BASE_PATH] || value.length === 51,
       'Must be 51 characters long'
     );
 
     return value;
   },
-  [CONFIG_KEYS.description](value: any) {
+
+  [CONFIG_KEYS.OCO_DESCRIPTION](value: any) {
     validateConfig(
-      CONFIG_KEYS.description,
+      CONFIG_KEYS.OCO_DESCRIPTION,
       typeof value === 'boolean',
       'Must be true or false'
     );
 
     return value;
   },
-  [CONFIG_KEYS.emoji](value: any) {
+
+  [CONFIG_KEYS.OCO_OPENAI_MAX_TOKENS](value: any) {
+    // If the value is a string, convert it to a number.
+    if (typeof value === 'string') {
+      value = parseInt(value);
+      validateConfig(
+        CONFIG_KEYS.OCO_OPENAI_MAX_TOKENS,
+        !isNaN(value),
+        'Must be a number'
+      );
+    }
     validateConfig(
-      CONFIG_KEYS.emoji,
+      CONFIG_KEYS.OCO_OPENAI_MAX_TOKENS,
+      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'
     );
 
     return value;
-  }
+  },
+
+  [CONFIG_KEYS.OCO_LANGUAGE](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_LANGUAGE,
+      getI18nLocal(value),
+      `${value} is not supported yet`
+    );
+    return getI18nLocal(value);
+  },
+
+  [CONFIG_KEYS.OCO_OPENAI_BASE_PATH](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_OPENAI_BASE_PATH,
+      typeof value === 'string',
+      'Must be string'
+    );
+    return value;
+  },
+
+  [CONFIG_KEYS.OCO_MODEL](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_MODEL,
+      [
+        'gpt-3.5-turbo',
+        'gpt-4',
+        'gpt-3.5-turbo-16k',
+        'gpt-3.5-turbo-0613'
+      ].includes(value),
+      `${value} is not supported yet, use 'gpt-4', 'gpt-3.5-turbo-16k' (default), 'gpt-3.5-turbo-0613' or 'gpt-3.5-turbo'`
+    );
+    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_AI_PROVIDER](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_AI_PROVIDER,
+      [
+        '',
+        'openai',
+        'ollama'
+      ].includes(value),
+      `${value} is not supported yet, use 'ollama' or 'openai' (default)`
+    );
+    return value;
+  },
 };
 
 export type ConfigType = {
@@ -65,18 +175,51 @@ export type ConfigType = {
 const configPath = pathJoin(homedir(), '.opencommit');
 
 export const getConfig = (): ConfigType | null => {
+  const configFromEnv = {
+    OCO_OPENAI_API_KEY: process.env.OCO_OPENAI_API_KEY,
+    OCO_OPENAI_MAX_TOKENS: process.env.OCO_OPENAI_MAX_TOKENS
+      ? Number(process.env.OCO_OPENAI_MAX_TOKENS)
+      : undefined,
+    OCO_OPENAI_BASE_PATH: process.env.OCO_OPENAI_BASE_PATH,
+    OCO_DESCRIPTION: process.env.OCO_DESCRIPTION === 'true' ? true : false,
+    OCO_EMOJI: process.env.OCO_EMOJI === 'true' ? true : false,
+    OCO_MODEL: process.env.OCO_MODEL || 'gpt-3.5-turbo-16k',
+    OCO_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'
+  };
+
   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 (
+      !config[configKey] ||
+      ['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;
@@ -105,12 +248,12 @@ 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(
   {
-    name: 'config',
+    name: COMMANDS.config,
     parameters: ['<mode>', '<key=values...>']
   },
   async (argv) => {
@@ -118,12 +261,12 @@ export const configCommand = command(
     try {
       const { mode, keyValues } = argv._;
 
-      if (mode === 'get') {
+      if (mode === CONFIG_MODES.get) {
         const config = getConfig() || {};
         for (const key of keyValues) {
           outro(`${key}=${config[key as keyof typeof config]}`);
         }
-      } else if (mode === 'set') {
+      } else if (mode === CONFIG_MODES.set) {
         await setConfig(
           keyValues.map((keyValue) => keyValue.split('=') as [string, string])
         );

src/commands/githook.ts

@@ -1,35 +1,53 @@
+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 } 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 SYMLINK_URL = `.git/hooks/${HOOK_NAME}`;
+const DEFAULT_SYMLINK_URL = path.join('.git', 'hooks', HOOK_NAME);
 
-export const isHookCalled = process.argv[1].endsWith(`/${SYMLINK_URL}`);
+const getHooksPath = async (): Promise<string> => {
+  try {
+    const hooksPath = await getCoreHooksPath();
+    return path.join(hooksPath, HOOK_NAME);
+  } catch (error) {
+    return DEFAULT_SYMLINK_URL;
+  }
+};
 
-const isHookExists = existsSync(SYMLINK_URL);
+export const isHookCalled = async (): Promise<boolean> => {
+  const hooksPath = await getHooksPath();
+  return process.argv[1].endsWith(hooksPath);
+};
+
+const isHookExists = async (): Promise<boolean> => {
+  const hooksPath = await getHooksPath();
+  return existsSync(hooksPath);
+};
 
 export const hookCommand = command(
   {
-    name: 'hook',
+    name: COMMANDS.hook,
     parameters: ['<set/unset>']
   },
   async (argv) => {
     const HOOK_URL = __filename;
-
+    const SYMLINK_URL = await getHooksPath();
     try {
       await assertGitRepo();
 
       const { setUnset: mode } = argv._;
 
       if (mode === 'set') {
-        intro(`setting opencommit as '${HOOK_NAME}' hook`);
+        intro(`setting opencommit as '${HOOK_NAME}' hook at ${SYMLINK_URL}`);
 
-        if (isHookExists) {
+        if (await isHookExists()) {
           let realPath;
           try {
             realPath = await fs.realpath(SYMLINK_URL);
@@ -39,7 +57,7 @@ export const hookCommand = command(
           }
 
           if (realPath === HOOK_URL)
-            return outro(`opencommit is already set as '${HOOK_NAME}'`);
+            return outro(`OpenCommit is already set as '${HOOK_NAME}'`);
 
           throw new Error(
             `Different ${HOOK_NAME} is already set. Remove it before setting opencommit as '${HOOK_NAME}' hook.`
@@ -54,18 +72,20 @@ export const hookCommand = command(
       }
 
       if (mode === 'unset') {
-        intro(`unsetting opencommit as '${HOOK_NAME}' hook`);
+        intro(
+          `unsetting opencommit as '${HOOK_NAME}' hook from ${SYMLINK_URL}`
+        );
 
-        if (!isHookExists) {
+        if (!(await isHookExists())) {
           return outro(
-            `opencommit wasn't previously set as '${HOOK_NAME}' hook, nothing to remove`
+            `OpenCommit wasn't previously set as '${HOOK_NAME}' hook, nothing to remove`
           );
         }
 
         const realpath = await fs.realpath(SYMLINK_URL);
         if (realpath !== HOOK_URL) {
           return outro(
-            `opencommit wasn't previously set as '${HOOK_NAME}' hook, but different hook was, if you want to remove it — do it manually`
+            `OpenCommit wasn't previously set as '${HOOK_NAME}' hook, but different hook was, if you want to remove it — do it manually`
           );
         }
 
@@ -74,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'`
       );
     } catch (error) {
       outro(`${chalk.red('✖')} ${error}`);

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

@@ -1,13 +1,17 @@
-import fs from 'fs/promises';
 import chalk from 'chalk';
-import { intro, outro } from '@clack/prompts';
-import { getStagedGitDiff } from '../utils/git';
+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);
 
-export const prepareCommitMessageHook = async () => {
+export const prepareCommitMessageHook = async (
+  isStageAllFlag: Boolean = false
+) => {
   try {
     if (!messageFilePath) {
       throw new Error(
@@ -17,7 +21,17 @@ export const prepareCommitMessageHook = async () => {
 
     if (commitSource) return;
 
-    const staged = await getStagedGitDiff();
+    if (isStageAllFlag) {
+      const changedFiles = await getChangedFiles();
+
+      if (changedFiles) await gitAdd({ files: changedFiles });
+      else {
+        outro('No changes detected, write some code and run `oco` again');
+        process.exit(1);
+      }
+    }
+
+    const staged = await getStagedFiles();
 
     if (!staged) return;
 
@@ -25,17 +39,19 @@ 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'
       );
     }
 
-    const commitMessage = await generateCommitMessageWithChatCompletion(
-      staged.diff
-    );
+    const spin = spinner();
+    spin.start('Generating commit message');
 
-    if (typeof commitMessage !== 'string') throw new Error(commitMessage.error);
+    const commitMessage = await generateCommitMessageByDiff(
+      await getDiff({ files: staged })
+    );
+    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/ollama.ts

@@ -0,0 +1,36 @@
+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
+
+    let prompt = messages.map((x) => x.content).join('\n');
+    //hoftix: local models are not so clever so im changing the prompt a bit...
+    prompt += 'Summarize above git diff in 10 words or less';
+
+    const url = 'http://localhost:11434/api/generate';
+    const p = {
+      model,
+      prompt,
+      stream: false
+    };
+    try {
+      const response = await axios.post(url, p, {
+        headers: {
+          'Content-Type': 'application/json'
+        }
+      });
+      const answer = response.data?.response;
+      return answer;
+    } 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,109 @@
+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_MODEL_TOKEN_LIMIT,
+  getConfig
+} from '../commands/config';
+import { GenerateCommitMessageErrorEnum } from '../generateCommitMessageFromGitDiff';
+import { tokenCount } from '../utils/tokenCount';
+import { AiEngine } from './Engine';
+
+const config = getConfig();
+
+let maxTokens = config?.OCO_OPENAI_MAX_TOKENS;
+let basePath = config?.OCO_OPENAI_BASE_PATH;
+let apiKey = config?.OCO_OPENAI_API_KEY
+
+const [command, mode] = process.argv.slice(2);
+
+const isLocalModel = config?.OCO_AI_PROVIDER == 'ollama'
+
+
+if (!apiKey && command !== 'config' && mode !== CONFIG_MODES.set && !isLocalModel) {
+  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';
+
+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: maxTokens || 500
+    };
+    try {
+      const REQUEST_TOKENS = messages
+        .map((msg) => tokenCount(msg.content) + 4)
+        .reduce((a, b) => a + b, 0);
+
+      if (REQUEST_TOKENS > DEFAULT_MODEL_TOKEN_LIMIT - maxTokens) {
+        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/generateCommitMessageFromGitDiff.ts

@@ -2,62 +2,20 @@ import {
   ChatCompletionRequestMessage,
   ChatCompletionRequestMessageRoleEnum
 } from 'openai';
-import { api } from './api';
-import { getConfig } from './commands/config';
-import { mergeStrings } from './utils/mergeStrings';
+
+import { DEFAULT_MODEL_TOKEN_LIMIT, getConfig } from './commands/config';
+import { getMainCommitPrompt } from './prompts';
+import { mergeDiffs } from './utils/mergeDiffs';
+import { tokenCount } from './utils/tokenCount';
+import { getEngine } from './utils/engine';
 
 const config = getConfig();
 
-const INIT_MESSAGES_PROMPT: Array<ChatCompletionRequestMessage> = [
-  {
-    role: ChatCompletionRequestMessageRoleEnum.System,
-    content: `You are to act as the author of a commit message in git. Your mission is to create clean and comprehensive commit messages in the conventional commit convention. I'll send you an output of 'git diff --staged' command, and you convert it into a commit message. ${
-      config?.emoji
-        ? 'Use Gitmoji convention to preface the commit'
-        : 'Do not preface the commit with anything'
-    }, use the present tense. ${
-      config?.description
-        ? 'Add a short description of what commit is about after the commit message. Don\'t start it with "This commit", just describe the changes.'
-        : "Don't add any descriptions to the commit, only commit message."
-    }`
-  },
-  {
-    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,
-    // prettier-ignore
-    content: `* ${config?.emoji ? '🐛 ' : ''}fix(server.ts): change port variable case from lowercase port to uppercase PORT
-* ${config?.emoji ? '✨ ' : ''}feat(server.ts): add support for process.env.PORT environment variable
-${config?.description ? 'The port variable is now named PORT, which improves consistency with the naming conventions as PORT is a constant. Support for an environment variable allows the application to be more flexible as it can now run on any available port specified via the process.env.PORT environment variable.' : ''}`
-  }
-];
-
-const generateCommitMessageChatCompletionPrompt = (
+const generateCommitMessageChatCompletionPrompt = async (
   diff: string
-): Array<ChatCompletionRequestMessage> => {
+): Promise<Array<ChatCompletionRequestMessage>> => {
+  const INIT_MESSAGES_PROMPT = await getMainCommitPrompt();
+
   const chatContextAsCompletionRequest = [...INIT_MESSAGES_PROMPT];
 
   chatContextAsCompletionRequest.push({
@@ -74,87 +32,161 @@ export enum GenerateCommitMessageErrorEnum {
   emptyMessage = 'EMPTY_MESSAGE'
 }
 
-interface GenerateCommitMessageError {
-  error: GenerateCommitMessageErrorEnum;
-}
+const ADJUSTMENT_FACTOR = 20;
 
-const INIT_MESSAGES_PROMPT_LENGTH = INIT_MESSAGES_PROMPT.map(
-  (msg) => msg.content
-).join('').length;
-
-const MAX_REQ_TOKENS = 3900 - INIT_MESSAGES_PROMPT_LENGTH;
-
-export const generateCommitMessageWithChatCompletion = async (
+export const generateCommitMessageByDiff = async (
   diff: string
-): Promise<string | GenerateCommitMessageError> => {
+): Promise<string> => {
   try {
-    if (diff.length >= MAX_REQ_TOKENS) {
-      const commitMessagePromises = getCommitMsgsPromisesFromFileDiffs(diff);
+    const INIT_MESSAGES_PROMPT = await getMainCommitPrompt();
 
-      const commitMessages = await Promise.all(commitMessagePromises);
+    const INIT_MESSAGES_PROMPT_LENGTH = INIT_MESSAGES_PROMPT.map(
+      (msg) => tokenCount(msg.content) + 4
+    ).reduce((a, b) => a + b, 0);
+
+    const MAX_REQUEST_TOKENS =
+      DEFAULT_MODEL_TOKEN_LIMIT -
+      ADJUSTMENT_FACTOR -
+      INIT_MESSAGES_PROMPT_LENGTH -
+      config?.OCO_OPENAI_MAX_TOKENS;
+
+    if (tokenCount(diff) >= MAX_REQUEST_TOKENS) {
+      const commitMessagePromises = await getCommitMsgsPromisesFromFileDiffs(
+        diff,
+        MAX_REQUEST_TOKENS
+      );
+
+      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);
+
+    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 getMessagesPromisesByLines(fileDiff: string, separator: string) {
-  const lineSeparator = '\n@@';
-  const [fileHeader, ...fileDiffByLines] = fileDiff.split(lineSeparator);
+function getMessagesPromisesByChangesInFile(
+  fileDiff: string,
+  separator: string,
+  maxChangeLength: number
+) {
+  const hunkHeaderSeparator = '@@ ';
+  const [fileHeader, ...fileDiffByLines] = fileDiff.split(hunkHeaderSeparator);
 
   // merge multiple line-diffs into 1 to save tokens
-  const mergedLines = mergeStrings(
-    fileDiffByLines.map((line) => lineSeparator + line),
-    MAX_REQ_TOKENS
+  const mergedChanges = mergeDiffs(
+    fileDiffByLines.map((line) => hunkHeaderSeparator + line),
+    maxChangeLength
   );
 
-  const lineDiffsWithHeader = mergedLines.map(
-    (d) => fileHeader + lineSeparator + d
+  const lineDiffsWithHeader = [];
+  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
+      );
+
+      return engine.generateCommitMessage(messages);
+    }
   );
 
-  const commitMsgsFromFileLineDiffs = lineDiffsWithHeader.map((d) => {
-    const messages = generateCommitMessageChatCompletionPrompt(separator + d);
-
-    return api.generateCommitMessage(messages);
-  });
-
   return commitMsgsFromFileLineDiffs;
 }
 
-function getCommitMsgsPromisesFromFileDiffs(diff: string) {
+function splitDiff(diff: string, maxChangeLength: number) {
+  const lines = diff.split('\n');
+  const splitDiffs = [];
+  let currentDiff = '';
+
+  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
+) => {
   const separator = 'diff --git ';
 
   const diffByFiles = diff.split(separator).slice(1);
 
   // merge multiple files-diffs into 1 prompt to save tokens
-  const mergedFilesDiffs = mergeStrings(diffByFiles, MAX_REQ_TOKENS);
+  const mergedFilesDiffs = mergeDiffs(diffByFiles, maxDiffLength);
 
   const commitMessagePromises = [];
 
   for (const fileDiff of mergedFilesDiffs) {
-    if (fileDiff.length >= MAX_REQ_TOKENS) {
+    if (tokenCount(fileDiff) >= maxDiffLength) {
       // if file-diff is bigger than gpt context — split fileDiff into lineDiff
-      const messagesPromises = getMessagesPromisesByLines(fileDiff, separator);
+      const messagesPromises = getMessagesPromisesByChangesInFile(
+        fileDiff,
+        separator,
+        maxDiffLength
+      );
 
       commitMessagePromises.push(...messagesPromises);
     } else {
-      const messages = generateCommitMessageChatCompletionPrompt(
+      const messages = await generateCommitMessageChatCompletionPrompt(
         separator + fileDiff
       );
 
-      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/cs.json

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

src/i18n/de.json

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

src/i18n/en.json

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

src/i18n/es_ES.json

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

src/i18n/fr.json

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

src/i18n/id_ID.json

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

src/i18n/index.ts

@@ -0,0 +1,94 @@
+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',
+  'zh_CN' = 'zh_CN',
+  'zh_TW' = 'zh_TW',
+  'ja' = 'ja',
+  'cs' = 'cs',
+  'de' = 'de',
+  'fr' = 'fr',
+  'nl' = 'nl',
+  'it' = 'it',
+  'ko' = 'ko',
+  'pt_br' = 'pt_br',
+  'es_ES' = 'es_ES',
+  'sv' = 'sv',
+  'ru' = 'ru',
+  'id_ID' = 'id_ID',
+  'pl' = 'pl',
+  'tr' = 'tr',
+  'th' = 'th'
+}
+
+export const i18n = {
+  en,
+  zh_CN,
+  zh_TW,
+  ja,
+  cs,
+  de,
+  fr,
+  it,
+  ko,
+  pt_br,
+  vi_VN,
+  es_ES,
+  sv,
+  id_ID,
+  nl,
+  ru,
+  pl,
+  tr,
+  th
+};
+
+export const I18N_CONFIG_ALIAS: { [key: string]: string[] } = {
+  zh_CN: ['zh_CN', '简体中文', '中文', '简体'],
+  zh_TW: ['zh_TW', '繁體中文', '繁體'],
+  ja: ['ja', 'Japanese', 'にほんご'],
+  ko: ['ko', 'Korean', '한국어'],
+  cs: ['cs', 'Czech', 'česky'],
+  de: ['de', 'German', 'Deutsch'],
+  fr: ['fr', 'French', 'française'],
+  it: ['it', 'Italian', 'italiano'],
+  nl: ['nl', 'Dutch', 'Nederlands'],
+  pt_br: ['pt_br', 'Portuguese', 'português'],
+  vi_VN: ['vi_VN', 'Vietnamese', 'tiếng Việt'],
+  en: ['en', 'English', 'english'],
+  es_ES: ['es_ES', 'Spanish', 'español'],
+  sv: ['sv', 'Swedish', 'Svenska'],
+  ru: ['ru', 'Russian', 'русский'],
+  id_ID: ['id_ID', 'Bahasa', 'bahasa'],
+  pl: ['pl', 'Polish', 'Polski'],
+  tr: ['tr', 'Turkish', 'Turkish'],
+  th: ['th', 'Thai', 'ไทย']
+};
+
+export function getI18nLocal(value: string): string | boolean {
+  for (const key in I18N_CONFIG_ALIAS) {
+    const aliases = I18N_CONFIG_ALIAS[key];
+    if (aliases.includes(value)) {
+      return key;
+    }
+  }
+  return false;
+}

src/i18n/it.json

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

src/i18n/ja.json

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

src/i18n/ko.json

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

src/i18n/nl.json

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

src/i18n/pl.json

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

src/i18n/pt_br.json

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

src/i18n/ru.json

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

src/i18n/sv.json

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

src/i18n/th.json

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

src/i18n/tr.json

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

src/i18n/vi_VN.json

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

src/i18n/zh_CN.json

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

src/i18n/zh_TW.json

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

src/modules/commitlint/config.ts

@@ -0,0 +1,80 @@
+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, '')));
+  // ... 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,283 @@
+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.
+    
+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,47 @@
+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 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,110 @@
+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';
+
+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): ChatCompletionRequestMessage => ({
+  role: ChatCompletionRequestMessageRoleEnum.System,
+  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages as per the conventional commit convention and explain WHAT were the changes and mainly WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you are to convert it into a commit message.
+    ${
+      config?.OCO_EMOJI
+        ? 'Use GitMoji convention to preface the commit.'
+        : 'Do not preface the commit with anything.'
+    }
+    ${
+      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. 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 ? '🐛 ' : ''}${translation.commitFix}
+${config?.OCO_EMOJI ? '✨ ' : ''}${translation.commitFeat}
+${config?.OCO_DESCRIPTION ? translation.commitDescription : ''}`
+});
+
+export const getMainCommitPrompt = async (): 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),
+        INIT_DIFF_PROMPT,
+        INIT_CONSISTENCY_PROMPT(translation)
+      ];
+  }
+};

src/utils/checkIsLatestVersion.ts

@@ -0,0 +1,26 @@
+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();
+
+  if (latestVersion) {
+    const currentVersion = currentPackage.version;
+
+    if (currentVersion !== latestVersion) {
+      outro(
+        chalk.yellow(
+          `
+You are not using the latest stable version of OpenCommit with new features and bug fixes.
+Current version: ${currentVersion}. Latest version: ${latestVersion}.
+🚀 To update run: npm i -g opencommit@latest.
+        `
+        )
+      );
+    }
+  }
+};

src/utils/engine.ts

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

src/utils/git.ts

@@ -1,5 +1,8 @@
 import { execa } from 'execa';
-import { spinner } from '@clack/prompts';
+import { readFileSync } from 'fs';
+import ignore, { Ignore } from 'ignore';
+
+import { outro, spinner } from '@clack/prompts';
 
 export const assertGitRepo = async () => {
   try {
@@ -9,41 +12,105 @@ export const assertGitRepo = async () => {
   }
 };
 
-const excludeBigFilesFromDiff = ['*-lock.*', '*.lock'].map(
-  (file) => `:(exclude)${file}`
-);
+// const excludeBigFilesFromDiff = ['*-lock.*', '*.lock'].map(
+//   (file) => `:(exclude)${file}`
+// );
 
-export interface StagedDiff {
-  files: string[];
-  diff: string;
-}
+export const getOpenCommitIgnore = (): Ignore => {
+  const ig = ignore();
 
-export const getStagedGitDiff = async (
-  isStageAllFlag = false
-): Promise<StagedDiff | null> => {
-  if (isStageAllFlag) {
-    const stageAllSpinner = spinner();
-    stageAllSpinner.start('Staging all changes');
-    await execa('git', ['add', '.']);
-    stageAllSpinner.stop('Done');
+  try {
+    ig.add(readFileSync('.opencommitignore').toString().split('\n'));
+  } catch (e) {}
+
+  return ig;
+};
+
+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', [
+    'rev-parse',
+    '--show-toplevel'
+  ]);
+
+  const { stdout: files } = await execa('git', [
+    'diff',
+    '--name-only',
+    '--cached',
+    '--relative',
+    gitDir
+  ]);
+
+  if (!files) return [];
+
+  const filesList = files.split('\n');
+
+  const ig = getOpenCommitIgnore();
+  const allowedFiles = filesList.filter((file) => !ig.ignores(file));
+
+  if (!allowedFiles) return [];
+
+  return allowedFiles.sort();
+};
+
+export const getChangedFiles = async (): Promise<string[]> => {
+  const { stdout: modified } = await execa('git', ['ls-files', '--modified']);
+  const { stdout: others } = await execa('git', [
+    'ls-files',
+    '--others',
+    '--exclude-standard'
+  ]);
+
+  const files = [...modified.split('\n'), ...others.split('\n')].filter(
+    (file) => !!file
+  );
+
+  return files.sort();
+};
+
+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.includes('.svg') ||
+      file.includes('.png') ||
+      file.includes('.jpg') ||
+      file.includes('.jpeg') ||
+      file.includes('.webp') ||
+      file.includes('.gif')
+  );
+
+  if (lockFiles.length) {
+    outro(
+      `Some files are excluded by default from 'git diff'. No commit messages are generated for this files:\n${lockFiles.join(
+        '\n'
+      )}`
+    );
   }
 
-  const diffStaged = ['diff', '--staged'];
-  const { stdout: files } = await execa('git', [
-    ...diffStaged,
-    '--name-only',
-    ...excludeBigFilesFromDiff
-  ]);
-
-  if (!files) return null;
+  const filesWithoutLocks = files.filter(
+    (file) => !file.includes('.lock') && !file.includes('-lock.')
+  );
 
   const { stdout: diff } = await execa('git', [
-    ...diffStaged,
-    ...excludeBigFilesFromDiff
+    'diff',
+    '--staged',
+    '--',
+    ...filesWithoutLocks
   ]);
 
-  return {
-    files: files.split('\n').sort(),
-    diff
-  };
+  return diff;
 };

src/utils/mergeDiffs.ts

@@ -1,14 +1,18 @@
-export function mergeStrings(arr: string[], maxStringLength: number): string[] {
+import { tokenCount } from './tokenCount';
+
+export function mergeDiffs(arr: string[], maxStringLength: number): string[] {
   const mergedArr: string[] = [];
   let currentItem: string = arr[0];
   for (const item of arr.slice(1)) {
-    if (currentItem.length + item.length <= maxStringLength) {
+    if (tokenCount(currentItem + item) <= maxStringLength) {
       currentItem += item;
     } else {
       mergedArr.push(currentItem);
       currentItem = item;
     }
   }
+
   mergedArr.push(currentItem);
+
   return mergedArr;
 }

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/sleep.ts

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

src/utils/tokenCount.ts

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

src/utils/trytm.ts

@@ -0,0 +1,12 @@
+export const trytm = async <T>(
+  promise: Promise<T>
+): Promise<[T, null] | [null, Error]> => {
+  try {
+    const data = await promise;
+    return [data, null];
+  } catch (throwable) {
+    if (throwable instanceof Error) return [null, throwable];
+
+    throw throwable;
+  }
+};

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;
+  }
+};

tsconfig.json

@@ -1,12 +1,12 @@
 {
   "compilerOptions": {
-    "target": "ES2020",
+    "target": "ESNext",
     "lib": ["ES5", "ES6"],
 
     "module": "ESNext",
     // "rootDir": "./src",
-    "moduleResolution": "node",
     "resolveJsonModule": true,
+    "moduleResolution": "node",
 
     "allowJs": true,