0.0.16

This commit changes the file mode of cli.ts from 100644 to 100755. This change allows the file to be executable.

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`.
@@ -79,7 +83,7 @@ To remove description:
 opencommit config set description=false
 ```
 
-## Git hook
+<!-- ## Git hook
 
 You can set opencommit as Git [`prepare-commit-msg`](https://git-scm.com/docs/githooks#_prepare_commit_msg) hook. Hook integrates with you IDE Source Control and allows you edit the message before commit.
 
@@ -102,7 +106,7 @@ To use the hook:
    git commit
 ```
 
-Or follow the process of your IDE Source Control feature, when it calls `git commit` command — OpenCommit will integrate into the flow.
+Or follow the process of your IDE Source Control feature, when it calls `git commit` command — OpenCommit will integrate into the flow. -->
 
 ## Payments
 

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.16",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "open-commit",
-      "version": "0.0.1",
+      "version": "0.0.16",
       "license": "ISC",
       "dependencies": {
         "@clack/prompts": "^0.6.1",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencommit",
-  "version": "0.0.1",
+  "version": "0.0.16",
   "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",
+    "patch": "npm version patch",
     "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_PATH = fileURLToPath(new URL('cli.cjs', import.meta.url));
 
     try {
       await assertGitRepo();
@@ -29,8 +29,15 @@ export const hookCommand = command(
 
       if (mode === 'set') {
         intro(`setting opencommit as '${HOOK_NAME}' hook`);
+
         if (isHookExists) {
-          const realPath = await fs.realpath(SYMLINK_URL);
+          let realPath;
+          try {
+            realPath = await fs.realpath(SYMLINK_URL);
+          } catch (error) {
+            outro(error as string);
+            realPath = null;
+          }
 
           if (realPath === HOOK_PATH)
             return outro(`opencommit is already set as '${HOOK_NAME}'`);
@@ -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`

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 */