build

* feat(config): add OCO_WHY configuration option to enable output of change explanations in commit messages
docs(README): document the new OCO_WHY config option and its usage for outputting reasons for changes

README.md

@@ -76,7 +76,8 @@ oco config set OCO_AI_PROVIDER='ollama'
 If you want to use a model other than mistral (default), you can do so by setting the `OCO_AI_PROVIDER` environment variable as follows:
 
 ```sh
-oco config set OCO_AI_PROVIDER='ollama/llama3:8b'
+oco config set OCO_AI_PROVIDER='ollama'
+oco config set OCO_MODEL='llama3:8b'
 ```
 
 If you have ollama that is set up in docker/ on another machine with GPUs (not locally), you can change the default endpoint url.
@@ -127,12 +128,12 @@ OCO_TOKENS_MAX_OUTPUT=<max response tokens (default: 500)>
 OCO_OPENAI_BASE_PATH=<may be used to set proxy path to OpenAI api>
 OCO_DESCRIPTION=<postface a message with ~3 sentences description of the changes>
 OCO_EMOJI=<boolean, add GitMoji>
-OCO_MODEL=<either 'gpt-4o', 'gpt-4', 'gpt-4-turbo', 'gpt-3.5-turbo' (default), 'gpt-3.5-turbo-0125', 'gpt-4-1106-preview', 'gpt-4-turbo-preview' or 'gpt-4-0125-preview' or any string basically, but it should be a valid model name>
+OCO_MODEL=<either 'gpt-4o', 'gpt-4', 'gpt-4-turbo', 'gpt-3.5-turbo' (default), 'gpt-3.5-turbo-0125', 'gpt-4-1106-preview', 'gpt-4-turbo-preview' or 'gpt-4-0125-preview' or any Anthropic or Ollama model or any string basically, but it should be a valid model name>
 OCO_LANGUAGE=<locale, scroll to the bottom to see options>
 OCO_MESSAGE_TEMPLATE_PLACEHOLDER=<message template placeholder, default: '$msg'>
 OCO_PROMPT_MODULE=<either conventional-commit or @commitlint, default: conventional-commit>
 OCO_ONE_LINE_COMMIT=<one line commit message, default: false>
-OCO_AI_PROVIDER=<openai (default), anthropic, azure, ollama or ollama/model>
+OCO_AI_PROVIDER=<openai (default), anthropic, azure, ollama>
 ...
 ```
 
@@ -162,6 +163,16 @@ oco config set OCO_EMOJI=false
 
 Other config options are behaving the same.
 
+### Output WHY the changes were done (WIP)
+
+You can set the `OCO_WHY` config to `true` to have OpenCommit output a short description of WHY the changes were done after the commit message. Default is `false`.
+
+To make this perform accurate we must store 'what files do' in some kind of an index or embedding and perform a lookup (kinda RAG) for the accurate git commit message. If you feel like building this comment on this ticket https://github.com/di-sukharev/opencommit/issues/398 and let's go from there together.
+
+```sh
+oco config set OCO_WHY=true
+```
+
 ### Switch to GPT-4 or other models
 
 By default, OpenCommit uses `gpt-4o-mini` model.

package-lock.json

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

package.json

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

src/commands/config.ts

@@ -23,6 +23,7 @@ export enum CONFIG_KEYS {
   OCO_EMOJI = 'OCO_EMOJI',
   OCO_MODEL = 'OCO_MODEL',
   OCO_LANGUAGE = 'OCO_LANGUAGE',
+  OCO_WHY = 'OCO_WHY',
   OCO_MESSAGE_TEMPLATE_PLACEHOLDER = 'OCO_MESSAGE_TEMPLATE_PLACEHOLDER',
   OCO_PROMPT_MODULE = 'OCO_PROMPT_MODULE',
   OCO_AI_PROVIDER = 'OCO_AI_PROVIDER',
@@ -376,6 +377,7 @@ export type ConfigType = {
   [CONFIG_KEYS.OCO_OPENAI_BASE_PATH]?: string;
   [CONFIG_KEYS.OCO_DESCRIPTION]: boolean;
   [CONFIG_KEYS.OCO_EMOJI]: boolean;
+  [CONFIG_KEYS.OCO_WHY]: boolean;
   [CONFIG_KEYS.OCO_MODEL]: string;
   [CONFIG_KEYS.OCO_LANGUAGE]: string;
   [CONFIG_KEYS.OCO_MESSAGE_TEMPLATE_PLACEHOLDER]: string;
@@ -435,6 +437,7 @@ export const DEFAULT_CONFIG = {
   OCO_ONE_LINE_COMMIT: false,
   OCO_TEST_MOCK_TYPE: 'commit-message',
   OCO_FLOWISE_ENDPOINT: ':',
+  OCO_WHY: false,
   OCO_GITPUSH: true // todo: deprecate
 };
 

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

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

src/engine/ollama.ts

@@ -28,7 +28,10 @@ export class OllamaAi implements AiEngine {
       stream: false
     };
     try {
-      const response = await this.client.post('', params);
+      const response = await this.client.post(
+        this.client.getUri(this.config),
+        params
+      );
 
       const message = response.data.message;
 

src/modules/commitlint/prompts.ts

@@ -258,7 +258,9 @@ const INIT_MAIN_PROMPT = (
   prompts: string[]
 ): OpenAI.Chat.Completions.ChatCompletionMessageParam => ({
   role: 'system',
-  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages in the given @commitlint convention and explain WHAT were the changes 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.
+  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages in the given @commitlint convention and explain WHAT were the changes ${
+    config.OCO_WHY ? 'and WHY the changes were done' : ''
+  }. I'll send you an output of 'git diff --staged' command, and you convert it into a commit message.
 ${
   config.OCO_EMOJI
     ? 'Use GitMoji convention to preface the commit.'