format-commit 0.2.2 → 0.3.1

package/README.md

@@ -1,33 +1,61 @@
 # format-commit
 
-Easily format and standardize your commits for all your javascript projects using Git.
+[![npm version](https://badge.fury.io/js/format-commit.svg)](https://badge.fury.io/js/format-commit)
+[![Node.js Version](https://img.shields.io/node/v/format-commit.svg)](https://nodejs.org/)
+[![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.
+
+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"
+}
+```
+
+Then use:
+```sh
+npm run commit
+```
 
-Or install format-commit globally to use directly `$ format-commit` command .
+Or install globally:
+```sh
+npm i -g format-commit
+format-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.
+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** | Format option for your commit titles. <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** | The different types of commit allowed. Not defined during assisted configuration, default values used: feat / fix / core / test / config / doc |
-| **scopes** | Your application's scopes to categorize your commits (only for related formats 5 to 8). Not defined during assisted configuration |
-| **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** | Scopes for commit categorization (formats 5-8 only) |
+| **minLength** | Minimum length required for the commit title |
+| **maxLength** | Maximum length required for the commit title |
+| **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 ⚠️ |
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues or submit pull requests.

package/lib/commit.js

@@ -75,7 +75,6 @@ module.exports = async (config, testMode) => {
             choices: config.showAllVersionTypes
                 ? [...options.versionTypes, ...options.allVersionTypes]
                 : options.versionTypes,
-            initial: currentBranch === config.releaseBranch ? 1 : 2,
         },
         {
             type: prev => prev === 'custom' ? 'text' : null,

package/lib/default-config.json

@@ -3,7 +3,7 @@
     "minLength": 8,
     "maxLength": 80,
     "changeVersion": "never",
-    "releaseBranch": "master",
+    "releaseBranch": "main",
     "showAllVersionTypes": false,
     "stageAllChanges": false,
     "types": [

package/lib/index.js

@@ -1,22 +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.option('-t, --test', 'start script without finalize commit (for tests)');
-program.parse(process.argv);
+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)');
+
+try {
+    program.parse(process.argv);
+} catch (error) {
+    console.error('Error parsing arguments:', error.message);
+    process.exit(1);
+}
 
 (async () => {
-    if (program.config) {
+    const opts = program.opts();
+
+    if (opts.config) {
         await setup(false);
         return;
     }
+
     /**
      * Get config from consumer package root
      * Generate new config file if not founded
@@ -26,10 +41,10 @@ program.parse(process.argv);
             utils.log('no configuration found', 'warning');
             const setupResult = await setup(true);
             if (setupResult && setupResult.commitAfter) {
-                commit(setupResult.config, program.test);
+                commit(setupResult.config, opts.test);
             }
         } else {
-            commit(JSON.parse(data), program.test);
+            commit(JSON.parse(data), opts.test);
         }
     });
 })();

package/lib/options.json

@@ -11,20 +11,20 @@
         { "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/package.json

@@ -1,15 +1,43 @@
 {
   "name": "format-commit",
-  "version": "0.2.2",
-  "description": "Format and standardize your Git commits",
+  "version": "0.3.1",
+  "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",
+  "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"
+    "preversion": "npm run lint",
+    "commit": "npm run lint && npm run start"
   },
   "files": [
     "lib/**/*"
@@ -17,31 +45,13 @@
   "bin": {
     "format-commit": "./lib/index.js"
   },
-  "author": "Thomas BARKATS",
-  "keywords": [
-    "git",
-    "commit",
-    "cli",
-    "format",
-    "standardize",
-    "light",
-    "minimalist"
-  ],
-  "license": "ISC",
   "dependencies": {
-    "commander": "^9.2.0",
+    "commander": "^14.0.0",
     "kleur": "^4.1.4",
     "prompts": "^2.4.2"
   },
   "devDependencies": {
-    "eslint": "^8.14.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"
+  }
 }