chore: update package and action descriptions to better reflect the purpose of the project and remove unnecessary details

feat: add keywords to package and action descriptions to improve searchability and discoverability of the project
feat: update deploy script in package.json to include version bump and publish to npm registry with latest tag

.eslintrc.json

@@ -21,8 +21,8 @@
   "rules": {
     "prettier/prettier": "error",
     "no-console": "error",
-    "import/order": "off",
     "sort-imports": "off",
+    "import/order": "off",
     "simple-import-sort/imports": "error",
     "simple-import-sort/exports": "error",
     "import/first": "error",

.prettierignore

@@ -1,3 +1,2 @@
 /build
-/dist
-/out
+/dist

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Dima Sukharev, https://github.com/di-sukharev
+Copyright (c) Dima Sukharev
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

README.md

@@ -5,7 +5,7 @@
     <h4 align="center">Follow the bird <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>
-	<h2>Auto-generate meaningful commits in 1 second</h2>
+	<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>
@@ -18,16 +18,22 @@
 
 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.
 
-## Setup OpenCommit as a Github Action 🔥
+## Setup OpenCommit as a Github Action
 
 OpenCommit is now available as a GitHub Action which automatically improves all new commits messages when you push to remote!
 
 This is great if you want to make sure all of the commits in all of repository branches are meaningful and not lame like `fix1` or `done2`.
 
+### Automatic 1 click setup
+
+You can simply [setup the action automatically via the GitHub Marketplace](TODO).
+
+### Manual 3 clicks setup
+
 Create a file `.github/workflows/opencommit.yml` with contents below:
 
 ```yml
-name: 'OpenCommit Action'
+name: 'OpenCommit'
 
 on:
   push:
@@ -48,7 +54,7 @@ jobs:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - uses: di-sukharev/opencommit@github-action-v1.0.4
+      - uses: di-sukharev/opencommit@github-action
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

action.yml

@@ -1,10 +1,7 @@
-name: 'OpenCommit — improve commits with AI 🧙'
-description: 'Replaces lame commit messages with meaningful AI-generated messages when you push to remote'
+name: 'OpenCommit'
+description: 'Replaces lame commit messages with meaningful AI-generated messages when you push to remote 🤯🔫'
 author: 'https://github.com/di-sukharev'
 repo: 'https://github.com/di-sukharev/opencommit/tree/github-action'
-branding:
-  icon: 'git-commit'
-  color: 'green'
 keywords:
   [
     'git',

out/cli.cjs

@@ -16272,7 +16272,7 @@ function G3(t, e2) {
 // package.json
 var package_default = {
   name: "opencommit",
-  version: "2.0.17",
+  version: "2.0.15",
   description: "Auto-generate impressive commits in 1 second. Killing lame commits with AI \u{1F92F}\u{1F52B}",
   keywords: [
     "git",
@@ -16315,7 +16315,6 @@ var package_default = {
     dev: "ts-node ./src/cli.ts",
     build: "rimraf out && node esbuild.config.js",
     deploy: "npm run build && npm version patch && npm publish --tag latest",
-    "build:push": "npm run build && git add . && git commit -m 'build' && git push",
     lint: "eslint src --ext ts && tsc --noEmit",
     format: "prettier --write src"
   },
@@ -17644,7 +17643,7 @@ var configValidators = {
     }
     validateConfig(
       "OCO_OPENAI_MAX_TOKENS" /* OCO_OPENAI_MAX_TOKENS */,
-      value ? typeof value === "number" : void 0,
+      typeof value === "number",
       "Must be a number"
     );
     return value;
@@ -17675,8 +17674,8 @@ var configValidators = {
   },
   ["OCO_MODEL" /* OCO_MODEL */](value) {
     validateConfig(
-      "OCO_MODEL" /* OCO_MODEL */,
-      ["gpt-3.5-turbo", "gpt-4"].includes(value),
+      "OCO_OPENAI_BASE_PATH" /* OCO_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;
@@ -17686,12 +17685,12 @@ var configPath = (0, import_path.join)((0, import_os.homedir)(), ".opencommit");
 var getConfig = () => {
   const configFromEnv = {
     OCO_OPENAI_API_KEY: process.env.OCO_OPENAI_API_KEY,
-    OCO_OPENAI_MAX_TOKENS: process.env.OCO_OPENAI_MAX_TOKENS ? Number(process.env.OCO_OPENAI_MAX_TOKENS) : void 0,
+    OCO_OPENAI_MAX_TOKENS: Number(process.env.OCO_OPENAI_MAX_TOKENS),
     OCO_OPENAI_BASE_PATH: process.env.OCO_OPENAI_BASE_PATH,
     OCO_DESCRIPTION: process.env.OCO_DESCRIPTION === "true" ? true : false,
     OCO_EMOJI: process.env.OCO_EMOJI === "true" ? true : false,
-    OCO_MODEL: process.env.OCO_MODEL || "gpt-3.5-turbo",
-    OCO_LANGUAGE: process.env.OCO_LANGUAGE || "en"
+    OCO_MODEL: process.env.OCO_MODEL,
+    OCO_LANGUAGE: process.env.OCO_LANGUAGE
   };
   const configExists = (0, import_fs.existsSync)(configPath);
   if (!configExists)
@@ -17699,10 +17698,6 @@ var getConfig = () => {
   const configFile = (0, import_fs.readFileSync)(configPath, "utf8");
   const config4 = (0, import_ini.parse)(configFile);
   for (const configKey of Object.keys(config4)) {
-    if (!config4[configKey] || ["null", "undefined"].includes(config4[configKey])) {
-      config4[configKey] = void 0;
-      continue;
-    }
     try {
       const validator = configValidators[configKey];
       const validValue = validator(

out/github-action.cjs

@@ -26839,7 +26839,7 @@ var configValidators = {
     }
     validateConfig(
       "OCO_OPENAI_MAX_TOKENS" /* OCO_OPENAI_MAX_TOKENS */,
-      value ? typeof value === "number" : void 0,
+      typeof value === "number",
       "Must be a number"
     );
     return value;
@@ -26870,8 +26870,8 @@ var configValidators = {
   },
   ["OCO_MODEL" /* OCO_MODEL */](value) {
     validateConfig(
-      "OCO_MODEL" /* OCO_MODEL */,
-      ["gpt-3.5-turbo", "gpt-4"].includes(value),
+      "OCO_OPENAI_BASE_PATH" /* OCO_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;
@@ -26881,12 +26881,12 @@ var configPath = (0, import_path.join)((0, import_os.homedir)(), ".opencommit");
 var getConfig = () => {
   const configFromEnv = {
     OCO_OPENAI_API_KEY: process.env.OCO_OPENAI_API_KEY,
-    OCO_OPENAI_MAX_TOKENS: process.env.OCO_OPENAI_MAX_TOKENS ? Number(process.env.OCO_OPENAI_MAX_TOKENS) : void 0,
+    OCO_OPENAI_MAX_TOKENS: Number(process.env.OCO_OPENAI_MAX_TOKENS),
     OCO_OPENAI_BASE_PATH: process.env.OCO_OPENAI_BASE_PATH,
     OCO_DESCRIPTION: process.env.OCO_DESCRIPTION === "true" ? true : false,
     OCO_EMOJI: process.env.OCO_EMOJI === "true" ? true : false,
-    OCO_MODEL: process.env.OCO_MODEL || "gpt-3.5-turbo",
-    OCO_LANGUAGE: process.env.OCO_LANGUAGE || "en"
+    OCO_MODEL: process.env.OCO_MODEL,
+    OCO_LANGUAGE: process.env.OCO_LANGUAGE
   };
   const configExists = (0, import_fs.existsSync)(configPath);
   if (!configExists)
@@ -26894,10 +26894,6 @@ var getConfig = () => {
   const configFile = (0, import_fs.readFileSync)(configPath, "utf8");
   const config4 = (0, import_ini.parse)(configFile);
   for (const configKey of Object.keys(config4)) {
-    if (!config4[configKey] || ["null", "undefined"].includes(config4[configKey])) {
-      config4[configKey] = void 0;
-      continue;
-    }
     try {
       const validator = configValidators[configKey];
       const validValue = validator(

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "opencommit",
-  "version": "2.0.18",
+  "version": "2.0.15",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "opencommit",
-      "version": "2.0.18",
+      "version": "2.0.15",
       "license": "MIT",
       "dependencies": {
         "@actions/core": "^1.10.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencommit",
-  "version": "2.0.18",
+  "version": "2.0.15",
   "description": "Auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
   "keywords": [
     "git",
@@ -43,7 +43,6 @@
     "dev": "ts-node ./src/cli.ts",
     "build": "rimraf out && node esbuild.config.js",
     "deploy": "npm run build && npm version patch && npm publish --tag latest",
-    "build:push": "npm run build && git add . && git commit -m 'build' && git push",
     "lint": "eslint src --ext ts && tsc --noEmit",
     "format": "prettier --write src"
   },

src/commands/commit.ts

@@ -1,5 +1,6 @@
 import { execa } from 'execa';
 import {
+  GenerateCommitMessageErrorEnum,
   generateCommitMessageByDiff
 } from '../generateCommitMessageFromGitDiff';
 import {

src/commands/config.ts

@@ -80,7 +80,7 @@ export const configValidators = {
     }
     validateConfig(
       CONFIG_KEYS.OCO_OPENAI_MAX_TOKENS,
-      value ? typeof value === 'number' : undefined,
+      typeof value === 'number',
       'Must be a number'
     );
 
@@ -117,8 +117,8 @@ export const configValidators = {
 
   [CONFIG_KEYS.OCO_MODEL](value: any) {
     validateConfig(
-      CONFIG_KEYS.OCO_MODEL,
-      ['gpt-3.5-turbo', 'gpt-4'].includes(value),
+      CONFIG_KEYS.OCO_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;
@@ -134,12 +134,12 @@ const configPath = pathJoin(homedir(), '.opencommit');
 export const getConfig = (): ConfigType | null => {
   const configFromEnv = {
     OCO_OPENAI_API_KEY: process.env.OCO_OPENAI_API_KEY,
-    OCO_OPENAI_MAX_TOKENS: process.env.OCO_OPENAI_MAX_TOKENS ? Number(process.env.OCO_OPENAI_MAX_TOKENS) : undefined,
+    OCO_OPENAI_MAX_TOKENS: Number(process.env.OCO_OPENAI_MAX_TOKENS),
     OCO_OPENAI_BASE_PATH: process.env.OCO_OPENAI_BASE_PATH,
     OCO_DESCRIPTION: process.env.OCO_DESCRIPTION === 'true' ? true : false,
     OCO_EMOJI: process.env.OCO_EMOJI === 'true' ? true : false,
-    OCO_MODEL: process.env.OCO_MODEL || 'gpt-3.5-turbo',
-    OCO_LANGUAGE: process.env.OCO_LANGUAGE || 'en'
+    OCO_MODEL: process.env.OCO_MODEL,
+    OCO_LANGUAGE: process.env.OCO_LANGUAGE
   };
 
   const configExists = existsSync(configPath);
@@ -149,10 +149,6 @@ export const getConfig = (): ConfigType | null => {
   const config = iniParse(configFile);
 
   for (const configKey of Object.keys(config)) {
-    if (!config[configKey] || ['null', 'undefined'].includes(config[configKey])) {
-      config[configKey] = undefined;
-      continue;
-    }
     try {
       const validator = configValidators[configKey as CONFIG_KEYS];
       const validValue = validator(

src/generateCommitMessageFromGitDiff.ts

@@ -74,6 +74,9 @@ export enum GenerateCommitMessageErrorEnum {
   emptyMessage = 'EMPTY_MESSAGE'
 }
 
+interface GenerateCommitMessageError {
+  error: GenerateCommitMessageErrorEnum;
+}
 
 const INIT_MESSAGES_PROMPT_LENGTH = INIT_MESSAGES_PROMPT.map(
   (msg) => tokenCount(msg.content) + 4

tsconfig.json

@@ -5,8 +5,8 @@
 
     "module": "ESNext",
     // "rootDir": "./src",
-    "resolveJsonModule": true,
     "moduleResolution": "node",
+    "resolveJsonModule": true,
 
     "allowJs": true,