format-commit 0.3.1 → 1.0.0

package/lib/setup.js

@@ -1,117 +1,267 @@
-'use strict';
-
-const prompts = require('prompts');
-const fs = require('fs');
-const utils = require('./utils');
-const defaultConfig = require('./default-config.json');
-const options = require('./options.json');
-
-
-module.exports = async (askForCommitAfter) => {
-    utils.log('create config file');
-
-    /**
-     * Get current git branch to pre-fill release branch option
-    */
-    const currentBranch = utils.getCurrentBranch();
-
-    let cancelled = false;
-    const configChoices = await prompts([
-        {
-            type: 'select',
-            name: 'format',
-            message: 'Commit format',
-            choices: options.commitFormats,
-        },
-        {
-            type: 'number',
-            name: 'minLength',
-            message: 'Commit minimum length?',
-            validate: val => utils.validCommitTitleSetupLength(val),
-            initial: defaultConfig.minLength,
-        },
-        {
-            type: 'number',
-            name: 'maxLength',
-            message: 'Commit maximum length?',
-            validate: val => utils.validCommitTitleSetupLength(val),
-            initial: defaultConfig.maxLength,
-        },
-        {
-            type: 'confirm',
-            name: 'stageAllChanges',
-            message: 'Stage all changes before each commit?',
-            initial: defaultConfig.stageAllChanges,
-        },
-        {
-            type: 'select',
-            name: 'changeVersion',
-            message: 'Change package version',
-            choices: options.versionChangeMode,
-        },
-        {
-            type: prev => prev === 'releaseBranch' ? 'text' : null,
-            name: 'releaseBranch',
-            message: 'Release git branch ?',
-            initial: currentBranch,
-        },
-        {
-            type: 'confirm',
-            name: 'showAllVersionTypes',
-            message: 'Display all npm version types?',
-            initial: defaultConfig.showAllVersionTypes,
-        },
-        {
-            type: askForCommitAfter ? 'confirm' : null,
-            name: 'commitAfter',
-            message: 'Commit your changes now? (or exit the configuration without committing)',
-            initial: false,
-        },
-    ], {
-        onCancel: () => {
-            cancelled = true;
-            return false;
-        },
-    });
-
-    /**
-     * Handle prompt cancellation and stop setup execution
-     */
-    if (cancelled) {
-        utils.log('setup cancelled', 'error');
-        return;
-    }
+import prompts from 'prompts';
+import fs, { readFileSync } from 'fs';
+import * as utils from './utils.js';
+import * as envUtils from './env-utils.js';
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
 
-    /**
-     * Parse prompt data and write config file
-     */
-    const config = {
-        format: configChoices.format,
-        types: defaultConfig.types,
-        scopes: configChoices.format >= 5
-            ? defaultConfig.scopes
-            : undefined,
-        minLength: configChoices.minLength,
-        maxLength: configChoices.maxLength,
-        changeVersion: configChoices.changeVersion,
-        releaseBranch: configChoices.releaseBranch,
-        showAllVersionTypes: configChoices.showAllVersionTypes,
-        stageAllChanges: configChoices.stageAllChanges,
-    };
-    const parsedConfig = JSON.stringify(config, null, 2);
 
-    utils.log(`save ${options.configFile}.json file...`);
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const defaultConfig = JSON.parse(
+  readFileSync(join(__dirname, 'default-config.json'), 'utf-8')
+);
+const options = JSON.parse(
+  readFileSync(join(__dirname, 'options.json'), 'utf-8')
+);
+
+
+export default async function setup(askForCommitAfter) {
+  utils.log('create config file');
+
+  // Get current git branch to pre-fill release branch option
+  const currentBranch = utils.getCurrentBranch();
+
+  let cancelled = false;
+  const configChoices = await prompts([
+    {
+      type: 'select',
+      name: 'format',
+      message: 'Commit messages nomenclature',
+      choices: options.commitFormats,
+    },
+    {
+      type: 'select',
+      name: 'branchFormat',
+      message: 'Branch names nomenclature',
+      choices: options.branchFormats,
+    },
+    {
+      type: 'number',
+      name: 'minLength',
+      message: 'Commit messages minimum length?',
+      validate: val => utils.validCommitTitleSetupLength(val),
+      initial: defaultConfig.minLength,
+    },
+    {
+      type: 'number',
+      name: 'maxLength',
+      message: 'Commit messages maximum length?',
+      validate: val => utils.validCommitTitleSetupLength(val),
+      initial: defaultConfig.maxLength,
+    },
+    {
+      type: 'select',
+      name: 'changeVersion',
+      message: 'Change package version when committing',
+      choices: options.versionChangeMode,
+    },
+    {
+      type: prev => prev === 'releaseBranch' ? 'text' : null,
+      name: 'releaseBranch',
+      message: 'Release git branch?',
+      initial: currentBranch,
+    },
+    {
+      type: 'confirm',
+      name: 'showAllVersionTypes',
+      message: 'Display all npm version types?',
+      initial: defaultConfig.showAllVersionTypes,
+    },
+    {
+      type: 'confirm',
+      name: 'enableAI',
+      message: 'Enable AI commit title suggestions? (API key required)',
+      initial: false,
+    },
+    {
+      type: prev => prev ? 'select' : null,
+      name: 'aiProvider',
+      message: 'AI provider',
+      choices: options.aiProviders,
+    },
+    {
+      type: prev => prev ? 'select' : null,
+      name: 'aiModel',
+      message: 'AI model',
+      choices: (prev, values) => {
+        const provider = options.aiProviders.find(p => p.value === values.aiProvider);
+        return provider ? provider.models : [];
+      },
+    },
+    {
+      type: (prev, values) => values.enableAI ? 'text' : null,
+      name: 'envPath',
+      message: 'Path to .env file for API key (will be created if doesn\'t exist)',
+      initial: '.env',
+      validate: (val) => {
+        if (!val || val.trim().length === 0) {
+          return 'Please provide a .env file path';
+        }
+
+        const envPath = val.trim();
+        const envExists = fs.existsSync(envPath);
+
+        // If .env exists, check that it is in .gitignore
+        if (envExists && !envUtils.isInGitignore(envPath)) {
+          return `${envPath} must be in .gitignore for security. Please add it first.`;
+        }
+
+        return true;
+      },
+    },
+    {
+      type: (prev, values) => {
+        if (!values.enableAI) { return null; }
+        return fs.existsSync(values.envPath) ? 'text' : null;
+      },
+      name: 'envKeyName',
+      message: 'Name of the API key variable in .env (leave empty to create new)',
+      initial: (prev, values) => `${values.aiProvider.toUpperCase()}_API_KEY`,
+      validate: (val) => {
+        if (!val || val.trim().length === 0) {
+          return 'Please provide a variable name';
+        }
+        return true;
+      },
+    },
+    {
+      type: (prev, values) => {
+        if (!values.enableAI) { return null; }
+
+        const keyName = values.envKeyName || `${values.aiProvider.toUpperCase()}_API_KEY`;
+        const keyExists = envUtils.keyExistsInEnv(values.envPath, keyName);
+
+        if (keyExists) {
+          return 'confirm';
+        }
+
+        return null;
+      },
+      name: 'updateApiKey',
+      message: (prev, values) => {
+        const keyName = values.envKeyName || `${values.aiProvider.toUpperCase()}_API_KEY`;
+        const keyExists = envUtils.keyExistsInEnv(values.envPath, keyName);
 
-    try {
-        fs.writeFileSync(`./${options.configFile}.json`, parsedConfig);
-        utils.log('config file successfully created', 'success');
-    } catch (err) {
-        utils.log(`unable to save config file: ${err}`, 'error');
+        if (keyExists) {
+          return `${keyName} already exists in ${values.envPath}. Update it?`;
+        }
+        const providerNames = { anthropic: 'Anthropic', openai: 'OpenAI', google: 'Google' };
+        return `Enter your ${providerNames[values.aiProvider] || values.aiProvider} API key`;
+      },
+      initial: false,
+    },
+    {
+      type: (prev, values) => {
+        if (!values.enableAI) { return null; }
+
+        const keyName = values.envKeyName || `${values.aiProvider.toUpperCase()}_API_KEY`;
+        const keyExists = envUtils.keyExistsInEnv(values.envPath, keyName);
+
+        if (!keyExists || prev === true) {
+          return 'password';
+        }
+
+        return null;
+      },
+      name: 'apiKey',
+      message: (prev, values) => {
+        const providerNames = { anthropic: 'Anthropic', openai: 'OpenAI', google: 'Google' };
+        return `Enter your ${providerNames[values.aiProvider] || values.aiProvider} API key`;
+      },
+      validate: (val) => {
+        if (!val || val.trim().length < 20) {
+          return 'Please provide a valid API key';
+        }
+        return true;
+      },
+    },
+    {
+      type: askForCommitAfter ? 'confirm' : null,
+      name: 'commitAfter',
+      message: 'Commit your changes now? (or exit the configuration without committing)',
+      initial: false,
+    },
+  ], {
+    onCancel: () => {
+      cancelled = true;
+      return false;
+    },
+  });
+
+  if (cancelled) {
+    utils.log('setup cancelled', 'error');
+    return;
+  }
+
+  // Parse prompt data and write config file
+  const config = {
+    format: configChoices.format,
+    branchFormat: configChoices.branchFormat,
+    types: defaultConfig.types,
+    scopes: (configChoices.format >= 5 || configChoices.branchFormat === 2)
+      ? defaultConfig.scopes
+      : undefined,
+    minLength: configChoices.minLength,
+    maxLength: configChoices.maxLength,
+    changeVersion: configChoices.changeVersion,
+    releaseBranch: configChoices.releaseBranch,
+    showAllVersionTypes: configChoices.showAllVersionTypes,
+  };
+
+  // Handle AI configuration
+  if (configChoices.enableAI) {
+    const envPath = configChoices.envPath;
+    const keyName = configChoices.envKeyName || `${configChoices.aiProvider.toUpperCase()}_API_KEY`;
+
+    if (configChoices.apiKey) {
+      const saved = envUtils.setEnvKey(envPath, keyName, configChoices.apiKey);
+      if (!saved) {
+        utils.log(`Failed to save API key to ${envPath}`, 'error');
         return;
+      }
+      utils.log(`API key saved to ${envPath}`, 'success');
     }
 
-    return {
-        config,
-        commitAfter: configChoices.commitAfter
+    if (!envUtils.isInGitignore(envPath)) {
+      const added = envUtils.addToGitignore(envPath);
+      if (added) {
+        utils.log(`${envPath} added to .gitignore`, 'success');
+      } else {
+        utils.log(`Failed to add ${envPath} to .gitignore`, 'warning');
+      }
+    }
+
+    config.ai = {
+      enabled: true,
+      provider: configChoices.aiProvider,
+      model: configChoices.aiModel,
+      envPath: envPath,
+      envKeyName: keyName,
+      largeDiffTokenThreshold: defaultConfig.ai.largeDiffTokenThreshold,
     };
-};
+  } else {
+    config.ai = {
+      enabled: false,
+      largeDiffTokenThreshold: defaultConfig.ai.largeDiffTokenThreshold,
+    };
+  }
+
+  const parsedConfig = JSON.stringify(config, null, 2);
+
+  utils.log(`save ${options.configFile}.json file...`);
+
+  try {
+    fs.writeFileSync(`./${options.configFile}.json`, parsedConfig);
+    utils.log('config file successfully created', 'success');
+  } catch (err) {
+    utils.log(`unable to save config file: ${err}`, 'error');
+    return;
+  }
+
+  return {
+    config,
+    commitAfter: configChoices.commitAfter
+  };
+}

package/lib/utils.js

@@ -1,105 +1,176 @@
-'use strict';
+import { execSync } from 'child_process';
+import kleur from 'kleur';
 
-const { execSync } = require('child_process');
-const { gray, bold, red, green, yellow } = require('kleur');
 
+const { gray, bold, red, green, yellow } = kleur;
 
 const askForVersion = (config, branch) => {
-    if (
-        config.changeVersion === 'always'
-        || (config.changeVersion === 'releaseBranch' && branch === config.releaseBranch)
-    ) {
-        return true;
-    }
-    return false;
+  if (
+    config.changeVersion === 'always'
+    || (config.changeVersion === 'releaseBranch' && branch === config.releaseBranch)
+  ) {
+    return true;
+  }
+  return false;
 };
 
 const getCurrentBranch = () => {
-    return execSync('git rev-parse --abbrev-ref HEAD').toString().trim();
+  return execSync('git rev-parse --abbrev-ref HEAD').toString().trim();
+};
+
+const hasStagedChanges = () => {
+  try {
+    const staged = execSync('git diff --cached --name-only', { encoding: 'utf-8' });
+    return staged.trim().length > 0;
+  } catch {
+    return false;
+  }
 };
 
 const validCommitTitle = (title, lenMin, lenMax) => {
-    if (title.length < lenMin) {
-        return 'Commit title too short';
-    } else if (title.length > lenMax) {
-        return 'Commit title too long';
-    }
-    return true;
+  if (title.length < lenMin) {
+    return `Commit title too short (current ${title.length} - minimum ${lenMin})`;
+  } else if (title.length > lenMax) {
+    return `Commit title too long (current ${title.length} - maximum ${lenMax})`;
+  }
+  return true;
 };
 
 const validCommitTitleSetupLength = (len) => {
-    if (len < 1) {
-        return `${len} isn't a valid length`;
-    } else if (len > 255) {
-        return 'length cannot be higher than 255';
-    }
-    return true;
+  if (len < 1) {
+    return `${len} isn't a valid length`;
+  } else if (len > 255) {
+    return 'length cannot be higher than 255';
+  }
+  return true;
 };
 
 const validVersion = (version) => {
-    const regex = /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
-    if (!regex.test(version)) {
-        return 'Version does not respect semantic versioning';
-    }
-    return true;
+  const regex = /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
+  if (!regex.test(version)) {
+    return 'Version does not respect semantic versioning';
+  }
+  return true;
 };
 
 const formatCommitTitle = (type, title, format, scope = '*') => {
-    switch (format) {
-        case 1:
-        default:
-            return `(${type}) ${title[0].toUpperCase()}${title.substr(1).toLowerCase()}`;
-        case 2:
-            return `(${type}) ${title.toLowerCase()}`;
-        case 3:
-            return `${type}: ${title[0].toUpperCase()}${title.substr(1).toLowerCase()}`;
-        case 4:
-            return `${type}: ${title.toLowerCase()}`;
-        case 5:
-            return `${type}(${scope}) ${title[0].toUpperCase()}${title.substr(1).toLowerCase()}`;
-        case 6:
-            return `${type}(${scope}) ${title.toLowerCase()}`;
-        case 7:
-            return `${type}(${scope}): ${title[0].toUpperCase()}${title.substr(1).toLowerCase()}`;
-        case 8:
-            return `${type}(${scope}): ${title.toLowerCase()}`;
-    }
+  // Handle empty title
+  if (!title || title.trim().length === 0) {
+    return '';
+  }
+
+  const trimmedTitle = title.trim();
+
+  switch (format) {
+    case 1:
+    default:
+      return `(${type}) ${trimmedTitle[0].toUpperCase()}${trimmedTitle.slice(1).toLowerCase()}`;
+    case 2:
+      return `(${type}) ${trimmedTitle.toLowerCase()}`;
+    case 3:
+      return `${type}: ${trimmedTitle[0].toUpperCase()}${trimmedTitle.slice(1).toLowerCase()}`;
+    case 4:
+      return `${type}: ${trimmedTitle.toLowerCase()}`;
+    case 5:
+      return `${type}(${scope}) ${trimmedTitle[0].toUpperCase()}${trimmedTitle.slice(1).toLowerCase()}`;
+    case 6:
+      return `${type}(${scope}) ${trimmedTitle.toLowerCase()}`;
+    case 7:
+      return `${type}(${scope}): ${trimmedTitle[0].toUpperCase()}${trimmedTitle.slice(1).toLowerCase()}`;
+    case 8:
+      return `${type}(${scope}): ${trimmedTitle.toLowerCase()}`;
+  }
 };
 
 const handleCmdExec = (command) => {
-    try {
-        const output = execSync(command);
-        return output.toString();
-    } catch (err) {
-        log(`Error\n${err.message ? err.message : err}`, 'error');
-    }
+  try {
+    const output = execSync(command);
+    return output.toString();
+  } catch (err) {
+    log(`Error\n${err.message ? err.message : err}`, 'error');
+  }
 };
 
 const log = (message, type) => {
-    const date = gray(`[${new Date().toISOString()}]`);
-    let msg = `${bold('format-commit')}: ${message}`;
-    switch (type) {
-        case 'error':
-            msg = red(msg);
-            break;
-        case 'success':
-            msg = green(msg);
-            break;
-        case 'warning':
-            msg = yellow(msg);
-            break;
+  const date = gray(`[${new Date().toISOString()}]`);
+  let msg = `${bold('format-commit')}: ${message}`;
+  switch (type) {
+    case 'error':
+      msg = red(msg);
+      break;
+    case 'success':
+      msg = green(msg);
+      break;
+    case 'warning':
+      msg = yellow(msg);
+      break;
+  }
+  console.log(`${date} ${type === 'error' ? red(msg) : (type === 'success' ? green(msg) : msg)}`);
+};
+
+const validBranchDescription = (description, maxLength) => {
+  if (description.length < 1) {
+    return 'Branch description cannot be empty';
+  }
+  if (description.length > maxLength) {
+    return `Branch description too long (max ${maxLength} characters)`;
+  }
+  const invalidChars = /[~^:?*[\\\s]/;
+  if (invalidChars.test(description)) {
+    return 'Branch description contains invalid characters (spaces, ~, ^, :, ?, *, [, \\)';
+  }
+  if (description.startsWith('.') || description.startsWith('-') ||
+    description.endsWith('.') || description.endsWith('-')) {
+    return 'Branch description cannot start or end with . or -';
+  }
+  return true;
+};
+
+const formatBranchName = (type, description, format, scope = null) => {
+  const cleanDescription = description
+    .toLowerCase()
+    .replace(/\s+/g, '-')
+    .replace(/[^a-z0-9-]/g, '')
+    .replace(/-+/g, '-')
+    .replace(/^-|-$/g, '');
+
+  switch (format) {
+    case 1:
+    default:
+      return `${type}/${cleanDescription}`;
+    case 2:
+      return scope ? `${type}/${scope}/${cleanDescription}` : `${type}/${cleanDescription}`;
+  }
+};
+
+const checkBranchExists = (branchName) => {
+  try {
+    const localBranches = execSync('git branch --list').toString();
+    if (localBranches.includes(branchName)) {
+      return true;
     }
-    console.log(`${date} ${type === 'error' ? red(msg) : (type === 'success' ? green(msg) : msg)}`);
+    const remoteBranches = execSync('git branch -r --list').toString();
+    if (remoteBranches.includes(`origin/${branchName}`)) {
+      return true;
+    }
+    return false;
+  } catch {
+    return false;
+  }
 };
 
 
-module.exports = {
-    askForVersion,
-    getCurrentBranch,
-    validCommitTitle,
-    validCommitTitleSetupLength,
-    validVersion,
-    formatCommitTitle,
-    handleCmdExec,
-    log,
+export {
+  askForVersion,
+  getCurrentBranch,
+  hasStagedChanges,
+  validCommitTitle,
+  validCommitTitleSetupLength,
+  validBranchDescription,
+  validVersion,
+  formatCommitTitle,
+  formatBranchName,
+  checkBranchExists,
+  handleCmdExec,
+  log,
 };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "format-commit",
-  "version": "0.3.1",
-  "description": "Lightweight CLI to standardize commit messages",
-  "license": "ISC",
+  "version": "1.0.0",
+  "description": "Lightweight CLI to standardize commit messages with AI-powered suggestions",
+  "license": "MIT",
   "author": "Thomas BARKATS",
   "keywords": [
     "git",
@@ -16,7 +16,12 @@
     "workflow",
     "tool",
     "javascript",
-    "nodejs"
+    "nodejs",
+    "ai",
+    "gpt",
+    "claude",
+    "openai",
+    "anthropic"
   ],
   "repository": {
     "type": "git",
@@ -27,13 +32,12 @@
     "url": "https://github.com/thomasbarkats/format-commit/issues"
   },
   "main": "./lib/index.js",
-  "type": "commonjs",
+  "type": "module",
   "engines": {
     "node": ">=16.0.0"
   },
   "scripts": {
     "start": "node lib/index.js",
-    "test": "echo \"Error: no test specified\" && exit 1",
     "lint": "eslint . --ext .js --fix",
     "prepublishOnly": "npm run lint",
     "preversion": "npm run lint",
@@ -46,12 +50,12 @@
     "format-commit": "./lib/index.js"
   },
   "dependencies": {
-    "commander": "^14.0.0",
-    "kleur": "^4.1.4",
+    "commander": "^14.0.3",
+    "kleur": "^4.1.5",
     "prompts": "^2.4.2"
   },
   "devDependencies": {
-    "@eslint/js": "^9.27.0",
-    "eslint": "^9.27.0"
+    "@eslint/js": "^9.31.0",
+    "eslint": "^9.31.0"
   }
 }