feat: Integrate @commitlint for Enhanced Commit Message Generation and Configuration Support (#209)

* add commitlint support
* refactor code
* improve readme text

src/commands/README.md

@@ -0,0 +1,9 @@
+# @commitlint Module for opencommit
+
+1. Load commitlint configuration within tree.
+2. Generate a commit with commitlint prompt:
+   - Will not run if hash is the same.
+   - Infer a prompt for each commitlint rule.
+   - Ask OpenAI to generate consistency with embedded commitlint rules.
+   - Store configuration close to commitlint configuration.
+3. Replace conventional-commit prompt with commitlint prompt.

src/commands/commit.ts

@@ -1,4 +1,16 @@
+import chalk from 'chalk';
 import { execa } from 'execa';
+
+import {
+  confirm,
+  intro,
+  isCancel,
+  multiselect,
+  outro,
+  select,
+  spinner
+} from '@clack/prompts';
+
 import { generateCommitMessageByDiff } from '../generateCommitMessageFromGitDiff';
 import {
   assertGitRepo,
@@ -7,18 +19,8 @@ import {
   getStagedFiles,
   gitAdd
 } from '../utils/git';
-import {
-  spinner,
-  confirm,
-  outro,
-  isCancel,
-  intro,
-  multiselect,
-  select
-} from '@clack/prompts';
-import { getConfig } from '../commands/config';
-import chalk from 'chalk';
 import { trytm } from '../utils/trytm';
+import { getConfig } from './config';
 
 const config = getConfig();
 

src/commands/commitlint.ts

@@ -0,0 +1,46 @@
+import chalk from 'chalk';
+import { command } from 'cleye';
+
+import { intro, outro } from '@clack/prompts';
+
+import { COMMANDS } from '../CommandsEnum';
+import { configureCommitlintIntegration } from '../modules/commitlint/config';
+import { getCommitlintLLMConfig } from '../modules/commitlint/utils';
+
+export enum CONFIG_MODES {
+  get = 'get',
+  force = 'force'
+}
+
+export const commitlintConfigCommand = command(
+  {
+    name: COMMANDS.commitlint,
+    parameters: ['<mode>']
+  },
+  async (argv) => {
+    intro('opencommit — configure @commitlint');
+    try {
+      const { mode } = argv._;
+
+      if (mode === CONFIG_MODES.get) {
+        const commitLintConfig = await getCommitlintLLMConfig();
+
+        outro(commitLintConfig.toString());
+
+        return;
+      }
+
+      if (mode === CONFIG_MODES.force) {
+        await configureCommitlintIntegration(true);
+        return;
+      }
+
+      throw new Error(
+        `Unsupported mode: ${mode}. Valid modes are: "force" and "get"`
+      );
+    } catch (error) {
+      outro(`${chalk.red('✖')} ${error}`);
+      process.exit(1);
+    }
+  }
+);

src/commands/config.ts

@@ -1,15 +1,16 @@
-import { intro, outro } from '@clack/prompts';
 import chalk from 'chalk';
 import { command } from 'cleye';
+import * as dotenv from 'dotenv';
 import { existsSync, readFileSync, writeFileSync } from 'fs';
 import { parse as iniParse, stringify as iniStringify } from 'ini';
 import { homedir } from 'os';
 import { join as pathJoin } from 'path';
+
+import { intro, outro } from '@clack/prompts';
+
 import { COMMANDS } from '../CommandsEnum';
 import { getI18nLocal } from '../i18n';
 
-import * as dotenv from 'dotenv';
-
 dotenv.config();
 
 export enum CONFIG_KEYS {
@@ -20,7 +21,8 @@ export enum CONFIG_KEYS {
   OCO_EMOJI = 'OCO_EMOJI',
   OCO_MODEL = 'OCO_MODEL',
   OCO_LANGUAGE = 'OCO_LANGUAGE',
-  OCO_MESSAGE_TEMPLATE_PLACEHOLDER = 'OCO_MESSAGE_TEMPLATE_PLACEHOLDER'
+  OCO_MESSAGE_TEMPLATE_PLACEHOLDER = 'OCO_MESSAGE_TEMPLATE_PLACEHOLDER',
+  OCO_PROMPT_MODULE = 'OCO_PROMPT_MODULE'
 }
 
 export const DEFAULT_MODEL_TOKEN_LIMIT = 4096;
@@ -137,6 +139,16 @@ export const configValidators = {
       value.startsWith('$'),
       `${value} must start with $, for example: '$msg'`
     );
+    return value;
+  },
+
+  [CONFIG_KEYS.OCO_PROMPT_MODULE](value: any) {
+    validateConfig(
+      CONFIG_KEYS.OCO_PROMPT_MODULE,
+      ['conventional-commit', '@commitlint'].includes(value),
+      `${value} is not supported yet, use '@commitlint' or 'conventional-commit' (default)`
+    );
+
     return value;
   }
 };
@@ -159,7 +171,8 @@ export const getConfig = (): ConfigType | null => {
     OCO_MODEL: process.env.OCO_MODEL || 'gpt-3.5-turbo-16k',
     OCO_LANGUAGE: process.env.OCO_LANGUAGE || 'en',
     OCO_MESSAGE_TEMPLATE_PLACEHOLDER:
-      process.env.OCO_MESSAGE_TEMPLATE_PLACEHOLDER || '$msg'
+      process.env.OCO_MESSAGE_TEMPLATE_PLACEHOLDER || '$msg',
+    OCO_PROMPT_MODULE: process.env.OCO_PROMPT_MODULE || 'conventional-commit'
   };
 
   const configExists = existsSync(configPath);

src/commands/githook.ts

@@ -1,11 +1,13 @@
+import chalk from 'chalk';
+import { command } from 'cleye';
+import { existsSync } from 'fs';
 import fs from 'fs/promises';
 import path from 'path';
-import { command } from 'cleye';
-import { assertGitRepo, getCoreHooksPath } from '../utils/git.js';
-import { existsSync } from 'fs';
-import chalk from 'chalk';
+
 import { intro, outro } from '@clack/prompts';
+
 import { COMMANDS } from '../CommandsEnum.js';
+import { assertGitRepo, getCoreHooksPath } from '../utils/git.js';
 
 const HOOK_NAME = 'prepare-commit-msg';
 const DEFAULT_SYMLINK_URL = path.join('.git', 'hooks', HOOK_NAME);

src/commands/prepare-commit-msg-hook.ts

@@ -1,9 +1,11 @@
-import fs from 'fs/promises';
 import chalk from 'chalk';
+import fs from 'fs/promises';
+
 import { intro, outro, spinner } from '@clack/prompts';
+
+import { generateCommitMessageByDiff } from '../generateCommitMessageFromGitDiff';
 import { getChangedFiles, getDiff, getStagedFiles, gitAdd } from '../utils/git';
 import { getConfig } from './config';
-import { generateCommitMessageByDiff } from '../generateCommitMessageFromGitDiff';
 
 const [messageFilePath, commitSource] = process.argv.slice(2);