0.0.20

The section on Git hook was previously commented out, but it is now included in the README.md file.

* 🐛 fix(package.json): change cli file extension from .mjs to .cjs
* 🚀 chore(package.json): remove unnecessary banner from build script
The cli file extension has been changed from .mjs to .cjs to ensure compatibility with Node.js versions that do not support ECMAScript modules. The banner in the build script has been removed as it is no longer necessary with the change in file extension.

* 🐛 fix(githook.ts): change HOOK_PATH to HOOK_URL
The HOOK_PATH variable was changed to HOOK_URL to fix an issue where the symlink was not being created correctly. The HOOK_URL variable now uses the __filename global variable to get the path of the current file.

* 🐛 fix(tsconfig.json): change target to ES2020 and module to CommonJS
The target version of JavaScript has been changed to ES2020 to take advantage of the latest features of the language. The module has been changed to CommonJS to ensure compatibility with Node.js.

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`.

TODO.md

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

package-lock.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencommit",
-  "version": "0.0.1",
+  "version": "0.0.20",
   "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",
+    "deploy": "npm run build && 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/commands/githook.ts

@@ -20,7 +20,7 @@ export const hookCommand = command(
     parameters: ['<set/unset>']
   },
   async (argv) => {
-    const HOOK_PATH = fileURLToPath(new URL('cli.mjs', import.meta.url));
+    const HOOK_URL = __filename;
 
     try {
       await assertGitRepo();
@@ -29,10 +29,17 @@ export const hookCommand = command(
 
       if (mode === 'set') {
         intro(`setting opencommit as '${HOOK_NAME}' hook`);
-        if (isHookExists) {
-          const realPath = await fs.realpath(SYMLINK_URL);
 
-          if (realPath === HOOK_PATH)
+        if (isHookExists) {
+          let realPath;
+          try {
+            realPath = await fs.realpath(SYMLINK_URL);
+          } catch (error) {
+            outro(error as string);
+            realPath = null;
+          }
+
+          if (realPath === HOOK_URL)
             return outro(`opencommit is already set as '${HOOK_NAME}'`);
 
           throw new Error(
@@ -41,7 +48,7 @@ export const hookCommand = command(
         }
 
         await fs.mkdir(path.dirname(SYMLINK_URL), { recursive: true });
-        await fs.symlink(HOOK_PATH, SYMLINK_URL, 'file');
+        await fs.symlink(HOOK_URL, SYMLINK_URL, 'file');
         await fs.chmod(SYMLINK_URL, 0o755);
 
         return outro(`${chalk.green('✔')} Hook set`);
@@ -49,6 +56,7 @@ export const hookCommand = command(
 
       if (mode === 'unset') {
         intro(`unsetting opencommit as '${HOOK_NAME}' hook`);
+
         if (!isHookExists) {
           return outro(
             `opencommit wasn't previously set as '${HOOK_NAME}' hook, nothing to remove`
@@ -56,7 +64,7 @@ export const hookCommand = command(
         }
 
         const realpath = await fs.realpath(SYMLINK_URL);
-        if (realpath !== HOOK_PATH) {
+        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`
           );

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

@@ -3,13 +3,13 @@
     /* Projects */
 
     /* Language and Environment */
-    "target": "ESNext" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    "target": "ES2020" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
     "lib": [
-      "ESNext"
+      "ES5"
     ] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
 
     /* Modules */
-    "module": "ESNext" /* Specify what module code is generated. */,
+    "module": "CommonJS" /* Specify what module code is generated. */,
     // "rootDir": "./src" /* Specify the root folder within your source files. */,
     "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */,
     "resolveJsonModule": true /* Enable importing .json files. */,