chore(README.md): update setup instructions for OpenCommit as a GitHub Action

fix(commit.ts): check if OCO_MESSAGE_TEMPLATE_PLACEHOLDER exists before replacing it in the commit message template
The README.md file has been updated to reflect the changes in the setup instructions for using OpenCommit as a GitHub Action. The new instructions provide a file template for the GitHub Action workflow and include the latest version of the OpenCommit GitHub Action.

In the commit.ts file, a fix has been made to check if the OCO_MESSAGE_TEMPLATE_PLACEHOLDER exists before replacing it in the commit message template. This ensures that the replacement is only performed when the placeholder is present, preventing any potential errors.

.npmignore

@@ -1 +0,0 @@
-out/github-action.cjs

.opencommitignore

@@ -1 +0,0 @@
-out

README.md

@@ -326,8 +326,4 @@ Interactive rebase (`rebase -i`) changes commits' SHA, so the commit history in
 
 ## Payments
 
-You pay for your requests to OpenAI API on your own.
-
-OpenCommit stores your key locally.
-
-OpenCommit by default uses ChatGPT (3.5-turbo-16k) official model, which is a lot cheaper than gpt-4.
+You pay for your requests to OpenAI API. OpenCommit uses ChatGPT (3.5-turbo) official model, which is ~15x times cheaper than GPT-4.

__tests__/cli.test.ts

@@ -1,12 +0,0 @@
-// @ts-ignore
-// import { jest } from '@jest/globals';
-
-import { generateCommitMessageByDiff } from '../src/generateCommitMessageFromGitDiff';
-
-test.skip('generateCommitMessageFromGitDiff', async () => {
-  const GIT_DIFF = ``;
-
-  const res = await generateCommitMessageByDiff(GIT_DIFF);
-
-  expect(res).toBe('lol');
-});

__tests__/split-files.test.ts

@@ -1,79 +0,0 @@
-import { getCommitMsgsPromisesFromFileDiffs } from '../src/generateCommitMessageFromGitDiff';
-
-const oneFileThreeChanges = `diff --git a/example.txt b/example.txt
-index e69de29..3f6a3fa 100644
---- a/example.txt
-+++ b/example.txt
-@@ -1,2 +1,2 @@
--Hello, World!
-+Hello, everyone!
- This is an example file.
-@@ -4,2 +4,2 @@
--Goodbye, World!
-+Goodbye, everyone!
- Have a great day!
-@@ -7,2 +7,2 @@
--It's a sunny day!
-+It's a rainy day!
- Let's go for a walk.`;
-
-const fourFilesOneChangeEach = `diff --git a/file1.txt b/file1.txt
- index e69de29..3f6a3fa 100644
- --- a/file1.txt
- +++ b/file1.txt
- @@ -1,2 +1,2 @@
- -Hello, World!
- +Hello, everyone!
-  This is file 1.
-
- diff --git a/file2.txt b/file2.txt
- index 87c0ddc..d7b182e 100644
- --- a/file2.txt
- +++ b/file2.txt
- @@ -1,3 +1,3 @@
-  This is file 2.
- -Goodbye, World!
- +Goodbye, everyone!
-  Have a great day!
-
- diff --git a/file3.txt b/file3.txt
- index e69de29..3f6a3fa 100644
- --- a/file3.txt
- +++ b/file3.txt
- @@ -1,4 +1,4 @@
-  This is file 3.
- -It's a sunny day!
- +It's a rainy day!
-  Let's go for a walk.
-
- diff --git a/file4.txt b/file4.txt
- index 3f6a3fa..87c0ddc 100644
- --- a/file4.txt
- +++ b/file4.txt
- @@ -1,5 +1,5 @@
-  This is file 4.
- -It's time to sleep.
- +It's time to wake up.
-  Goodnight.
- `;
-
-test('1', async () => {
-  const MAX_LENGTH = 50;
-  const oneFile3Changes = await getCommitMsgsPromisesFromFileDiffs(
-    oneFileThreeChanges,
-    MAX_LENGTH
-  );
-
-  expect(oneFile3Changes).toBe('lol');
-});
-
-test('2', async () => {
-  const MAX_LENGTH = 50;
-
-  const fourFilesOneChange = await getCommitMsgsPromisesFromFileDiffs(
-    fourFilesOneChangeEach,
-    MAX_LENGTH
-  );
-
-  expect(fourFilesOneChange).toBe('lol');
-});

jest.config.ts

@@ -1,21 +0,0 @@
-import type { JestConfigWithTsJest } from 'ts-jest';
-
-const jestConfig: JestConfigWithTsJest = {
-  // [...]
-  extensionsToTreatAsEsm: ['.ts'],
-  moduleNameMapper: {
-    '^(\\.{1,2}/.*)\\.js$': '$1'
-  },
-  transform: {
-    // '^.+\\.[tj]sx?$' to process js/ts with `ts-jest`
-    // '^.+\\.m?[tj]sx?$' to process js/ts/mjs/mts with `ts-jest`
-    '^.+\\.tsx?$': [
-      'ts-jest',
-      {
-        useESM: true
-      }
-    ]
-  }
-};
-
-export default jestConfig;

out/cli.cjs

@@ -22312,7 +22312,7 @@ var generateCommitMessageFromGitDiff = async (diff, extraArgs2) => {
   try {
     let commitMessage = await generateCommitMessageByDiff(diff);
     const messageTemplate = checkMessageTemplate(extraArgs2);
-    if (config7?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER && typeof messageTemplate === "string") {
+    if (typeof messageTemplate === "string") {
       commitMessage = messageTemplate.replace(
         config7?.OCO_MESSAGE_TEMPLATE_PLACEHOLDER,
         commitMessage

package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencommit",
-  "version": "3.0.0",
+  "version": "2.4.2",
   "description": "Auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫",
   "keywords": [
     "git",
@@ -26,8 +26,7 @@
   "author": "https://github.com/di-sukharev",
   "license": "MIT",
   "files": [
-    "out/cli.cjs",
-    "out/tiktoken_bg.wasm"
+    "out/**/*"
   ],
   "release": {
     "branches": [
@@ -43,25 +42,21 @@
     "dev": "ts-node ./src/cli.ts",
     "build": "rimraf out && node esbuild.config.js",
     "build:push": "npm run build && git add . && git commit -m 'build' && git push",
-    "deploy": "npm run build:push && npm version patch && git push --tags && npm publish --tag latest",
+    "deploy": "npm run build:push && npm version patch && git push --tags && git push && npm publish --tag latest",
     "lint": "eslint src --ext ts && tsc --noEmit",
-    "format": "prettier --write src",
-    "test": "NODE_OPTIONS=--experimental-vm-modules jest --verbose --coverage --config jest.config.ts"
+    "format": "prettier --write src"
   },
   "devDependencies": {
     "@commitlint/types": "^17.4.4",
     "@types/ini": "^1.3.31",
     "@types/inquirer": "^9.0.3",
-    "@types/jest": "^29.5.4",
     "@types/node": "^16.18.14",
     "@typescript-eslint/eslint-plugin": "^5.45.0",
     "@typescript-eslint/parser": "^5.45.0",
     "dotenv": "^16.0.3",
     "esbuild": "^0.15.18",
     "eslint": "^8.28.0",
-    "jest": "^29.6.4",
     "prettier": "^2.8.4",
-    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.3"
   },

src/commands/commit.ts

@@ -199,17 +199,17 @@ export async function commit(
     }
 
     if (stagedFiles.length === 0 && changedFiles.length > 0) {
-      const files = await multiselect({
+      const files = (await multiselect({
         message: chalk.cyan('Select the files you want to add to the commit:'),
         options: changedFiles.map((file) => ({
           value: file,
           label: file
         }))
-      });
+      })) as string[];
 
       if (isCancel(files)) process.exit(1);
 
-      await gitAdd({ files: files as string[] });
+      await gitAdd({ files });
     }
 
     await commit(extraArgs, false);

src/prompts.ts

@@ -20,18 +20,11 @@ export const IDENTITY =
 
 const INIT_MAIN_PROMPT = (language: string): ChatCompletionRequestMessage => ({
   role: ChatCompletionRequestMessageRoleEnum.System,
-  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages as per the conventional commit convention and explain WHAT were the changes and mainly WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you are to convert it into a commit message.
-    ${
-      config?.OCO_EMOJI
-        ? 'Use GitMoji convention to preface the commit.'
-        : 'Do not preface the commit with anything.'
-    }
-    ${
-      config?.OCO_DESCRIPTION
-        ? 'Add a short description of WHY the changes are done after the commit message. Don\'t start it with "This commit", just describe the changes.'
-        : "Don't add any descriptions to the commit, only commit message."
-    }
-    Use the present tense. Lines must not be longer than 74 characters. Use ${language} for the commit message.`
+  // prettier-ignore
+  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages in the conventional commit convention and explain WHAT were the changes and WHY the changes were done. I'll send you an output of 'git diff --staged' command, and you convert it into a commit message.
+    ${config?.OCO_EMOJI ? 'Use GitMoji convention to preface the commit.' : 'Do not preface the commit with anything.'}
+    ${config?.OCO_DESCRIPTION ? 'Add a short description of WHY the changes are done after the commit message. Don\'t start it with "This commit", just describe the changes.' : "Don't add any descriptions to the commit, only commit message."}
+    Use the present tense. Lines must not be longer than 74 characters. Use ${language} to answer.`
 });
 
 export const INIT_DIFF_PROMPT: ChatCompletionRequestMessage = {

tsconfig.json

@@ -1,9 +1,9 @@
 {
   "compilerOptions": {
     "target": "ESNext",
-    "module": "ESNext",
-
     "lib": ["ES5", "ES6"],
+
+    "module": "ESNext",
     // "rootDir": "./src",
     "resolveJsonModule": true,
     "moduleResolution": "node",