1.0.15

* refactor(api.ts): use CONFIG_MODES enum from config.ts
* refactor(config.ts): use COMMANDS and CONFIG_MODES enums, extract validateConfig function
* feat(config.ts): add CONFIG_MODES enum and refactor configCommand function to use it

* refactor(githook.ts): import COMMANDS enum from CommandsEnum.js file

README.md

@@ -5,13 +5,16 @@
     <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>
   </div>
-	<p>AI generates conventional commits with mind-blowing accuracy</p>
+	<h2>GPT CLI to auto-generate impressive commits in 1 second</h2>
+	<p>Killing lame commits with AI 🤯🔫</p>
 	<a href="https://www.npmjs.com/package/opencommit"><img src="https://img.shields.io/npm/v/opencommit" alt="Current version"></a>
 </div>
 
 ---
 
-## Examples
+<div align="center">
+    <img src=".github/opencommit-example.png" alt="OpenCommit example"/>
+</div>
 
 All the commits in this repo are done with OpenCommit — look into [the commits](https://github.com/di-sukharev/opencommit/commit/eae7618d575ee8d2e9fff5de56da79d40c4bc5fc) to see how OpenCommit works. Emoji and long commit description text is configurable.
 
@@ -30,10 +33,10 @@ All the commits in this repo are done with OpenCommit — look into [the commits
 3. Set the key to opencommit config:
 
    ```sh
-   opencommit config set OPENAI_API_KEY=<your token>
+   opencommit config set OPENAI_API_KEY=<your_api_key>
    ```
 
-   Your token isn't sent to anyone, it's saved in `~/.opencommit` config file.
+   Your api key is stored locally in `~/.opencommit` config file.
 
 ## Usage
 

package-lock.json

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

package.json

@@ -1,13 +1,17 @@
 {
   "name": "opencommit",
-  "version": "1.0.5",
-  "description": "AI generates conventional commits with mind-blowing accuracy.",
+  "version": "1.0.15",
+  "description": "GPT CLI to auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
   "keywords": [
     "git",
     "chatgpt",
     "gpt",
     "ai",
     "openai",
+    "opencommit",
+    "aicommit",
+    "aicommits",
+    "gptcommit",
     "commit"
   ],
   "main": "cli.js",

src/CommandsEnum.ts

@@ -0,0 +1,4 @@
+export enum COMMANDS {
+  config = 'config',
+  hook = 'hook'
+}

src/api.ts

@@ -5,13 +5,15 @@ import {
   OpenAIApi
 } from 'openai';
 
-import { getConfig } from './commands/config';
+import { CONFIG_MODES, getConfig } from './commands/config';
 
 const config = getConfig();
 
 let apiKey = config?.OPENAI_API_KEY;
 
-if (!apiKey) {
+const [command, mode] = process.argv.slice(2);
+
+if (!apiKey && command !== 'config' && mode !== CONFIG_MODES.set) {
   intro('opencommit');
 
   outro(
@@ -20,6 +22,8 @@ if (!apiKey) {
   outro(
     'For help Look into README https://github.com/di-sukharev/opencommit#setup'
   );
+
+  process.exit(1);
 }
 
 // if (!apiKey) {

src/cli.ts

@@ -7,6 +7,8 @@ import { configCommand } from './commands/config';
 import { hookCommand, isHookCalled } from './commands/githook.js';
 import { prepareCommitMessageHook } from './commands/prepare-commit-msg-hook';
 import { commit } from './commands/commit';
+import { execa } from 'execa';
+import { outro } from '@clack/prompts';
 
 const rawArgv = process.argv.slice(2);
 
@@ -19,11 +21,17 @@ cli(
     ignoreArgv: (type) => type === 'unknown-flag' || type === 'argument',
     help: { description: packageJSON.description }
   },
-  () => {
+  async () => {
     if (isHookCalled) {
-      prepareCommitMessageHook();
+      await prepareCommitMessageHook();
     } else {
-      commit();
+      await commit();
+      const { stdout } = await execa('npm', ['view', 'opencommit', 'version']);
+
+      if (stdout !== packageJSON.version)
+        outro(
+          'new opencommit version is available, update with `npm i -g opencommit`'
+        );
     }
   },
   rawArgv

src/commands/commit.ts

@@ -16,6 +16,7 @@ const generateCommitMessageFromGitDiff = async (
   commitSpinner.start('Generating the commit message');
   const commitMessage = await generateCommitMessageWithChatCompletion(diff);
 
+  // TODO: show proper error messages
   if (typeof commitMessage !== 'string') {
     const errorMessages = {
       [GenerateCommitMessageErrorEnum.emptyMessage]:
@@ -51,10 +52,14 @@ ${chalk.grey('——————————————————')}`
       message: 'Do you want to run `git push`?'
     });
 
-    if (isPushConfirmedByUser) {
+    if (isPushConfirmedByUser && !isCancel(isPushConfirmedByUser)) {
+      const pushSpinner = spinner();
+
+      pushSpinner.start('Running `git push`');
       const { stdout } = await execa('git', ['push']);
-      outro(`${chalk.green('✔')} successfully pushed all commits`);
-      outro(stdout);
+      pushSpinner.stop(`${chalk.green('✔')} successfully pushed all commits`);
+
+      if (stdout) outro(stdout);
     }
   } else outro(`${chalk.gray('✖')} process cancelled`);
 };

src/commands/config.ts

@@ -5,6 +5,7 @@ import { existsSync, writeFileSync, readFileSync } from 'fs';
 import { homedir } from 'os';
 import { intro, outro } from '@clack/prompts';
 import chalk from 'chalk';
+import { COMMANDS } from '../CommandsEnum';
 
 export enum CONFIG_KEYS {
   OPENAI_API_KEY = 'OPENAI_API_KEY',
@@ -12,6 +13,11 @@ export enum CONFIG_KEYS {
   emoji = 'emoji'
 }
 
+export enum CONFIG_MODES {
+  get = 'get',
+  set = 'set'
+}
+
 const validateConfig = (
   key: string,
   condition: any,
@@ -110,7 +116,7 @@ export const setConfig = (keyValues: [key: string, value: string][]) => {
 
 export const configCommand = command(
   {
-    name: 'config',
+    name: COMMANDS.config,
     parameters: ['<mode>', '<key=values...>']
   },
   async (argv) => {
@@ -118,12 +124,12 @@ export const configCommand = command(
     try {
       const { mode, keyValues } = argv._;
 
-      if (mode === 'get') {
+      if (mode === CONFIG_MODES.get) {
         const config = getConfig() || {};
         for (const key of keyValues) {
           outro(`${key}=${config[key as keyof typeof config]}`);
         }
-      } else if (mode === 'set') {
+      } else if (mode === CONFIG_MODES.set) {
         await setConfig(
           keyValues.map((keyValue) => keyValue.split('=') as [string, string])
         );

src/commands/githook.ts

@@ -5,6 +5,7 @@ import { assertGitRepo } from '../utils/git.js';
 import { existsSync } from 'fs';
 import chalk from 'chalk';
 import { intro, outro } from '@clack/prompts';
+import { COMMANDS } from '../CommandsEnum.js';
 
 const HOOK_NAME = 'prepare-commit-msg';
 const SYMLINK_URL = `.git/hooks/${HOOK_NAME}`;
@@ -15,7 +16,7 @@ const isHookExists = existsSync(SYMLINK_URL);
 
 export const hookCommand = command(
   {
-    name: 'hook',
+    name: COMMANDS.hook,
     parameters: ['<set/unset>']
   },
   async (argv) => {