2.0.14

refactor(prepare-commit-msg-hook.ts): remove console.log statement used for debugging purposes

README.md

@@ -54,6 +54,18 @@ oc
 
 ## Features
 
+### Switch to GPT-4
+
+By default OpenCommit uses GPT-3.5-turbo (ChatGPT).
+
+You may switch to GPT-4 which performs better, but costs ~x15 times more 🤠
+
+```sh
+oc config set model=gpt-4
+```
+
+Make sure you do lowercase `gpt-4`.
+
 ### Preface commits with emoji 🤠
 
 [GitMoji](https://gitmoji.dev/) convention is used.
@@ -84,6 +96,24 @@ To remove description:
 oc config set description=false
 ```
 
+### Configure openAI maxTokens param
+
+Default value for `maxTokens` is 196, sometimes you can get 400 error if request+response exceeds `maxToken` parameter.
+
+so you can increase it:
+
+```sh
+oc config set OPENAI_MAX_TOKENS=<number>
+```
+
+### Configure BASE_PATH for openAI api
+
+if you want to call GPT via proxy — you can change `BASE_PATH` parameter:
+
+```sh
+oc config set OPENAI_BASE_PATH=<string>
+```
+
 ### Internationalization support
 
 To specify the language used to generate commit messages:

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "opencommit",
-  "version": "2.0.3",
+  "version": "2.0.14",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "opencommit",
-      "version": "2.0.3",
+      "version": "2.0.14",
       "license": "MIT",
       "dependencies": {
         "@clack/prompts": "^0.6.1",
@@ -22,6 +22,7 @@
       },
       "bin": {
         "oc": "out/cli.cjs",
+        "oco": "out/cli.cjs",
         "opencommit": "out/cli.cjs"
       },
       "devDependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencommit",
-  "version": "2.0.3",
+  "version": "2.0.14",
   "description": "GPT CLI to auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
   "keywords": [
     "git",

src/api.ts

@@ -11,8 +11,9 @@ import { CONFIG_MODES, getConfig } from './commands/config';
 
 const config = getConfig();
 
-let apiKey = config?.OPENAI_API_KEY;
+let maxTokens = config?.OPENAI_MAX_TOKENS;
 let basePath = config?.OPENAI_BASE_PATH;
+let apiKey = config?.OPENAI_API_KEY;
 
 const [command, mode] = process.argv.slice(2);
 
@@ -53,7 +54,7 @@ class OpenAi {
         messages,
         temperature: 0,
         top_p: 0.1,
-        max_tokens: 196
+        max_tokens: maxTokens ?? 196
       });
 
       const message = data.choices[0].message;

src/commands/commit.ts

@@ -73,7 +73,7 @@ ${chalk.grey('——————————————————')}`
       ...extraArgs
     ]);
 
-    outro(`${chalk.green('✔')} successfully committed`);
+    outro(`${chalk.green('✔')} Successfully committed`);
 
     outro(stdout);
 
@@ -102,7 +102,7 @@ ${chalk.grey('——————————————————')}`
         ]);
 
         pushSpinner.stop(
-          `${chalk.green('✔')} successfully pushed all commits to ${remotes[0]}`
+          `${chalk.green('✔')} Successfully pushed all commits to ${remotes[0]}`
         );
 
         if (stdout) outro(stdout);
@@ -126,7 +126,7 @@ ${chalk.grey('——————————————————')}`
         pushSpinner.stop(
           `${chalk.green(
             '✔'
-          )} successfully pushed all commits to ${selectedRemote}`
+          )} Successfully pushed all commits to ${selectedRemote}`
         );
 
         if (stdout) outro(stdout);

src/commands/config.ts

@@ -10,6 +10,7 @@ import { getI18nLocal } from '../i18n';
 
 export enum CONFIG_KEYS {
   OPENAI_API_KEY = 'OPENAI_API_KEY',
+  OPENAI_MAX_TOKENS = 'OPENAI_MAX_TOKENS',
   OPENAI_BASE_PATH = 'OPENAI_BASE_PATH',
   description = 'description',
   emoji = 'emoji',
@@ -63,6 +64,25 @@ export const configValidators = {
     return value;
   },
 
+  [CONFIG_KEYS.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.OPENAI_MAX_TOKENS,
+        !isNaN(value),
+        'Must be a number'
+      );
+    }
+    validateConfig(
+      CONFIG_KEYS.OPENAI_MAX_TOKENS,
+      typeof value === 'number',
+      'Must be a number'
+    );
+
+    return value;
+  },
+
   [CONFIG_KEYS.emoji](value: any) {
     validateConfig(
       CONFIG_KEYS.emoji,
@@ -85,8 +105,8 @@ export const configValidators = {
   [CONFIG_KEYS.OPENAI_BASE_PATH](value: any) {
     validateConfig(
       CONFIG_KEYS.OPENAI_BASE_PATH,
-      typeof value == 'string',
-      `${value} is not supported yet`
+      typeof value === 'string',
+      'Must be string'
     );
     return value;
   },
@@ -148,7 +168,7 @@ export const setConfig = (keyValues: [key: string, value: string][]) => {
 
   writeFileSync(configPath, iniStringify(config), 'utf8');
 
-  outro(`${chalk.green('✔')} config successfully set`);
+  outro(`${chalk.green('✔')} Config successfully set`);
 };
 
 export const configCommand = command(

src/commands/githook.ts

@@ -92,7 +92,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}`);