format-commit 0.3.1 → 1.0.0

package/lib/default-config.json

@@ -1,20 +1,25 @@
 {
-    "format": 1,
-    "minLength": 8,
-    "maxLength": 80,
-    "changeVersion": "never",
-    "releaseBranch": "main",
-    "showAllVersionTypes": false,
-    "stageAllChanges": false,
-    "types": [
-        { "value": "fix", "description": "Issue(s) fixing" },
-        { "value": "feat", "description": "New feature(s)" },
-        { "value": "core", "description": "Change(s) on the application core" },
-        { "value": "test" , "description": "Change(s) related to tests" },
-        { "value": "config" , "description": "Project configuration" },
-        { "value": "doc" , "description": "Documentation / comment(s)" }
-    ],
-    "scopes": [
-        { "value": "example", "description": "Your scope's description" }
-    ]
+  "format": 1,
+  "branchFormat": 1,
+  "minLength": 8,
+  "maxLength": 80,
+  "changeVersion": "ignore",
+  "releaseBranch": "main",
+  "showAllVersionTypes": false,
+  "types": [
+    { "value": "fix", "description": "Issue(s) fixing" },
+    { "value": "feat", "description": "New feature(s)" },
+    { "value": "core", "description": "Change(s) on the application core" },
+    { "value": "test" , "description": "Change(s) related to tests" },
+    { "value": "config" , "description": "Project configuration" },
+    { "value": "doc" , "description": "Documentation / comment(s)" }
+  ],
+  "scopes": [
+    { "value": "example", "description": "Your scope's description" }
+  ],
+  "ai": {
+    "enabled": false,
+    "envPath": ".env",
+    "largeDiffTokenThreshold": 20000
+  }
 }

package/lib/env-utils.js

@@ -0,0 +1,109 @@
+import fs from 'fs';
+import path from 'path';
+
+
+/** Check if a file path is in .gitignore */
+const isInGitignore = (filePath) => {
+  try {
+    const gitignorePath = path.join(process.cwd(), '.gitignore');
+    if (!fs.existsSync(gitignorePath)) {
+      return false;
+    }
+    const gitignoreContent = fs.readFileSync(gitignorePath, 'utf-8');
+    const lines = gitignoreContent.split('\n').map(l => l.trim());
+
+    const normalizedPath = filePath.startsWith('./') ? filePath.slice(2) : filePath;
+
+    return lines.some(line => {
+      if (!line || line.startsWith('#')) {return false;}
+      return line === normalizedPath || line === `/${normalizedPath}`;
+    });
+  } catch {
+    return false;
+  }
+};
+
+/** Add a file to .gitignore */
+const addToGitignore = (filePath) => {
+  try {
+    const gitignorePath = path.join(process.cwd(), '.gitignore');
+    const normalizedPath = filePath.startsWith('./') ? filePath.slice(2) : filePath;
+
+    let content = '';
+    if (fs.existsSync(gitignorePath)) {
+      content = fs.readFileSync(gitignorePath, 'utf-8');
+      if (!content.endsWith('\n')) {
+        content += '\n';
+      }
+    }
+
+    content += `${normalizedPath}\n`;
+    fs.writeFileSync(gitignorePath, content);
+    return true;
+  } catch {
+    return false;
+  }
+};
+
+/** Check if a key exists in .env file */
+const keyExistsInEnv = (envPath, keyName) => {
+  try {
+    if (!fs.existsSync(envPath)) {
+      return false;
+    }
+    const content = fs.readFileSync(envPath, 'utf-8');
+    const regex = new RegExp(`^${keyName}=`, 'm');
+    return regex.test(content);
+  } catch {
+    return false;
+  }
+};
+
+/** Add or update a key in .env file */
+const setEnvKey = (envPath, keyName, value) => {
+  try {
+    let content = '';
+
+    if (fs.existsSync(envPath)) {
+      content = fs.readFileSync(envPath, 'utf-8');
+      const regex = new RegExp(`^${keyName}=.*$`, 'm');
+
+      if (regex.test(content)) {
+        content = content.replace(regex, `${keyName}=${value}`);
+      } else {
+        if (!content.endsWith('\n')) {content += '\n';}
+        content += `${keyName}=${value}\n`;
+      }
+    } else {
+      content = `${keyName}=${value}\n`;
+    }
+
+    fs.writeFileSync(envPath, content);
+    return true;
+  } catch {
+    return false;
+  }
+};
+
+/** Read a key from .env file */
+const getEnvKey = (envPath, keyName) => {
+  try {
+    if (!fs.existsSync(envPath)) {
+      return null;
+    }
+    const content = fs.readFileSync(envPath, 'utf-8');
+    const regex = new RegExp(`^${keyName}=(.*)$`, 'm');
+    const match = content.match(regex);
+    return match ? match[1].trim() : null;
+  } catch {
+    return null;
+  }
+};
+
+export {
+  isInGitignore,
+  addToGitignore,
+  keyExistsInEnv,
+  setEnvKey,
+  getEnvKey,
+};

package/lib/index.js

@@ -1,50 +1,63 @@
 #!/usr/bin/env node
-'use strict';
 
-const { Command } = require('commander');
-const fs = require('fs');
-const utils = require('./utils');
-const setup = require('./setup');
-const commit = require('./commit');
-const options = require('./options.json');
+import { Command } from 'commander';
+import fs from 'fs';
+import * as utils from './utils.js';
+import setup from './setup.js';
+import commit from './commit.js';
+import { readFileSync } from 'fs';
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const options = JSON.parse(
+  readFileSync(join(__dirname, 'options.json'), 'utf-8')
+);
+
 
 const program = new Command();
 
 program
-    .name('format-commit')
-    .description('CLI to standardize commit nomenclature')
-    .version('0.3.1')
-    .option('-c, --config', 'generate a configuration file on your project for format-commit')
-    .option('-t, --test', 'start script without finalize commit (for tests)');
+  .name('format-commit')
+  .description('CLI to standardize commit nomenclature')
+  .version('0.3.1')
+  .option('-b, --branch', 'create a new branch with standardized naming')
+  .option('-c, --config', 'generate a configuration file on your project for format-commit')
+  .option('-t, --test', 'start without finalize commit (for tests)');
 
 try {
-    program.parse(process.argv);
+  program.parse(process.argv);
 } catch (error) {
-    console.error('Error parsing arguments:', error.message);
-    process.exit(1);
+  console.error('Error parsing arguments:', error.message);
+  process.exit(1);
 }
 
 (async () => {
-    const opts = program.opts();
+  const opts = program.opts();
+
+  if (opts.config) {
+    await setup(false);
+    return;
+  }
 
-    if (opts.config) {
-        await setup(false);
+  // Get config from consumer package root, generate new config file if not found
+  fs.readFile(`./${options.configFile}.json`, async (err, data) => {
+    if (err) {
+      utils.log('no configuration found', 'warning');
+      const setupResult = await setup(true);
+      if (setupResult && setupResult.commitAfter) {
+        commit(setupResult.config, opts.test);
+      }
+    } else {
+      if (opts.branch) {
+        const { default: createBranch } = await import('./create-branch.js');
+        createBranch(JSON.parse(data), opts.test);
         return;
+      }
+      commit(JSON.parse(data), opts.test);
     }
-
-    /**
-     * Get config from consumer package root
-     * Generate new config file if not founded
-     */
-    fs.readFile(`./${options.configFile}.json`, async (err, data) => {
-        if (err) {
-            utils.log('no configuration found', 'warning');
-            const setupResult = await setup(true);
-            if (setupResult && setupResult.commitAfter) {
-                commit(setupResult.config, opts.test);
-            }
-        } else {
-            commit(JSON.parse(data), opts.test);
-        }
-    });
+  });
 })();

package/lib/options.json

@@ -1,31 +1,62 @@
 {
-    "configFile": "commit-config",
-    "commitFormats": [
-        { "value": 1, "title": "(type) Name" },
-        { "value": 2, "title": "(type) name" },
-        { "value": 3, "title": "type: Name"  },
-        { "value": 4, "title": "type: name" },
-        { "value": 5, "title": "type(scope) Name" },
-        { "value": 6, "title": "type(scope) name" },
-        { "value": 7, "title": "type(scope): Name" },
-        { "value": 8, "title": "type(scope): name" }
-    ],
-    "versionChangeMode": [
-        { "value": "never", "title": "never (always ask)" },
-        { "value": "releaseBranch", "title": "only on release branch" },
-        { "value": "always" }
-    ],
-    "versionTypes": [
-        { "value": "patch" },
-        { "value": "minor" },
-        { "value": "major" },
-        { "value": "custom", "title": "<custom>" }
-    ],
-    "allVersionTypes": [
-        { "value": "prepatch" },
-        { "value": "preminor" },
-        { "value": "premajor" },
-        { "value": "prerelease", "title": "prerelease <tag>" },
-        { "value": "from-git" }
-    ]
+  "configFile": "commit-config",
+  "commitFormats": [
+    { "value": 1, "title": "(type) Name" },
+    { "value": 2, "title": "(type) name" },
+    { "value": 3, "title": "type: Name"  },
+    { "value": 4, "title": "type: name" },
+    { "value": 5, "title": "type(scope) Name" },
+    { "value": 6, "title": "type(scope) name" },
+    { "value": 7, "title": "type(scope): Name" },
+    { "value": 8, "title": "type(scope): name" }
+  ],
+  "branchFormats": [
+    { "value": 1, "title": "type/description" },
+    { "value": 2, "title": "type/scope/description" }
+  ],
+  "versionChangeMode": [
+    { "value": "ignore", "title": "never (ignore)" },
+    { "value": "never", "title": "never (always ask)" },
+    { "value": "releaseBranch", "title": "only on release branch" },
+    { "value": "always" }
+  ],
+  "versionTypes": [
+    { "value": "patch" },
+    { "value": "minor" },
+    { "value": "major" },
+    { "value": "custom", "title": "<custom>" }
+  ],
+  "allVersionTypes": [
+    { "value": "prepatch" },
+    { "value": "preminor" },
+    { "value": "premajor" },
+    { "value": "prerelease", "title": "prerelease <tag>" },
+    { "value": "from-git" }
+  ],
+  "aiProviders": [
+    {
+      "value": "anthropic",
+      "title": "Anthropic (Claude)",
+      "models": [
+        { "value": "claude-haiku-4-5", "title": "Claude Haiku 4.5 (Fast & Cheap)" },
+        { "value": "claude-sonnet-4-5", "title": "Claude Sonnet 4.5 (Balanced)" }
+      ]
+    },
+    {
+      "value": "openai",
+      "title": "OpenAI (GPT)",
+      "models": [
+        { "value": "gpt-4o-mini", "title": "GPT-4o Mini (Fast & Cheap)" },
+        { "value": "gpt-4o", "title": "GPT-4o (More Capable)" }
+      ]
+    },
+    {
+      "value": "google",
+      "title": "Google (Gemini)",
+      "models": [
+        { "value": "gemini-2.0-flash", "title": "Gemini 2.0 Flash (Fast & Free)" },
+        { "value": "gemini-1.5-pro", "title": "Gemini 1.5 Pro (More Capable)" }
+      ]
+    }
+  ]
 }