v 3.1.0 (#397)

2026-04-20 03:02:51 -04:00 · 2024-09-01 18:21:56 +03:00
parent 1b29f3a9fd
commit 2dded4caa4
33 changed files with 42797 additions and 42728 deletions
--- a/src/modules/commitlint/config.ts
+++ b/src/modules/commitlint/config.ts
@@ -2,16 +2,16 @@ import { spinner } from '@clack/prompts';

 import { getConfig } from '../../commands/config';
 import { i18n, I18nLocals } from '../../i18n';
+import { getEngine } from '../../utils/engine';
 import { COMMITLINT_LLM_CONFIG_PATH } from './constants';
 import { computeHash } from './crypto';
 import { commitlintPrompts, inferPromptsFromCommitlintConfig } from './prompts';
 import { getCommitLintPWDConfig } from './pwd-commitlint';
 import { CommitlintLLMConfig } from './types';
 import * as utils from './utils';
-import { getEngine } from '../../utils/engine';

 const config = getConfig();
-const translation = i18n[(config?.OCO_LANGUAGE as I18nLocals) || 'en'];
+const translation = i18n[(config.OCO_LANGUAGE as I18nLocals) || 'en'];

 export const configureCommitlintIntegration = async (force = false) => {
  const spin = spinner();
@@ -26,7 +26,7 @@ export const configureCommitlintIntegration = async (force = false) => {
      * @commitlint >= 9.0.0 is installed in the local directory.
      * 'node_modules/@commitlint/load' package exists.
      * A valid @commitlint configuration exists.
-      `,
+      `
    );
  }

--- a/src/modules/commitlint/prompts.ts
+++ b/src/modules/commitlint/prompts.ts
@@ -1,8 +1,5 @@
 import chalk from 'chalk';
-import {
-  ChatCompletionRequestMessage,
-  ChatCompletionRequestMessageRoleEnum
-} from 'openai';
+import { OpenAI } from 'openai';

 import { outro } from '@clack/prompts';
 import {
@@ -17,7 +14,7 @@ import { i18n, I18nLocals } from '../../i18n';
 import { IDENTITY, INIT_DIFF_PROMPT } from '../../prompts';

 const config = getConfig();
-const translation = i18n[(config?.OCO_LANGUAGE as I18nLocals) || 'en'];
+const translation = i18n[(config.OCO_LANGUAGE as I18nLocals) || 'en'];

 type DeepPartial<T> = {
  [P in keyof T]?: {
@@ -214,11 +211,10 @@ const STRUCTURE_OF_COMMIT = `
 // Prompt to generate LLM-readable rules based on @commitlint rules.
 const GEN_COMMITLINT_CONSISTENCY_PROMPT = (
  prompts: string[]
-): ChatCompletionRequestMessage[] => [
+): OpenAI.Chat.Completions.ChatCompletionMessageParam[] => [
  {
-    role: ChatCompletionRequestMessageRoleEnum.Assistant,
-    // prettier-ignore
-    content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages for two different changes in a single codebase and output them in the provided JSON format: one for a bug fix and another for a new feature. 
+    role: 'system',
+    content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages for two different changes in a single codebase and output them in the provided JSON format: one for a bug fix and another for a new feature.

 Here are the specific requirements and conventions that should be strictly followed:

@@ -260,22 +256,33 @@ Example Git Diff is to follow:`
 const INIT_MAIN_PROMPT = (
  language: string,
  prompts: string[]
-): ChatCompletionRequestMessage => ({
-  role: ChatCompletionRequestMessageRoleEnum.System,
-  // prettier-ignore
-  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages in the given @commitlint 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."}
+): OpenAI.Chat.Completions.ChatCompletionMessageParam => ({
+  role: 'system',
+  content: `${IDENTITY} Your mission is to create clean and comprehensive commit messages in the given @commitlint convention and explain WHAT were the changes ${
+    config.OCO_WHY ? '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. Use ${language} to answer.
-${ config?.OCO_ONE_LINE_COMMIT ? 'Craft a concise commit message that encapsulates all changes made, with an emphasis on the primary updates. If the modifications share a common theme or scope, mention it succinctly; otherwise, leave the scope out to maintain focus. The goal is to provide a clear and unified overview of the changes in a one single message, without diverging into a list of commit per file change.' : ""}
+${
+  config.OCO_ONE_LINE_COMMIT
+    ? 'Craft a concise commit message that encapsulates all changes made, with an emphasis on the primary updates. If the modifications share a common theme or scope, mention it succinctly; otherwise, leave the scope out to maintain focus. The goal is to provide a clear and unified overview of the changes in a one single message, without diverging into a list of commit per file change.'
+    : ''
+}
    
 You will strictly follow the following conventions to generate the content of the commit message:
 - ${prompts.join('\n- ')}

 The conventions refers to the following structure of commit message:
-${STRUCTURE_OF_COMMIT}
-    
-    `
+${STRUCTURE_OF_COMMIT}`
 });

 export const commitlintPrompts = {
--- a/src/modules/commitlint/pwd-commitlint.ts
+++ b/src/modules/commitlint/pwd-commitlint.ts
@@ -1,13 +1,29 @@
 import fs from 'fs/promises';
 import path from 'path';

+const findModulePath = (moduleName: string) => {
+  const searchPaths = [
+    path.join('node_modules', moduleName),
+    path.join('node_modules', '.pnpm')
+  ];
+
+  for (const basePath of searchPaths) {
+    try {
+      const resolvedPath = require.resolve(moduleName, { paths: [basePath] });
+      return resolvedPath;
+    } catch {
+      // Continue to the next search path if the module is not found
+    }
+  }
+
+  throw new Error(`Cannot find module ${moduleName}`);
+};
+
 const getCommitLintModuleType = async (): Promise<'cjs' | 'esm'> => {
-  const packageFile = 'node_modules/@commitlint/load/package.json';
-  const packageJsonPath = path.join(
-    process.env.PWD || process.cwd(),
-    packageFile,
-  );
+  const packageFile = '@commitlint/load/package.json';
+  const packageJsonPath = findModulePath(packageFile);
  const packageJson = JSON.parse(await fs.readFile(packageJsonPath, 'utf8'));
+
  if (!packageJson) {
    throw new Error(`Failed to parse ${packageFile}`);
  }
@@ -19,7 +35,7 @@ const getCommitLintModuleType = async (): Promise<'cjs' | 'esm'> => {
 * QualifiedConfig from any version of @commitlint/types
 * @see https://github.com/conventional-changelog/commitlint/blob/master/@commitlint/types/src/load.ts
 */
-type QualifiedConfigOnAnyVersion = { [key:string]: unknown };
+type QualifiedConfigOnAnyVersion = { [key: string]: unknown };

 /**
 *  This code is loading the configuration for the `@commitlint` package from the current working
@@ -27,36 +43,31 @@ type QualifiedConfigOnAnyVersion = { [key:string]: unknown };
 *
 * @returns
 */
-export const getCommitLintPWDConfig = async (): Promise<QualifiedConfigOnAnyVersion | null> => {
-  let load, nodeModulesPath;
-  switch (await getCommitLintModuleType()) {
-    case 'cjs':
-      /**
-       * CommonJS (<= commitlint@v18.x.x.)
-       */
-      nodeModulesPath = path.join(
-        process.env.PWD || process.cwd(),
-        'node_modules/@commitlint/load',
-      );
-      load = require(nodeModulesPath).default;
-      break;
-    case 'esm':
-      /**
-       * ES Module (commitlint@v19.x.x. <= )
-       * Directory import is not supported in ES Module resolution, so import the file directly
-       */
-      nodeModulesPath = path.join(
-        process.env.PWD || process.cwd(),
-        'node_modules/@commitlint/load/lib/load.js',
-      );
-      load = (await import(nodeModulesPath)).default;
-      break;
-  }
+export const getCommitLintPWDConfig =
+  async (): Promise<QualifiedConfigOnAnyVersion | null> => {
+    let load: Function, modulePath: string;
+    switch (await getCommitLintModuleType()) {
+      case 'cjs':
+        /**
+         * CommonJS (<= commitlint@v18.x.x.)
+         */
+        modulePath = findModulePath('@commitlint/load');
+        load = require(modulePath).default;
+        break;
+      case 'esm':
+        /**
+         * ES Module (commitlint@v19.x.x. <= )
+         * Directory import is not supported in ES Module resolution, so import the file directly
+         */
+        modulePath = await findModulePath('@commitlint/load/lib/load.js');
+        load = (await import(modulePath)).default;
+        break;
+    }

-  if (load && typeof load === 'function') {
-    return await load();
-  }
+    if (load && typeof load === 'function') {
+      return await load();
+    }

-  // @commitlint/load is not a function
-  return null;
-};
+    // @commitlint/load is not a function
+    return null;
+  };