refactor: Update TS config to ES2021 and add new file

Update the target property in tsconfig.json from es2020 to es2021.
Create a new file 'src/utils/removeEscapeCharacters.ts' to implement a utility function for removing escape characters.

made by ollama-commit

Author: 김덕현

src/config.ts

@@ -1,14 +1,28 @@
 import * as dotenv from "dotenv";
 
-import { DEFAULT_LANGUAGE, DEFAULT_MODEL, DEFAULT_PROVIDER } from "./constants";
+import {
+  DEFAULT_API_HOST,
+  DEFAULT_LANGUAGE,
+  DEFAULT_MODEL,
+  DEFAULT_PROVIDER,
+} from "./constants";
 import { getArgs } from "./utils/getArgs";
 
 dotenv.config();
 
 export const args = getArgs();
 
+/**
+ * String configurations
+ */
 export const PROVIDER = DEFAULT_PROVIDER;
 export const MODEL = args.model ?? process.env.MODEL ?? DEFAULT_MODEL;
 export const RESPONSE_LANGUAGE =
   args.language ?? process.env.LANGUAGE ?? DEFAULT_LANGUAGE;
+export const API_HOST =
+  args.api_host ?? process.env.API_HOST ?? DEFAULT_API_HOST;
+
+/**
+ * Boolean configurations
+ */
 export const SIGNATURE = args.signature ?? process.env.SIGNATURE;

src/constants/index.ts

@@ -4,3 +4,4 @@ export const DEFAULT_PROVIDER = "ollama";
 export const DEFAULT_MODEL = "mistral";
 export const DEFAULT_LANGUAGE = "English";
 export const DEFAULT_MAX_DIFF_LENGTH = 8000;
+export const DEFAULT_API_HOST = "http://localhost:11434";

src/constants/prompt.ts

@@ -1,16 +1,33 @@
 import { RESPONSE_LANGUAGE } from "../config";
 
 export const defaultSystemMessage = `
-You are the creator of the commit message.
-The only key values in JSON are type, scope, title, and body.
-The output should provide only one JSON response and should not provide unnecessary output.
+Generate a concise JSON response written in present tense for code differences using the specifications given below:
+JSON must have the following keys: type, scope, title, and body.
+Select the type that best describes git diff from the type-description JSON below:
+{
+   "docs": "Documentation only changes",
+   "style": "Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)",
+   "refactor": "A code change that neither fixes a bug nor adds a feature",
+   "perf": "A code change that improves performance",
+   "test": "Adding missing tests or correcting existing tests",
+   "build": "Changes that affect the build system or external dependencies",
+   "ci": "Changes to our CI configuration files and scripts",
+   "chore": "Other changes that don't modify src or test files",
+   "revert": "Reverts a previous commit",
+   "feat": "A new feature",
+   "fix": "A bug fix"
+}
+scope represents the scope of changes in a commit. scope is optional and is used to specify the scope affected by the commit, such as changed files, modules, components, etc.
+title creates a concise summary title for the commit. The first letter is capitalized and no periods are used.
+The body is the part that describes the details of the commit. You can describe in more detail the commit's changes, reasons, scope of impact, etc.
+
 You should respond in ${RESPONSE_LANGUAGE}.
 
 An example output is:
 {
   "type": "fix",
   "scope": "api",
-  "subject": "prevent racing of requests",
+  "title": "prevent racing of requests",
   "body": [
     "Introduce a request id and a reference to latest request. Dismiss incoming responses other than from latest request.",
     "Remove timeouts which were used to mitigate the racing issue but are obsolete now."

src/index.ts

@@ -30,4 +30,7 @@ const main = async () => {
   createCommit(message);
 };
 
-main().catch((error) => console.error(error));
+main().catch((error) => {
+  console.error(error);
+  process.exit(1);
+});

src/utils/convertMessage.ts

@@ -2,11 +2,11 @@ export const convertMessageToCommitFormat = (message: string): string => {
   const obj = JSON.parse(message);
 
   let commitMessage = `${obj.type}${obj.scope ? `(${obj.scope})` : ""}: ${
-    obj.subject
+    obj.title
   }`;
 
-  if (obj.description && obj.description.length > 0) {
-    commitMessage += "\n\n" + obj.description.join("\n");
+  if (obj.body && obj.body.length > 0) {
+    commitMessage += "\n\n" + obj.body.join("\n");
   }
 
   return commitMessage;

src/utils/generateCommitMessage.ts

@@ -1,9 +1,12 @@
-import { MODEL } from "../config";
+import { API_HOST, MODEL } from "../config";
 import { defaultSystemMessage } from "../constants/prompt";
+import { removeEscapeCharacters } from "./removeEscapeCharacters";
 
 export const generateCommitMessage = async (diff: string) => {
   const { Ollama } = await import("ollama");
-  const ollama = new Ollama();
+  const ollama = new Ollama({
+    address: API_HOST,
+  });
 
   let content = "";
   for await (const token of ollama.generate(MODEL, diff, {
@@ -14,8 +17,9 @@ export const generateCommitMessage = async (diff: string) => {
       top_p: 0.9,
     },
   })) {
-    // process.stdout.write(token);
+    process.stdout.write(token);
     content += token;
   }
-  return content;
+
+  return removeEscapeCharacters(content);
 };

src/utils/pullModel.ts

@@ -1,9 +1,11 @@
 import { SingleBar } from "cli-progress";
-import { MODEL, PROVIDER } from "../config";
+import { API_HOST, MODEL, PROVIDER } from "../config";
 
 export const pullModel = async () => {
   const { Ollama } = await import("ollama");
-  const ollama = new Ollama();
+  const ollama = new Ollama({
+    address: API_HOST,
+  });
 
   const it = await ollama.pull(MODEL);
   let pullingResult = await it.next();

src/utils/removeEscapeCharacters.ts

@@ -0,0 +1,3 @@
+export const removeEscapeCharacters = (str: string) => {
+  return str.replaceAll(/\\(.)/g, "$1");
+};

tsconfig.json

@@ -1,6 +1,6 @@
 {
 	"compilerOptions": {
-		"target": "es2020",
+		"target": "es2021",
 		"module": "esnext",
 		"strict": true,
 		"esModuleInterop": true,