Revert "Fixing grammatical errors and enhancing overall grammar in README.md (#190)"

This reverts commit 90f64d5475.

.prettierrc

@@ -1,4 +1,4 @@
 {
-  "trailingComma": "none",
-  "singleQuote": true
+  "singleQuote": true,
+  "trailingComma": "none"
 }

README.md

@@ -16,15 +16,15 @@
     <img src=".github/opencommit-example.png" alt="OpenCommit example"/>
 </div>
 
-All the commits in this repo are authored by OpenCommit — look at [the commits](https://github.com/di-sukharev/opencommit/commit/eae7618d575ee8d2e9fff5de56da79d40c4bc5fc) to see how OpenCommit works. Emojis and long commit descriptions are configurable.
+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 your repository branches are meaningful and not lame like `fix1` or `done2`.
+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`.
 
-Create a file `.github/workflows/opencommit.yml` with the contents below:
+Create a file `.github/workflows/opencommit.yml` with contents below:
 
 ```yml
 name: 'OpenCommit Action'
@@ -68,15 +68,15 @@ jobs:
           OCO_LANGUAGE: en
 ```
 
-That is it. Now when you push to any branch in your repo — all NEW commits are being improved by your never-tired AI.
+That is it. Now when you push to any branch in your repo — all NEW commits are being improved by never-tired-AI.
 
-Make sure you exclude public collaboration branches (`main`, `dev`, `etc`) in `branches-ignore`, so OpenCommit does not rebase commits there while improving the messages.
+Make sure you exclude public collaboration branches (`main`, `dev`, `etc`) in `branches-ignore`, so OpenCommit does not rebase commits there when improving the messages.
 
-Interactive rebase (`rebase -i`) changes commits' SHA, so the commit history in remote becomes different from your local branch history. This is okay if you work on the branch alone, but may be inconvenient for other collaborators.
+Interactive rebase (`rebase -i`) changes commit SHA, so commit history in remote becomes different with your local branch history. It's ok when you work on the branch alone, but may be inconvenient for other collaborators.
 
-## Setup OpenCommit as a CLI tool
+## Setup OpenCommit as a CLI
 
-You can use OpenCommit by simply running it via the CLI like this `oco`. 2 seconds and your staged changes are committed with a meaningful message.
+You can use OpenCommit by simply running it via CLI like this `oco`. 2 seconds and your staged changes are committed with a meaningful message.
 
 1. Install OpenCommit globally to use in any repository:
 
@@ -84,7 +84,7 @@ You can use OpenCommit by simply running it via the CLI like this `oco`. 2 secon
    npm install -g opencommit
    ```
 
-2. Get your API key from [OpenAI](https://platform.openai.com/account/api-keys). Make sure that you add your payment details, so the API works.
+2. Get your API key from [OpenAI](https://platform.openai.com/account/api-keys). Make sure you add payment details, so API works.
 
 3. Set the key to OpenCommit config:
 
@@ -92,7 +92,7 @@ You can use OpenCommit by simply running it via the CLI like this `oco`. 2 secon
    opencommit config set OCO_OPENAI_API_KEY=<your_api_key>
    ```
 
-   Your API key is stored locally in the `~/.opencommit` config file.
+   Your api key is stored locally in `~/.opencommit` config file.
 
 ## Usage
 
@@ -107,19 +107,19 @@ You can also use the `oco` shortcut:
 
 ```sh
 git add <files...>
-oco
+oc
 ```
 
 ## Configuration
 
 ### Local per repo configuration
 
-Create a `.env` file and add OpenCommit config variables there like this:
+Create an `.env` file and add OpenCommit config variables there like this:
 
 ```env
-OCO_OPENAI_API_KEY=<your OpenAI API token>
-OCO_OPENAI_MAX_TOKENS=<max response tokens from OpenAI API>
-OCO_OPENAI_BASE_PATH=<may be used to set proxy path to OpenAI api>
+OCO_OPENAI_API_KEY=<your openAI API token>
+OCO_OPENAI_MAX_TOKENS=<max response tokens from openAI API>
+OCO_OPENAI_BASE_PATH=<may be used to set proxy path to openAI api>
 OCO_DESCRIPTION=<postface a message with ~3 sentences description>
 OCO_EMOJI=<add GitMoji>
 OCO_MODEL=<either gpt-3.5-turbo or gpt-4>
@@ -128,9 +128,9 @@ OCO_LANGUAGE=<locale, scroll to the bottom to see options>
 
 ### Global config for all repos
 
-Local config still has more priority than Global config, but you may set `OCO_MODEL` and `OCO_LOCALE` globally and set local configs for `OCO_EMOJI` and `OCO_DESCRIPTION` per repo which is more convenient.
+Local config still has more priority as Global config, but you may set `OCO_MODEL` and `OCO_LOCALE` globally and set local configs for `OCO_EMOJI` and `OCO_DESCRIPTION` per repo which is more convenient.
 
-Simply set any of the variables above like this:
+Simply run any of the variable above like this:
 
 ```sh
 oco config set OCO_OPENAI_API_KEY=gpt-4
@@ -142,7 +142,7 @@ Configure [GitMoji](https://gitmoji.dev/) to preface a message.
 oco config set OCO_EMOJI=true
 ```
 
-To remove preface emojis:
+To remove preface emoji:
 
 ```sh
 oco config set OCO_EMOJI=false
@@ -150,7 +150,7 @@ oco config set OCO_EMOJI=false
 
 ### Switch to GPT-4
 
-By default, OpenCommit uses GPT-3.5-turbo (ChatGPT).
+By default OpenCommit uses GPT-3.5-turbo (ChatGPT).
 
 You may switch to GPT-4 which performs better, but costs ~x15 times more 🤠
 
@@ -158,7 +158,7 @@ You may switch to GPT-4 which performs better, but costs ~x15 times more 🤠
 oco config set OCO_MODEL=gpt-4
 ```
 
-Make sure that you spell it `gpt-4` (lowercase) and that you have API access to the 4th model. Even if you have ChatGPT+, that doesn't necessarily mean that you have API access to GPT-4.
+Make sure you do lowercase `gpt-4` and you have API access to the 4th model. Even if you have ChatGPT+ it doesn't necessarily mean that you have API access to GPT-4.
 
 ## Locale configuration
 
@@ -176,7 +176,7 @@ oco config set OCO_LANGUAGE=French
 oco config set OCO_LANGUAGE=française
 ```
 
-The default language setting is **English**
+The default language set is **English**
 All available languages are currently listed in the [i18n](https://github.com/di-sukharev/opencommit/tree/master/src/i18n) folder
 
 ### Git flags
@@ -193,22 +193,22 @@ is translated to :
 git commit -m "${generatedMessage}" --no-verify
 ```
 
-### Remove files
+### Ignore files
 
-You can remove files from being sent to OpenAI by creating a `.opencommitignore` file. For example:
+You can ignore files from submission to OpenAI by creating a `.opencommitignore` file. For example:
 
 ```ignorelang
 path/to/large-asset.zip
 **/*.jpg
 ```
 
-This helps prevent opencommit from uploading artifacts and large files.
+This is useful for preventing opencommit from uploading artifacts and large files.
 
 By default, opencommit ignores files matching: `*-lock.*` and `*.lock`
 
 ## Git hook (KILLER FEATURE)
 
-You can set OpenCommit as Git [`prepare-commit-msg`](https://git-scm.com/docs/githooks#_prepare_commit_msg) hook. Hook integrates with your IDE Source Control and allows you to edit the message before committing.
+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.
 
 To set the hook:
 
@@ -233,4 +233,4 @@ Or follow the process of your IDE Source Control feature, when it calls `git com
 
 ## Payments
 
-You pay for your requests to OpenAI API. OpenCommit uses ChatGPT (3.5-turbo) official model, which is ~15x times cheaper than GPT-4.
+You pay for your own requests to OpenAI API. OpenCommit uses ChatGPT (3.5-turbo) official model, that is ~15x times cheaper than GPT-4.

package-lock.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencommit",
-  "version": "2.2.10",
+  "version": "2.0.19",
   "description": "Auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
   "keywords": [
     "git",
@@ -41,7 +41,7 @@
     "start": "node ./out/cli.cjs",
     "dev": "ts-node ./src/cli.ts",
     "build": "rimraf out && node esbuild.config.js",
-    "deploy": "npm run build:push && git push --tags && npm publish --tag latest",
+    "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/CommandsEnum.ts

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

src/api.ts

@@ -7,14 +7,9 @@ import {
   OpenAIApi
 } from 'openai';
 
-import {
-  CONFIG_MODES,
-  DEFAULT_MODEL_TOKEN_LIMIT,
-  getConfig
-} from './commands/config';
-import { tokenCount } from './utils/tokenCount';
-import { GenerateCommitMessageErrorEnum } from './generateCommitMessageFromGitDiff';
-import { execa } from 'execa';
+import {CONFIG_MODES, DEFAULT_MODEL_TOKEN_LIMIT, getConfig} from './commands/config';
+import {tokenCount} from './utils/tokenCount';
+import {GenerateCommitMessageErrorEnum} from './generateCommitMessageFromGitDiff';
 
 const config = getConfig();
 
@@ -63,11 +58,11 @@ class OpenAi {
       max_tokens: maxTokens || 500
     };
     try {
-      const REQUEST_TOKENS = messages
-        .map((msg) => tokenCount(msg.content) + 4)
-        .reduce((a, b) => a + b, 0);
+      const REQUEST_TOKENS = messages.map(
+          (msg) => tokenCount(msg.content) + 4
+      ).reduce((a, b) => a + b, 0);
 
-      if (REQUEST_TOKENS > DEFAULT_MODEL_TOKEN_LIMIT - maxTokens) {
+      if (REQUEST_TOKENS > (DEFAULT_MODEL_TOKEN_LIMIT - maxTokens)) {
         throw new Error(GenerateCommitMessageErrorEnum.tooMuchTokens);
       }
 
@@ -103,8 +98,10 @@ export const getOpenCommitLatestVersion = async (): Promise<
   string | undefined
 > => {
   try {
-    const { stdout } = await execa('npm', ['view', 'opencommit', 'version']);
-    return stdout;
+    const { data } = await axios.get(
+      'https://unpkg.com/opencommit/package.json'
+    );
+    return data.version;
   } catch (_) {
     outro('Error while getting the latest version of opencommit');
     return undefined;

src/cli.ts

@@ -7,7 +7,7 @@ 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 { checkIsLatestVersion } from './utils/checkIsLatestVersion';
+// import { checkIsLatestVersion } from './utils/checkIsLatestVersion';
 
 const extraArgs = process.argv.slice(2);
 
@@ -21,7 +21,7 @@ cli(
     help: { description: packageJSON.description }
   },
   async () => {
-    await checkIsLatestVersion();
+    // await checkIsLatestVersion();
 
     if (await isHookCalled()) {
       prepareCommitMessageHook();

src/utils/checkIsLatestVersion.ts

@@ -1,7 +1,6 @@
 import { getOpenCommitLatestVersion } from '../api';
 import currentPackage from '../../package.json' assert { type: 'json' };
 import chalk from 'chalk';
-import { outro } from '@clack/prompts';
 
 export const checkIsLatestVersion = async () => {
   const latestVersion = await getOpenCommitLatestVersion();
@@ -10,7 +9,7 @@ export const checkIsLatestVersion = async () => {
     const currentVersion = currentPackage.version;
 
     if (currentVersion !== latestVersion) {
-      outro(
+      console.warn(
         chalk.yellow(
           `
 You are not using the latest stable version of OpenCommit with new features and bug fixes.