format-commit 0.3.1 → 0.4.0

package/README.md

@@ -5,9 +5,9 @@
 [![npm downloads](https://img.shields.io/npm/dm/format-commit.svg)](https://www.npmjs.com/package/format-commit)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-🚀 Lightweight CLI for consistent commit message formatting.
+🚀 Lightweight CLI for consistent Git workflow formatting.
 
-Standardize your commit naming with basic rules, and guide your workflow through an automated script. No bloat, no complexity — just clean, consistent commits.
+Standardize your commit messages and branch naming with configurable rules, and guide your development workflow through automated scripts. No bloat, no complexity — just clean, consistent Git practices.
 
 ## Installation
 
@@ -20,22 +20,29 @@ npm i format-commit --save-dev
 Add to your `package.json` scripts:
 ```json
 "scripts": {
-  "commit": "format-commit"
+  "commit": "format-commit",
+  "branch": "format-commit --branch"
 }
 ```
 
 Then use:
 ```sh
-npm run commit
+npm run commit # to commit
+npm run branch # to create a branch
 ```
 
+### Global Installation
+
 Or install globally:
 ```sh
 npm i -g format-commit
 format-commit
+format-commit --branch
 ```
 
-On first use, format-commit will prompt you to configure your commit format and create a `commit-config.json` file.
+### Initial Setup
+
+On first use, format-commit will prompt you to configure your commit and branch formats, then create a `commit-config.json` file.
 
 To reconfigure later, run:
 ```sh
@@ -47,14 +54,22 @@ format-commit --config
 | Property | Description |
 | :------- | :---------- |
 | **format** | Commit title format:<br>1 - `(type) Name` / 2 - `(type) name`<br>3 - `type: Name` / 4 - `type: name`<br>5 - `type(scope) Name` / 6 - `type(scope) name`<br>7 - `type(scope): Name` / 8 - `type(scope): name` |
-| **types** | Allowed commit types (default: `feat`, `fix`, `core`, `test`, `config`, `doc`) |
-| **scopes** | Scopes for commit categorization (formats 5-8 only) |
+| **branchFormat** | Branch naming format:<br>1 - `type/description`<br>2 - `type/scope/description` |
+| **types** | Allowed commit and branch types (default: `feat`, `fix`, `core`, `test`, `config`, `doc`) |
+| **scopes** | Scopes for commit/branch categorization (used in formats 5-8 for commits, format 2 for branches) |
 | **minLength** | Minimum length required for the commit title |
-| **maxLength** | Maximum length required for the commit title |
+| **maxLength** | Maximum length required for the commit title and branch description |
 | **changeVersion** | Version change policy:<br>`never` - Always prompt for version change<br>`only on release branch` - Only release branch commits require version change<br>`always` - All commits require version change |
 | **releaseBranch** | Main/release branch name (used if changeVersion = `only on release branch`) |
 | **showAllVersionTypes** | Show all version types or only main ones (`major`/`minor`/`patch`/`custom`) |
-| **stageAllChanges** | Auto-stage all changes before commit ⚠️ |
+
+## CLI Options
+
+| Option | Description |
+| :----- | :---------- |
+| `--config` / `-c` | Generate or update configuration file |
+| `--branch` / `-b` | Create a new standardized branch |
+| `--test` / `-t` | Test mode - preview without executing Git commands |
 
 ## Contributing
 

package/lib/commit.js

@@ -6,165 +6,162 @@ const options = require('./options.json');
 
 
 module.exports = async (config, testMode) => {
-    if (!config) {
-        return;
-    }
-    utils.log('new commit');
-
-    if (testMode) {
-        utils.log('test mode enabled - commit will not be performed', 'warning');
-    }
-
-    /**
-     * Get current git branch for version change option "only on release branch"
-    */
-    const currentBranch = utils.getCurrentBranch();
-    const askForVersion = utils.askForVersion(config, currentBranch);
-
-    const noType = !config.types || (config.types && config.types.length === 0);
-    if (noType) {
-        utils.log('no types defined - please update config', 'error');
-        return;
-    }
-
-    const noScope = !config.scopes || (config.scopes && config.scopes.length === 0);
-    if (config.format >= 5 && noScope) {
-        utils.log('no scopes defined - update config or format option', 'error');
-        return;
-    }
-
-    let cancelled = false;
-    const commit = await prompts([
-        {
-            type: 'select',
-            name: 'type',
-            message: 'Type of changes',
-            choices: config.types,
-        },
-        {
-            type: config.format >= 5 ? 'select' : null,
-            name: 'scope',
-            message: 'Scope',
-            choices: config.scopes,
-        },
-        {
-            type: 'text',
-            name: 'title',
-            message: 'Commit title?',
-            validate: val => utils.validCommitTitle(val, config.minLength, config.maxLength),
-        },
-        {
-            type: 'text',
-            name: 'description',
-            message: 'Commit description?',
-            validate: val => val.length > 255 ? 'Commit description too long' : true,
-        },
-        {
-            type: askForVersion ? null : 'confirm',
-            name: 'changeVersion',
-            message: 'Change package version?',
-            initial: false,
-        },
-        {
-            type: prev => askForVersion | prev ? 'select' : null,
-            name: 'version',
-            message: 'Type of version change',
-            /**
-             * Display only some npm version options or all depending on config
-             */
-            choices: config.showAllVersionTypes
-                ? [...options.versionTypes, ...options.allVersionTypes]
-                : options.versionTypes,
-        },
-        {
-            type: prev => prev === 'custom' ? 'text' : null,
-            name: 'customVersion',
-            message: 'Version?',
-            validate: val => utils.validVersion(val),
-        },
-        {
-            type: 'confirm',
-            name: 'pushAfterCommit',
-            message: 'Push changes?',
-            initial: false,
-        },
-    ], {
-        onCancel: () => {
-            cancelled = true;
-            return false;
-        },
-    });
-
+  if (!config) {
+    return;
+  }
+  utils.log('new commit');
+
+  if (testMode) {
+    utils.log('test mode enabled - commit will not be performed', 'warning');
+  }
+
+  /**
+   * Get current git branch for version change option "only on release branch"
+  */
+  const currentBranch = utils.getCurrentBranch();
+  const askForVersion = utils.askForVersion(config, currentBranch);
+
+  const noType = !config.types || (config.types && config.types.length === 0);
+  if (noType) {
+    utils.log('no types defined - please update config', 'error');
+    return;
+  }
+
+  const noScope = !config.scopes || (config.scopes && config.scopes.length === 0);
+  if (config.format >= 5 && noScope) {
+    utils.log('no scopes defined - update config or format option', 'error');
+    return;
+  }
+
+  let cancelled = false;
+  const commit = await prompts([
+    {
+      type: 'select',
+      name: 'type',
+      message: 'Type of changes',
+      choices: config.types,
+    },
+    {
+      type: config.format >= 5 ? 'select' : null,
+      name: 'scope',
+      message: 'Scope',
+      choices: config.scopes,
+    },
+    {
+      type: 'text',
+      name: 'title',
+      message: 'Commit title?',
+      validate: val => utils.validCommitTitle(val, config.minLength, config.maxLength),
+    },
+    {
+      type: 'text',
+      name: 'description',
+      message: 'Commit description?',
+      validate: val => val.length > 255 ? 'Commit description too long' : true,
+    },
+    {
+      type: askForVersion ? null : 'confirm',
+      name: 'changeVersion',
+      message: 'Change package version?',
+      initial: false,
+    },
+    {
+      type: prev => askForVersion | prev ? 'select' : null,
+      name: 'version',
+      message: 'Type of version change',
+      /**
+       * Display only some npm version options or all depending on config
+       */
+      choices: config.showAllVersionTypes
+        ? [...options.versionTypes, ...options.allVersionTypes]
+        : options.versionTypes,
+    },
+    {
+      type: prev => prev === 'custom' ? 'text' : null,
+      name: 'customVersion',
+      message: 'Version?',
+      validate: val => utils.validVersion(val),
+    },
+    {
+      type: 'confirm',
+      name: 'pushAfterCommit',
+      message: 'Push changes?',
+      initial: false,
+    },
+  ], {
+    onCancel: () => {
+      cancelled = true;
+      return false;
+    },
+  });
+
+  /**
+   * Handle prompt cancellation and stop commit execution
+   */
+  if (cancelled) {
+    utils.log('commit cancelled', 'error');
+    return;
+  }
+
+  /**
+   * Format changes message and commit it
+   */
+  utils.log('commit changes...');
+  const commitTitle = utils.formatCommitTitle(
+    commit.type,
+    commit.title,
+    config.format,
+    commit.scope
+  );
+
+  if (testMode) {
+    utils.log(commitTitle, 'warning');
+    return;
+  }
+
+  const commitRes = utils.handleCmdExec(`git commit -m "${commitTitle}" -m "${commit.description}"`);
+  if (!commitRes) {
+    return;
+  }
+  utils.log('commit successfully completed', 'success');
+  console.log(commitRes);
+
+  let newVersion = null;
+  if (commit.version === 'prerelease') {
     /**
-     * Handle prompt cancellation and stop commit execution
+     * Ask tag if new version is a prerelease and update it
      */
-    if (cancelled) {
-        utils.log('commit cancelled', 'error');
-        return;
-    }
-
-    /**
-     * Format changes message and commit it
-     */
-    utils.log('commit changes...');
-    if (config.stageAllChanges) {
-        utils.handleCmdExec('git add -A');
-    }
-    const commitTitle = utils.formatCommitTitle(
-        commit.type,
-        commit.title,
-        config.format,
-        commit.scope
-    );
-
-    if (testMode) {
-        utils.log(commitTitle, 'warning');
-        return;
-    }
-
-    const commitRes = utils.handleCmdExec(`git commit -m "${commitTitle}" -m "${commit.description}"`);
-    if (!commitRes) {
-        return;
-    }
-    utils.log('commit successfully completed', 'success');
-    console.log(commitRes);
-
-    let newVersion = null;
-    if (commit.version === 'prerelease') {
-        /**
-         * Ask tag if new version is a prerelease and update it
-         */
-        const preRelease = await prompts([
-            {
-                type: 'text',
-                name: 'tag',
-                message: 'Pre-release tag?',
-            },
-        ]);
-        utils.log('update version...');
-        newVersion = utils.handleCmdExec(`npm version ${commit.version} --preid=${preRelease.tag}`);
-
-    } else if (commit.version) {
-        /**
-         * Ask version if custom option selected and update it
-         */
-        utils.log('update version...');
-        const version = commit.customVersion ? commit.customVersion : commit.version;
-        newVersion = utils.handleCmdExec(`npm version ${version} --allow-same-version`);
-    }
-
-    if (newVersion) {
-        utils.log(`package updated to ${newVersion}`);
-    }
-
+    const preRelease = await prompts([
+      {
+        type: 'text',
+        name: 'tag',
+        message: 'Pre-release tag?',
+      },
+    ]);
+    utils.log('update version...');
+    newVersion = utils.handleCmdExec(`npm version ${commit.version} --preid=${preRelease.tag}`);
+
+  } else if (commit.version) {
     /**
-     * Push commit if option selection
+     * Ask version if custom option selected and update it
      */
-    if (commit.pushAfterCommit) {
-        utils.log('push changes...');
-        const gitPush = utils.handleCmdExec(`git push -u origin ${currentBranch}`);
-        console.log(gitPush);
-    }
-    const gitStatus = utils.handleCmdExec('git status');
-    console.log(gitStatus);
+    utils.log('update version...');
+    const version = commit.customVersion ? commit.customVersion : commit.version;
+    newVersion = utils.handleCmdExec(`npm version ${version} --allow-same-version`);
+  }
+
+  if (newVersion) {
+    utils.log(`package updated to ${newVersion}`);
+  }
+
+  /**
+   * Push commit if option selection
+   */
+  if (commit.pushAfterCommit) {
+    utils.log('push changes...');
+    const gitPush = utils.handleCmdExec(`git push -u origin ${currentBranch}`);
+    console.log(gitPush);
+  }
+  const gitStatus = utils.handleCmdExec('git status');
+  console.log(gitStatus);
 };

package/lib/create-branch.js

@@ -0,0 +1,127 @@
+'use strict';
+
+const prompts = require('prompts');
+const utils = require('./utils');
+
+
+module.exports = async (config, testMode) => {
+  if (!config) {
+    return;
+  }
+  utils.log('new branch');
+
+  if (testMode) {
+    utils.log('test mode enabled - branch will not be created', 'warning');
+  }
+
+  /**
+   * Check if branchFormat is configured
+   */
+  if (!config.branchFormat) {
+    utils.log('no branch format defined - please update config', 'error');
+    return;
+  }
+
+  const noType = !config.types || (config.types && config.types.length === 0);
+  if (noType) {
+    utils.log('no types defined - please update config', 'error');
+    return;
+  }
+
+  const noScope = !config.scopes || (config.scopes && config.scopes.length === 0);
+  if (config.branchFormat === 2 && noScope) {
+    utils.log('no scopes defined - update config or branch format option', 'error');
+    return;
+  }
+
+  let cancelled = false;
+  const branch = await prompts([
+    {
+      type: 'select',
+      name: 'type',
+      message: 'Type of branch',
+      choices: config.types,
+    },
+    {
+      type: config.branchFormat === 2 ? 'select' : null,
+      name: 'scope',
+      message: 'Scope',
+      choices: config.scopes,
+    },
+    {
+      type: 'text',
+      name: 'description',
+      message: 'Branch description?',
+      validate: val => utils.validBranchDescription(val, config.maxLength),
+    },
+    {
+      type: 'confirm',
+      name: 'checkoutAfterCreate',
+      message: 'Switch to the new branch after creation?',
+      initial: true,
+    },
+  ], {
+    onCancel: () => {
+      cancelled = true;
+      return false;
+    },
+  });
+
+  /**
+   * Handle prompt cancellation and stop branch creation
+   */
+  if (cancelled) {
+    utils.log('branch creation cancelled', 'error');
+    return;
+  }
+
+  /**
+   * Format branch name and create it
+   */
+  utils.log('create branch...');
+  const branchName = utils.formatBranchName(
+    branch.type,
+    branch.description,
+    config.branchFormat,
+    branch.scope
+  );
+
+  if (testMode) {
+    utils.log(`Branch name: ${branchName}`, 'warning');
+    return;
+  }
+
+  /**
+   * Check if branch already exists
+   */
+  const branchExists = utils.checkBranchExists(branchName);
+  if (branchExists) {
+    utils.log(`branch "${branchName}" already exists`, 'error');
+    return;
+  }
+
+  /**
+   * Create the branch
+   */
+  const createCommand = branch.checkoutAfterCreate
+    ? `git checkout -b ${branchName}`
+    : `git branch ${branchName}`;
+
+  const createRes = utils.handleCmdExec(createCommand);
+  if (!createRes) {
+    return;
+  }
+
+  const successMessage = branch.checkoutAfterCreate
+    ? `branch "${branchName}" successfully created and checked out`
+    : `branch "${branchName}" successfully created`;
+
+  utils.log(successMessage, 'success');
+  console.log(createRes);
+
+  /**
+   * Show current git status
+   */
+  const gitStatus = utils.handleCmdExec('git status');
+  console.log(gitStatus);
+};

package/lib/default-config.json

@@ -1,20 +1,20 @@
 {
-    "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": "never",
+  "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" }
+  ]
 }

package/lib/index.js

@@ -11,40 +11,46 @@ const options = require('./options.json');
 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);
+  if (opts.config) {
+    await setup(false);
+    return;
+  }
+
+  /**
+   * 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 {
+      if (opts.branch) {
+        const createBranch = require('./create-branch');
+        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,35 @@
 {
-    "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": "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" }
+  ]
 }

package/lib/setup.js

@@ -8,110 +8,110 @@ const options = require('./options.json');
 
 
 module.exports = async (askForCommitAfter) => {
-    utils.log('create config file');
+  utils.log('create config file');
 
-    /**
-     * Get current git branch to pre-fill release branch option
-    */
-    const currentBranch = utils.getCurrentBranch();
+  /**
+   * 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;
-        },
-    });
+  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: 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;
-    }
+  /**
+   * Handle prompt cancellation and stop setup execution
+   */
+  if (cancelled) {
+    utils.log('setup cancelled', 'error');
+    return;
+  }
 
-    /**
-     * 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);
+  /**
+   * 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,
+  };
+  const parsedConfig = JSON.stringify(config, null, 2);
 
-    utils.log(`save ${options.configFile}.json file...`);
+  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;
-    }
+  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
-    };
+  return {
+    config,
+    commitAfter: configChoices.commitAfter
+  };
 };

package/lib/utils.js

@@ -5,101 +5,155 @@ const { gray, bold, red, green, yellow } = require('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 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';
+  } else if (title.length > lenMax) {
+    return 'Commit title too long';
+  }
+  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()}`;
-    }
+  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()}`;
+  }
 };
 
 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;
+    }
+    const remoteBranches = execSync('git branch -r --list').toString();
+    if (remoteBranches.includes(`origin/${branchName}`)) {
+      return true;
     }
-    console.log(`${date} ${type === 'error' ? red(msg) : (type === 'success' ? green(msg) : msg)}`);
+    return false;
+  } catch {
+    return false;
+  }
 };
 
 
 module.exports = {
-    askForVersion,
-    getCurrentBranch,
-    validCommitTitle,
-    validCommitTitleSetupLength,
-    validVersion,
-    formatCommitTitle,
-    handleCmdExec,
-    log,
+  askForVersion,
+  getCurrentBranch,
+  validCommitTitle,
+  validCommitTitleSetupLength,
+  validBranchDescription,
+  validVersion,
+  formatCommitTitle,
+  formatBranchName,
+  checkBranchExists,
+  handleCmdExec,
+  log,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "format-commit",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Lightweight CLI to standardize commit messages",
   "license": "ISC",
   "author": "Thomas BARKATS",
@@ -33,7 +33,6 @@
   },
   "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",
@@ -47,11 +46,11 @@
   },
   "dependencies": {
     "commander": "^14.0.0",
-    "kleur": "^4.1.4",
+    "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"
   }
 }