opencommit/src/modules/commitlint/config.ts

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';

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

export const configureCommitlintIntegration = async (force = false) => {
  const spin = spinner();
  spin.start('Loading @commitlint configuration');

  const fileExists = await utils.commitlintLLMConfigExists();

  const commitLintConfig = await getCommitLintPWDConfig();
  if (commitLintConfig === null) {
    throw new Error(
      `Failed to load @commitlint config. Please check the following:
      * @commitlint >= 9.0.0 is installed in the local directory.
      * 'node_modules/@commitlint/load' package exists.
      * A valid @commitlint configuration exists.
      `
    );
  }

  // debug complete @commitlint configuration
  // await fs.writeFile(
  //   `${OPENCOMMIT_COMMITLINT_CONFIG}-commitlint-debug`,
  //   JSON.stringify(commitLintConfig, null, 2)
  // );

  const hash = await computeHash(JSON.stringify(commitLintConfig));

  spin.stop(`Read @commitlint configuration (hash: ${hash})`);

  if (fileExists) {
    // Check if we need to update the prompts.
    const { hash: existingHash } = await utils.getCommitlintLLMConfig();
    if (hash === existingHash && !force) {
      spin.stop(
        'Hashes are the same, no need to update the config. Run "force" command to bypass.'
      );
      return;
    }
  }

  spin.start('Generating consistency with given @commitlint rules');

  const prompts = inferPromptsFromCommitlintConfig(commitLintConfig as any);

  const consistencyPrompts =
    commitlintPrompts.GEN_COMMITLINT_CONSISTENCY_PROMPT(prompts);

  // debug prompt which will generate a consistency
  // await fs.writeFile(
  //   `${COMMITLINT_LLM_CONFIG}-debug`,
  //   consistencyPrompts.map((p) => p.content)
  // );

  const engine = getEngine();
  let consistency =
    (await engine.generateCommitMessage(consistencyPrompts)) || '{}';

  // Cleanup the consistency answer. Sometimes 'gpt-3.5-turbo' sends rule's back.
  prompts.forEach((prompt) => (consistency = consistency.replace(prompt, '')));

  // sometimes consistency is preceded by explanatory text like "Here is your JSON:"
  consistency = utils.getJSONBlock(consistency);

  // ... remaining might be extra set of "\n"
  consistency = utils.removeDoubleNewlines(consistency);

  const commitlintLLMConfig: CommitlintLLMConfig = {
    hash,
    prompts,
    consistency: {
      [translation.localLanguage]: {
        ...JSON.parse(consistency as string)
      }
    }
  };

  await utils.writeCommitlintLLMConfig(commitlintLLMConfig);

  spin.stop(`Done - please review contents of ${COMMITLINT_LLM_CONFIG_PATH}`);
};