format-commit 0.1.8 → 0.2.2

package/README.md

@@ -22,10 +22,12 @@ If you want to change format-commit configuration without manually editing the j
 
 | 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 |
+| **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 |

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 = await utils.getCurrentBranch();
+    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;
     }
 
@@ -89,8 +108,22 @@ module.exports = async (options, config) => {
      * Format changes message and commit it
      */
     utils.log('commit changes...');
-    const commitTitle = utils.formatCommitTitle(commit.type, commit.title, config.format);
-    const commitRes = await utils.handleCmdExec(`git add -A && git commit -m "${commitTitle}" -m "${commit.description}"`);
+    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;
     }
@@ -110,7 +143,7 @@ module.exports = async (options, config) => {
             },
         ]);
         utils.log('update version...');
-        newVersion = await utils.handleCmdExec(`npm version ${commit.version} --preid=${preRelease.tag}`);
+        newVersion = utils.handleCmdExec(`npm version ${commit.version} --preid=${preRelease.tag}`);
 
     } else if (commit.version) {
         /**
@@ -118,7 +151,7 @@ module.exports = async (options, config) => {
          */
         utils.log('update version...');
         const version = commit.customVersion ? commit.customVersion : commit.version;
-        newVersion = await utils.handleCmdExec(`npm version ${version} --allow-same-version`);
+        newVersion = utils.handleCmdExec(`npm version ${version} --allow-same-version`);
     }
 
     if (newVersion) {
@@ -130,9 +163,9 @@ module.exports = async (options, config) => {
      */
     if (commit.pushAfterCommit) {
         utils.log('push changes...');
-        const gitPush = await utils.handleCmdExec(`git push -u origin ${currentBranch}`);
+        const gitPush = utils.handleCmdExec(`git push -u origin ${currentBranch}`);
         console.log(gitPush);
     }
-    const gitStatus = await utils.handleCmdExec('git status');
+    const gitStatus = utils.handleCmdExec('git status');
     console.log(gitStatus);
 };

package/lib/default-config.json

@@ -1,14 +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

@@ -9,11 +9,12 @@ 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);
 
 (async () => {
     if (program.config) {
-        await setup();
+        await setup(false);
         return;
     }
     /**
@@ -23,12 +24,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, program.test);
             }
         } else {
-            commit(options, JSON.parse(data));
+            commit(JSON.parse(data), program.test);
         }
     });
 })();

package/lib/options.json

@@ -4,12 +4,16 @@
         { "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": "releaseBranch", "title": "only on release branch" },
-        { "value": "never" }
+        { "value": "never", "title": "never (always ask)" }
     ],
     "versionTypes": [
         { "value": "major" },

package/lib/setup.js

@@ -4,18 +4,16 @@ 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');
 
     /**
      * Get current git branch to pre-fill release branch option
     */
-    const currentBranch = await utils.getCurrentBranch();
+    const currentBranch = utils.getCurrentBranch();
 
     let cancelled = false;
     const configChoices = await prompts([
@@ -39,6 +37,12 @@ module.exports = async (options) => {
             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',
@@ -58,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,
@@ -74,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;
     }
 
@@ -84,16 +88,27 @@ module.exports = async (options) => {
     const config = {
         format: configChoices.format,
         types: defaultConfig.types,
+        scopes: configChoices.format >= 5
+            ? defaultConfig.scopes
+            : undefined,
         minLength: configChoices.minLength,
-        maxLengt: configChoices.maxLength,
+        maxLength: configChoices.maxLength,
         changeVersion: configChoices.changeVersion,
         releaseBranch: configChoices.releaseBranch,
         showAllVersionTypes: configChoices.showAllVersionTypes,
+        stageAllChanges: configChoices.stageAllChanges,
     };
     const parsedConfig = JSON.stringify(config, null, 2);
 
-    utils.log(`write ${options.configFile} file...`);
-    await 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

@@ -38,33 +38,40 @@ const validCommitTitleSetupLength = (len) => {
 
 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)) {
+    if (!regex.test(version)) {
         return 'Version does not respect semantic versioning';
     }
     return true;
 };
 
-const formatCommitTitle = (type, title, format) => {
+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 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 = async (command) => {
+const handleCmdExec = (command) => {
     try {
-        const output = await execSync(command);
+        const output = execSync(command);
         return output.toString();
-    } catch(err) {
+    } catch (err) {
         log(`Error\n${err.message ? err.message : err}`, 'error');
-        return;
     }
 };
 
@@ -72,15 +79,15 @@ 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;
+        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)}`);
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "format-commit",
-  "version": "0.1.8",
-  "description": "Format and standardize your git commits",
+  "version": "0.2.2",
+  "description": "Format and standardize your Git commits",
   "main": "./lib/index.js",
   "type": "commonjs",
   "scripts": {
@@ -17,7 +17,7 @@
   "bin": {
     "format-commit": "./lib/index.js"
   },
-  "author": "Sendups",
+  "author": "Thomas BARKATS",
   "keywords": [
     "git",
     "commit",
@@ -29,12 +29,12 @@
   ],
   "license": "ISC",
   "dependencies": {
-    "commander": "^6.2.1",
-    "kleur": "^4.1.3",
-    "prompts": "^2.4.0"
+    "commander": "^9.2.0",
+    "kleur": "^4.1.4",
+    "prompts": "^2.4.2"
   },
   "devDependencies": {
-    "eslint": "^7.16.0"
+    "eslint": "^8.14.0"
   },
   "repository": {
     "type": "git",