refactor: update commit message hook error help

Author: zdm

lib/commands/git/commit-msg.js

@@ -2,8 +2,10 @@ import fs from "node:fs";
 import ansi from "#core/ansi";
 import Commit from "#core/api/git/commit";
 import Command from "#lib/command";
+import Changelog from "#lib/git/changelog";
 
 export default class extends Command {
+    #commitsConfig;
 
     // static
     static cli () {
@@ -38,18 +40,10 @@ git commit -m"feat(core)!: commit description"
         const pkg = this._findGitPackage();
         if ( !pkg ) return;
 
-        // prepare types
-        const types = {};
-        for ( const [ type, config ] of Object.entries( pkg.cliConfig?.commits.types || {} ) ) {
-            if ( !config ) continue;
+        this.#commitsConfig = pkg.cliConfig?.commits;
 
-            types[ type ] = {
-                ...config,
-                type,
-            };
-        }
-
-        const message = fs.readFileSync( process.cli.arguments.path, "utf8" ),
+        const types = this.#getTypes(),
+            message = fs.readFileSync( process.cli.arguments.path, "utf8" ),
             isRevert = fs.existsSync( ".git/REVERT_HEAD" );
 
         if ( fs.existsSync( ".git/MERGE_HEAD" ) ) {
@@ -90,17 +84,15 @@ git commit -m"feat(core)!: commit description"
                 return this.#throwError( `Commit message subject should not ends with ".".` );
             }
 
-            const type = types[ commit.type ],
-                scopes = new Map( Object.entries( type?.productionChange
-                    ? pkg.cliConfig?.commits.scopes || {}
-                    : type?.scopes || {} ).filter( ( [ key, value ] ) => value ) );
+            const type = types.get( commit.type ),
+                scopes = this.#getTypeScopes( type );
 
             // check strict type
             if ( pkg.cliConfig?.commits.strictType ) {
 
                 // commit type is not valid
                 if ( !type ) {
-                    return this.#throwError( `Commit type is not valid. Allowed types:\n${ this.#getAllowedTypes( types ) }` );
+                    return this.#throwError( "Commit type is not valid.", { "types": true } );
                 }
             }
 
@@ -113,7 +105,7 @@ git commit -m"feat(core)!: commit description"
                     // commit scope is not valid
                     if ( !scopes.has( commit.scope ) ) {
                         if ( scopes.size ) {
-                            return this.#throwError( `Commit scope is not valid. Allowed scopes for this commit type are:\n${ this.#getAllowedScopes( scopes ) }` );
+                            return this.#throwError( "Commit scope is not valid.", { "types": true } );
                         }
                         else {
                             return this.#throwError( `Commit scope is not allowed for this commit type.` );
@@ -124,7 +116,7 @@ git commit -m"feat(core)!: commit description"
 
             // commit scope is required
             else if ( type.requireScope && scopes.size ) {
-                return this.#throwError( `Commit scope is required. Allowed scopes for this commit type are:\n${ this.#getAllowedScopes( scopes ) }` );
+                return this.#throwError( "Commit scope is required.", { "types": true } );
             }
 
             // restrict breaking changes to the production changes only
@@ -142,22 +134,81 @@ git commit -m"feat(core)!: commit description"
 
         // commit type is required
         else if ( pkg.cliConfig?.commits.requireType ) {
-            return this.#throwError( `Commit type is required. Allowed types:\n${ this.#getAllowedTypes( types ) }` );
+            return this.#throwError( "Commit type is required.", { "types": true } );
         }
     }
 
     // private
-    #getAllowedTypes ( types ) {
-        return Object.values( types )
-            .map( type => `    - "${ type.type }": ${ type.description }` )
-            .join( "\n" );
+    #getTypes () {
+        const types = new Map();
+
+        if ( this.#commitsConfig ) {
+            for ( const [ name, type ] of Object.entries( this.#commitsConfig.types ) ) {
+                if ( !type ) continue;
+
+                type.name = name;
+
+                types.set( name, type );
+            }
+        }
+
+        return types;
     }
 
-    #getAllowedScopes ( scopes ) {
-        return [ ...scopes.keys() ].map( scope => `    - "${ scope }": ${ scopes.get( scope ) }` ).join( "\n" );
+    #getTypeScopes ( type ) {
+        const scopes = new Map( Object.entries( type?.productionChange
+            ? this.#commitsConfig?.scopes || {}
+            : type?.scopes || {} ).filter( ( [ key, value ] ) => value ) );
+
+        return scopes;
+    }
+
+    #throwError ( message, { types } = {} ) {
+        if ( types ) {
+            const help = this.#createTypesHelp();
+
+            console.error( help );
+        }
+
+        const statusText = `${ message }\nRefer to the documentation: ${ ansi.link( "https://www.conventionalcommits.org/en/" ) }.`;
+
+        throw result( [ 500, statusText ] );
     }
 
-    #throwError ( message ) {
-        throw result( [ 500, `${ message }\nRefer to the documentation: ${ ansi.link( "https://www.conventionalcommits.org/en/" ) }.` ] );
+    #createTypesHelp () {
+        var markdown = "";
+
+        const types = this.#getTypes();
+
+        if ( types.size ) {
+            markdown += `Commit types:\n`;
+
+            for ( const type of types.values() ) {
+                markdown += `
+- \`${ type.name }\`: ${ type.title || Changelog.getTypeTitle( type.name ) }. ${ type.description }
+`;
+
+                const scopes = this.#getTypeScopes( type );
+
+                if ( scopes.size ) {
+                    if ( type.requireScope ) {
+                        markdown += `Commit scope is required. `;
+                    }
+
+                    markdown += `Allowed scopes for this commit type:\n`;
+
+                    for ( const [ name, description ] of scopes.entries() ) {
+                        markdown += `
+    - \`${ name }\`: ${ description }`;
+                    }
+                }
+            }
+        }
+
+        var text = Changelog.convertMarkdownToText( markdown, { "ansi": true } );
+
+        if ( text ) text += "\n";
+
+        return text;
     }
 }

lib/git/changelog.js

@@ -37,6 +37,15 @@ export default class GitChangelog {
         this.#indexChanges( commitTypes || DEFAULT_COMMIT_TYPES );
     }
 
+    // static
+    static getTypeTitle ( type ) {
+        return TITLES[ type ];
+    }
+
+    static convertMarkdownToText ( markdown, { ansi } = {} ) {
+        return new Markdown( markdown ).toString( { ansi } ).trim();
+    }
+
     // properties
     get previousRelease () {
         return this.#previousRelease;