2.0.6

* feat(api.ts): add support for OPENAI_MAX_TOKENS environment variable
feat(config.ts): add OPENAI_MAX_TOKENS to CONFIG_KEYS and configValidators

* 2.0.2

* 2.0.3

* docs(README.md): add GPT-4 usage instructions and mention the cost difference compared to GPT-3.5-turbo

---------

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

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.

package-lock.json

@@ -1,15 +1,16 @@
 {
   "name": "opencommit",
-  "version": "1.1.50",
+  "version": "2.0.6",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "opencommit",
-      "version": "1.1.50",
+      "version": "2.0.6",
       "license": "MIT",
       "dependencies": {
         "@clack/prompts": "^0.6.1",
+        "@dqbd/tiktoken": "^1.0.2",
         "axios": "^1.3.4",
         "chalk": "^5.2.0",
         "cleye": "^1.3.2",
@@ -21,6 +22,7 @@
       },
       "bin": {
         "oc": "out/cli.cjs",
+        "oco": "out/cli.cjs",
         "opencommit": "out/cli.cjs"
       },
       "devDependencies": {
@@ -83,6 +85,11 @@
         "node": ">=12"
       }
     },
+    "node_modules/@dqbd/tiktoken": {
+      "version": "1.0.6",
+      "resolved": "https://registry.npmjs.org/@dqbd/tiktoken/-/tiktoken-1.0.6.tgz",
+      "integrity": "sha512-umSdeZTy/SbPPKVuZKV/XKyFPmXSN145CcM3iHjBbmhlohBJg7vaDp4cPCW+xNlWL6L2U1sp7T2BD+di2sUKdA=="
+    },
     "node_modules/@esbuild/android-arm": {
       "version": "0.15.18",
       "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.15.18.tgz",

package.json

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

src/api.ts

@@ -13,6 +13,7 @@ const config = getConfig();
 
 let apiKey = config?.OPENAI_API_KEY;
 let basePath = config?.OPENAI_BASE_PATH;
+let maxTokens = config?.OPENAI_MAX_TOKENS;
 
 const [command, mode] = process.argv.slice(2);
 
@@ -29,6 +30,8 @@ if (!apiKey && command !== 'config' && mode !== CONFIG_MODES.set) {
   process.exit(1);
 }
 
+const MODEL = config?.model || 'gpt-3.5-turbo';
+
 class OpenAi {
   private openAiApiConfiguration = new OpenAiApiConfiguration({
     apiKey: apiKey
@@ -47,11 +50,11 @@ class OpenAi {
   ): Promise<string | undefined> => {
     try {
       const { data } = await this.openAI.createChatCompletion({
-        model: 'gpt-3.5-turbo',
+        model: MODEL,
         messages,
         temperature: 0,
         top_p: 0.1,
-        max_tokens: 196
+        max_tokens: maxTokens ?? 196
       });
 
       const message = data.choices[0].message;

src/commands/config.ts

@@ -10,9 +10,11 @@ import { getI18nLocal } from '../i18n';
 
 export enum CONFIG_KEYS {
   OPENAI_API_KEY = 'OPENAI_API_KEY',
+  OPENAI_MAX_TOKENS = 'OPENAI_MAX_TOKENS',
   OPENAI_BASE_PATH = 'OPENAI_BASE_PATH',
   description = 'description',
   emoji = 'emoji',
+  model = 'model',
   language = 'language'
 }
 
@@ -62,6 +64,16 @@ export const configValidators = {
     return value;
   },
 
+  [CONFIG_KEYS.OPENAI_MAX_TOKENS](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OPENAI_MAX_TOKENS,
+      typeof value === 'number',
+      'Must be a number'
+    );
+
+    return value;
+  },
+
   [CONFIG_KEYS.emoji](value: any) {
     validateConfig(
       CONFIG_KEYS.emoji,
@@ -88,6 +100,15 @@ export const configValidators = {
       `${value} is not supported yet`
     );
     return value;
+  },
+
+  [CONFIG_KEYS.model](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OPENAI_BASE_PATH,
+      value === 'gpt-3.5-turbo' || value === 'gpt-4',
+      `${value} is not supported yet, use 'gpt-4' or 'gpt-3.5-turbo' (default)`
+    );
+    return value;
   }
 };
 

src/generateCommitMessageFromGitDiff.ts

@@ -15,7 +15,7 @@ const INIT_MESSAGES_PROMPT: Array<ChatCompletionRequestMessage> = [
   {
     role: ChatCompletionRequestMessageRoleEnum.System,
     // prettier-ignore
-    content: `You are to act as the author of a commit message in git. Your mission is to create clean and comprehensive commit messages in the conventional commit convention and explain why a change was done. I'll send you an output of 'git diff --staged' command, and you convert it into a commit message.
+    content: `You are to act as the author of a commit message in git. Your mission is to create clean and comprehensive commit messages in the conventional commit convention and explain WHAT were the changes and WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you convert it into a commit message.
 ${config?.emoji? 'Use GitMoji convention to preface the commit.': 'Do not preface the commit with anything.'}
 ${config?.description  ? 'Add a short description of WHY the changes are done after the commit message. Don\'t start it with "This commit", just describe the changes.': "Don't add any descriptions to the commit, only commit message."}
 Use the present tense. Lines must not be longer than 74 characters. Use ${translation.localLanguage} to answer.`

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/en.json

@@ -1,6 +1,6 @@
 {
   "localLanguage": "english",
-  "commitFix": "fix(server.ts): change port variable case from lowercase port to uppercase PORT",
-  "commitFeat": "feat(server.ts): add support for process.env.PORT environment variable",
+  "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/index.ts

@@ -1,4 +1,5 @@
 import en from '../i18n/en.json' assert { type: 'json' };
+import cs from '../i18n/cs.json' assert { type: 'json' };
 import de from '../i18n/de.json' assert { type: 'json' };
 import fr from '../i18n/fr.json' assert { type: 'json' };
 import it from '../i18n/it.json' assert { type: 'json' };
@@ -14,6 +15,7 @@ import nl from '../i18n/nl.json' assert { type: 'json' };
 import ru from '../i18n/ru.json' assert { type: 'json' };
 import id_ID from '../i18n/id_ID.json' assert { type: 'json' };
 import pl from '../i18n/pl.json' assert { type: 'json' };
+import tr from '../i18n/tr.json' assert { type: 'json' };
 import th from '../i18n/th.json' assert { type: 'json' };
 
 export enum I18nLocals {
@@ -21,6 +23,7 @@ export enum I18nLocals {
   'zh_CN' = 'zh_CN',
   'zh_TW' = 'zh_TW',
   'ja' = 'ja',
+  'cs' = 'cs',
   'de' = 'de',
   'fr' = 'fr',
   'nl' = 'nl',
@@ -32,6 +35,7 @@ export enum I18nLocals {
   'ru' = 'ru',
   'id_ID' = 'id_ID',
   'pl' = 'pl',
+  'tr' = 'tr',
   'th' = 'th',
 }
 
@@ -40,6 +44,7 @@ export const i18n = {
   zh_CN,
   zh_TW,
   ja,
+  cs,
   de,
   fr,
   it,
@@ -52,6 +57,7 @@ export const i18n = {
   nl,
   ru,
   pl,
+  tr,
   th
 };
 
@@ -60,6 +66,7 @@ export const I18N_CONFIG_ALIAS: { [key: string]: string[] } = {
   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'],
@@ -72,6 +79,7 @@ export const I18N_CONFIG_ALIAS: { [key: string]: string[] } = {
   ru: ['ru', 'Russian', 'русский'],
   id_ID: ['id_ID', 'Bahasa', 'bahasa'],
   pl: ['pl', 'Polish', 'Polski'],
+  tr: ['tr', 'Turkish', 'Turkish'],
   th: ['th', 'Thai', 'ไทย']
 };
 

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."
+}