format-commit 0.1.10 → 0.3.0

package/README.md

@@ -1,32 +1,52 @@
 # format-commit
 
-Easily format and standardize your commits for all your javascript projects using Git.
+🚀 Lightweight CLI for consistent commit message formatting.
+
+Standardize your commit naming with basic rules, and guide your workflow through an automated script. No bloat, no complexity — just clean, consistent commits.
 
 ## Installation
 
 ```sh
-$ npm i format-commit --save-dev
+npm i format-commit --save-dev
 ```
 
 ## Usage
 
-In the scripts part of your package.json file add a new line `"commit": "format-commit"` and use `$ npm run commit` to commit your changes with format-commit.
+Add to your `package.json` scripts:
+```json
+"scripts": {
+  "commit": "format-commit"
+}
+```
 
-Or install format-commit globally to use directly `$ format-commit` command .
+Then use:
+```sh
+npm run commit
+```
 
-The first time you use the command within your project, format-commit will ask you some questions to configure your commits and create a configuration file `commit-config.json` at the root of your project.
+Or install globally:
+```sh
+npm i -g format-commit
+format-commit
+```
+
+On first use, format-commit will prompt you to configure your commit format and create a `commit-config.json` file.
 
-If you want to change format-commit configuration without manually editing the json file you can run the command `$ format-commit --config`.
+To reconfigure later, run:
+```sh
+format-commit --config
+```
 
 ## Configuration
 
 | Property | Description |
 | :------- | :---------- |
-| **format** | The formatting of your commit titles. <br> 1: (type) Name / 2: (type) name <br> 3: type: Name / 4: type: Name |
-| **types** | The different types of commit allowed. Not defined during assisted configuration, default values used: <br> feat / fix / core / test |
-| **minLength** | Minimum size allowed for your commit titles |
-| **maxLength** | Maximum size allowed for your commit titles |
-| **changeVersion** | "always": All commits must obligatorily involve a change of version (no preliminary request). <br> "only on release branch": All commits on your release/main branch must obligatorily involve a change of version (no preliminary request). <br> "never": Commits do not necessarily lead to a version change whatever the branch, the wizard will always ask. |
-| **releaseBranch** | Release/main Git branch of your project. Use if changeVersion is defined on "only on release branch". |
-| **showAllVersionTypes** | Show all possible types of version changes in the wizard, or show only the main ones (major / minor / patch / \<custom\>) |
-| **stageAllChanges** | Auto-stage all changes before each commit |
+| **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** | Application scopes for commit categorization (formats 5-8 only) |
+| **minLength** | Minimum commit title length |
+| **maxLength** | Maximum commit title length |
+| **changeVersion** | Version change policy:<br>`always` - All commits require version change<br>`only on release branch` - Only release branch commits require version change<br>`never` - Always prompt for version change |
+| **releaseBranch** | Main/release branch name (used with `only on release branch`) |
+| **showAllVersionTypes** | Show all version types or only main ones (`major`/`minor`/`patch`/`custom`) |
+| **stageAllChanges** | Auto-stage all changes before commit |

package/lib/commit.js

@@ -2,31 +2,50 @@
 
 const prompts = require('prompts');
 const utils = require('./utils');
+const options = require('./options.json');
 
 
-module.exports = async (options, config) => {
-    if (!options || !config) {
+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',
-            /**
-             * Get commit allowed types from custom config if exist
-             * or get default types from options file
-            */
-            choices: config.types ? config.types : options.commitTypes,
+            choices: config.types,
+        },
+        {
+            type: config.format >= 5 ? 'select' : null,
+            name: 'scope',
+            message: 'Scope',
+            choices: config.scopes,
         },
         {
             type: 'text',
@@ -81,7 +100,7 @@ module.exports = async (options, config) => {
      * Handle prompt cancellation and stop commit execution
      */
     if (cancelled) {
-        utils.log('commit cancelled');
+        utils.log('commit cancelled', 'error');
         return;
     }
 
@@ -92,7 +111,18 @@ module.exports = async (options, config) => {
     if (config.stageAllChanges) {
         utils.handleCmdExec('git add -A');
     }
-    const commitTitle = utils.formatCommitTitle(commit.type, commit.title, config.format);
+    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;

package/lib/default-config.json

@@ -1,15 +1,20 @@
 {
     "format": 1,
     "minLength": 8,
-    "maxLength": 70,
+    "maxLength": 80,
     "changeVersion": "never",
     "releaseBranch": "master",
     "showAllVersionTypes": false,
     "stageAllChanges": false,
     "types": [
-        { "value": "fix", "description": "Bug(s) correction" },
-        { "value": "feat", "description": "New feature(s)"},
+        { "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": "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

@@ -1,21 +1,37 @@
 #!/usr/bin/env node
 'use strict';
 
-const { program } = require('commander');
+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');
 
-program.option('-c, --config', 'generate a configuration file on your project for format-commit');
-program.parse(process.argv);
+const program = new Command();
+
+program
+    .name('format-commit')
+    .description('CLI to standardize commit nomenclature')
+    .version('0.3.0')
+    .option('-c, --config', 'generate a configuration file on your project for format-commit')
+    .option('-t, --test', 'start script without finalize commit (for tests)');
+
+try {
+    program.parse(process.argv);
+} catch (error) {
+    console.error('Error parsing arguments:', error.message);
+    process.exit(1);
+}
 
 (async () => {
-    if (program.config) {
-        await setup();
+    const opts = program.opts();
+
+    if (opts.config) {
+        await setup(false);
         return;
     }
+
     /**
      * Get config from consumer package root
      * Generate new config file if not founded
@@ -23,12 +39,12 @@ program.parse(process.argv);
     fs.readFile(`./${options.configFile}.json`, async (err, data) => {
         if (err) {
             utils.log('no configuration found', 'warning');
-            const setupResult = await setup(options);
+            const setupResult = await setup(true);
             if (setupResult && setupResult.commitAfter) {
-                commit(options, setupResult.config);
+                commit(setupResult.config, opts.test);
             }
         } else {
-            commit(options, JSON.parse(data));
+            commit(JSON.parse(data), opts.test);
         }
     });
 })();

package/lib/options.json

@@ -4,23 +4,27 @@
         { "value": 1, "title": "(type) Name" },
         { "value": 2, "title": "(type) name" },
         { "value": 3, "title": "type: Name"  },
-        { "value": 4, "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": "always" },
+        { "value": "never", "title": "never (always ask)" },
         { "value": "releaseBranch", "title": "only on release branch" },
-        { "value": "never", "title": "never (always ask)" }
+        { "value": "always" }
     ],
     "versionTypes": [
-        { "value": "major" },
-        { "value": "minor" },
         { "value": "patch" },
+        { "value": "minor" },
+        { "value": "major" },
         { "value": "custom", "title": "<custom>" }
     ],
     "allVersionTypes": [
-        { "value": "premajor" },
-        { "value": "preminor" },
         { "value": "prepatch" },
+        { "value": "preminor" },
+        { "value": "premajor" },
         { "value": "prerelease", "title": "prerelease <tag>" },
         { "value": "from-git" }
     ]

package/lib/setup.js

@@ -4,12 +4,10 @@ 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 (options) => {
-    if (!options) {
-        return;
-    }
+module.exports = async (askForCommitAfter) => {
     utils.log('create config file');
 
     /**
@@ -64,7 +62,7 @@ module.exports = async (options) => {
             initial: defaultConfig.showAllVersionTypes,
         },
         {
-            type: 'confirm',
+            type: askForCommitAfter ? 'confirm' : null,
             name: 'commitAfter',
             message: 'Commit your changes now? (or exit the configuration without committing)',
             initial: false,
@@ -80,7 +78,7 @@ module.exports = async (options) => {
      * Handle prompt cancellation and stop setup execution
      */
     if (cancelled) {
-        utils.log('setup cancelled');
+        utils.log('setup cancelled', 'error');
         return;
     }
 
@@ -90,6 +88,9 @@ module.exports = async (options) => {
     const config = {
         format: configChoices.format,
         types: defaultConfig.types,
+        scopes: configChoices.format >= 5
+            ? defaultConfig.scopes
+            : undefined,
         minLength: configChoices.minLength,
         maxLength: configChoices.maxLength,
         changeVersion: configChoices.changeVersion,
@@ -99,8 +100,15 @@ module.exports = async (options) => {
     };
     const parsedConfig = JSON.stringify(config, null, 2);
 
-    utils.log(`write ${options.configFile} file...`);
-    fs.writeFileSync(`./${options.configFile}.json`, parsedConfig);
+    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,

package/lib/utils.js

@@ -44,7 +44,7 @@ const validVersion = (version) => {
     return true;
 };
 
-const formatCommitTitle = (type, title, format) => {
+const formatCommitTitle = (type, title, format, scope = '*') => {
     switch (format) {
         case 1:
         default:
@@ -55,6 +55,14 @@ const formatCommitTitle = (type, title, format) => {
             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()}`;
     }
 };
 

package/package.json

@@ -1,7 +1,31 @@
 {
   "name": "format-commit",
-  "version": "0.1.10",
-  "description": "Format and standardize your git commits",
+  "version": "0.3.0",
+  "description": "Lightweight CLI to standardize commit messages",
+  "license": "ISC",
+  "author": "Thomas BARKATS",
+  "keywords": [
+    "git",
+    "commit",
+    "commits",
+    "cli",
+    "format",
+    "standardize",
+    "conventional",
+    "semantic",
+    "workflow",
+    "tool",
+    "javascript",
+    "nodejs"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thomasbarkats/format-commit.git"
+  },
+  "homepage": "https://github.com/thomasbarkats/format-commit#readme",
+  "bugs": {
+    "url": "https://github.com/thomasbarkats/format-commit/issues"
+  },
   "main": "./lib/index.js",
   "type": "commonjs",
   "scripts": {
@@ -9,7 +33,8 @@
     "test": "echo \"Error: no test specified\" && exit 1",
     "lint": "eslint . --ext .js --fix",
     "prepublishOnly": "npm run lint",
-    "preversion": "npm run lint"
+    "preversion": "npm run lint",
+    "commit": "npm run lint && npm run start"
   },
   "files": [
     "lib/**/*"
@@ -17,31 +42,13 @@
   "bin": {
     "format-commit": "./lib/index.js"
   },
-  "author": "Sendups",
-  "keywords": [
-    "git",
-    "commit",
-    "cli",
-    "format",
-    "standardize",
-    "light",
-    "minimalist"
-  ],
-  "license": "ISC",
   "dependencies": {
-    "commander": "^6.2.1",
-    "kleur": "^4.1.3",
-    "prompts": "^2.4.0"
+    "commander": "^14.0.0",
+    "kleur": "^4.1.4",
+    "prompts": "^2.4.2"
   },
   "devDependencies": {
-    "eslint": "^7.16.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/sendups/format-commit.git"
-  },
-  "bugs": {
-    "url": "https://github.com/sendups/format-commit/issues"
-  },
-  "homepage": "https://github.com/sendups/format-commit#readme"
+    "@eslint/js": "^9.27.0",
+    "eslint": "^9.27.0"
+  }
 }