0.0.4

* ✨ feat(package.json): add publish script
The cli file extension has been changed from .mjs to .cjs to improve compatibility with Node.js. The publish script has been added to simplify the process of publishing a new version of the package to npm.

* 🎨 style(api.ts): remove unused import statement
* 🐛 fix(api.ts): remove setConfig function call
* 🚧 chore(api.ts): add comment to explain apiKey variable initialization
* 🚧 chore(api.ts): comment out code block that prompts user for OPENAI_API_KEY
The unused import statement for `text` function from `@clack/prompts` has been removed. The `setConfig` function call has been removed as it is not needed and was causing an error. A comment has been added to explain the initialization of the `apiKey` variable. The code block that prompts the user for `OPENAI_API_KEY` has been commented out as it is not needed and was causing an error.

* 🐛 fix(tsconfig.json): change target to ES6
The target was previously set to ESNext, which is not supported by all browsers. Changing it to ES6 ensures that the emitted JavaScript is compatible with a wider range of browsers.

README.md

@@ -1,6 +1,6 @@
 <div align="center">
   <div>
-    <img src=".github/OC-grad.svg" alt="OpenCommit logo"/>
+    <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>
@@ -11,6 +11,10 @@
 
 ---
 
+## Examples
+
+Look into [the commits](https://github.com/di-sukharev/opencommit/commit/4795a695800686c42e7c72fca7569103d21cd510) to see how OpenCommit works. Emoji and long commit description text is configurable.
+
 ## Setup
 
 > The minimum supported version of Node.js is the latest v14. Check your Node.js version with `node --version`.

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "open-commit",
-  "version": "0.0.1",
+  "version": "0.0.4",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "open-commit",
-      "version": "0.0.1",
+      "version": "0.0.4",
       "license": "ISC",
       "dependencies": {
         "@clack/prompts": "^0.6.1",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencommit",
-  "version": "0.0.1",
+  "version": "0.0.4",
   "description": "AI generates conventional commits with mind-blowing accuracy.",
   "keywords": [
     "git",
@@ -12,11 +12,14 @@
   ],
   "main": "cli.js",
   "bin": {
-    "opencommit": "./out/cli.mjs",
-    "oc": "./out/cli.mjs"
+    "opencommit": "./out/cli.cjs",
+    "oc": "./out/cli.cjs"
+  },
+  "repository": {
+    "url": "https://github.com/di-sukharev/opencommit"
   },
   "type": "module",
-  "author": "",
+  "author": "https://github.com/di-sukharev",
   "license": "ISC",
   "files": [
     "out/**/*"
@@ -31,9 +34,10 @@
   },
   "scripts": {
     "watch": "npm run -S build -- --sourcemap --watch",
-    "start": "node ./out/cli.mjs",
+    "start": "node ./out/cli.cjs",
     "dev": "ts-node ./src/cli.ts",
-    "build": "rimraf out && esbuild ./src/cli.ts --bundle --outfile=out/cli.mjs --format=esm --platform=node",
+    "build": "rimraf out && esbuild ./src/cli.ts --bundle --outfile=out/cli.cjs --format=cjs --platform=node",
+    "publish": "npm version patch && npm publish",
     "lint": "eslint src --ext ts && tsc --noEmit"
   },
   "devDependencies": {

src/api.ts

@@ -1,4 +1,4 @@
-import { intro, outro, text } from '@clack/prompts';
+import { intro, outro } from '@clack/prompts';
 import {
   ChatCompletionRequestMessage,
   ChatCompletionResponseMessage,
@@ -6,7 +6,7 @@ import {
   OpenAIApi
 } from 'openai';
 
-import { CONFIG_KEYS, getConfig, setConfig } from './commands/config';
+import { getConfig } from './commands/config';
 
 const config = getConfig();
 
@@ -14,15 +14,26 @@ let apiKey = config?.OPENAI_API_KEY;
 
 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');
+  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

src/generateCommitMessageFromGitDiff.ts

@@ -77,13 +77,17 @@ interface GenerateCommitMessageError {
   error: GenerateCommitMessageErrorEnum;
 }
 
+const INIT_MESSAGES_PROMPT_LENGTH = INIT_MESSAGES_PROMPT.map(
+  (msg) => msg.content
+).join('').length;
+
 export const generateCommitMessageWithChatCompletion = async (
   diff: string
 ): Promise<string | GenerateCommitMessageError> => {
   try {
     const MAX_REQ_TOKENS = 3900;
 
-    if (diff.length >= MAX_REQ_TOKENS) {
+    if (INIT_MESSAGES_PROMPT_LENGTH + diff.length >= MAX_REQ_TOKENS) {
       const separator = 'diff --git ';
 
       const diffByFiles = diff.split(separator).slice(1);
@@ -91,11 +95,13 @@ export const generateCommitMessageWithChatCompletion = async (
       const commitMessages = [];
 
       for (const diffFile of diffByFiles) {
-        if (diffFile.length >= MAX_REQ_TOKENS) continue;
+        if (INIT_MESSAGES_PROMPT_LENGTH + diffFile.length >= MAX_REQ_TOKENS)
+          continue;
 
         const messages = generateCommitMessageChatCompletionPrompt(
           separator + diffFile
         );
+
         const commitMessage = await api.generateCommitMessage(messages);
 
         // TODO: handle this edge case

tsconfig.json

@@ -5,7 +5,7 @@
     /* Language and Environment */
     "target": "ESNext" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
     "lib": [
-      "ESNext"
+      "ES6"
     ] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
 
     /* Modules */