feat: add type and scope description to commit-msg-hook error log

Author: qoomon

git-conventional-commits.yaml

@@ -13,7 +13,7 @@ convention:
   - chore    # Miscellaneous commits e.g. modifying `.gitignore`
   - merge
   - revert
-  commitScopes: []
+  commitScopes: [s]
   releaseTagGlobPattern: v[0-9]*.[0-9]*.[0-9]*
 changelog:
   commitTypes:

lib/commands/commandCommitMessageHook.js

@@ -39,14 +39,18 @@ exports.handler = async function (argv) {
         !convention.commitTypes.includes(conventionalCommit.type)) {
         conventionError = true
         console.error(`[ERROR] Unexpected commit type: '${conventionalCommit.type}'`);
-        console.error(`  Permitted types : ${convention.commitTypes.map(e => `'${e}'`).join(', ')}`);
+        const maxTypeLength = Math.max(...convention.commitTypes.map(s => s.length));
+        console.error(`  Permitted types:\n` +
+            convention.commitTypes.map(e => `    - ${e.padEnd(maxTypeLength )}  ${convention.commitTypeDescriptions?.[e] ?? ''}`).join('\n'));
     }
     if (conventionalCommit.scope &&
         convention.commitScopes && convention.commitScopes.length &&
         !convention.commitScopes.includes(conventionalCommit.scope)) {
         conventionError = true
         console.error(`[ERROR] Unexpected commit scope: '${conventionalCommit.scope}'`);
-        console.error(`  Permitted scopes: ${!convention.commitScopes || !convention.commitScopes.length ? '*' : convention.commitScopes.map(e => `'${e}'`).join(', ')}`);
+        const maxScopeLength = Math.max(...convention.commitScopes.map(s => s.length));
+        console.error(`  Permitted scopes:\n` +
+            convention.commitScopes.map(e => `    - ${e.padEnd(maxScopeLength )}  ${convention.commitScopeDescriptions?.[e] ?? ''}`).join('\n'));
     }
 
     if (conventionError) {

lib/commands/config.js

@@ -17,8 +17,8 @@ function load(configFile) {
     }
 
     const configText = fs.readFileSync(path.resolve(configFile)).toString();
-    const configOverride = YAML.parse(configText);
-
+    const configOverrideDocument = YAML.parseDocument(configText);
+    const configOverride =configOverrideDocument.toJSON();
     const config = defaultConfig();
 
     if (configOverride.convention) {
@@ -29,8 +29,22 @@ function load(configFile) {
 
         conventionConfig.msgRegex = RegExp(conventionOverride.commitMessageRegexPattern || conventionConfig.msgRegex);
         conventionConfig.commitTypes = conventionOverride.commitTypes || conventionConfig.commitTypes;
+        conventionConfig.commitTypeDescriptions = configOverrideDocument
+            .get('convention').get('commitTypes')
+            .items.reduce((acc, item) => {
+                acc[item.value] = [item.commentBefore?.trim(), item.comment?.trim()]
+                    .filter(Boolean).join('\n') || undefined;
+                return acc;
+            }, {});
         conventionConfig.featureCommitTypes = conventionOverride.featureCommitTypes || conventionConfig.featureCommitTypes;
         conventionConfig.commitScopes = conventionOverride.commitScopes || conventionConfig.commitScopes;
+        conventionConfig.commitScopeDescriptions = configOverrideDocument
+            .get('convention').get('commitScopes')
+            .items.reduce((acc, item) => {
+                acc[item.value] = [item.commentBefore?.trim(), item.comment?.trim()]
+                    .filter(Boolean).join('\n') || undefined;
+                return acc;
+            }, {});
 
         // Legacy support convention.issueRegexPattern
         config.changelog.issueRegexPattern = conventionOverride.issueRegexPattern || config.changelog.issueRegexPattern;
@@ -80,8 +94,10 @@ function defaultConfig() {
                 'chore',
                 'merge',
             ],
+            commitTypeDescriptions: {},
             featureCommitTypes: ['feat'],
             commitScopes: null,
+            commitScopeDescriptions: {},
         },
         changelog: {
             commitTypes: ['feat', 'fix', 'perf'],

lib/gitCommitConvention.js

@@ -115,12 +115,12 @@ module.exports = function (convention, commitAnchor = 'HEAD') {
         if (conventionalSubject.type &&
             convention.commitTypes && convention.commitTypes.length &&
             !convention.commitTypes.includes(conventionalSubject.type)) {
-            console.warn(`[WARN] ${commit.hash ? `${commit.hash} - ` : ''}Unexpected commit type: '${conventionalSubject.type}'`);
+            console.warn(`[WARN] ${commit.hash ? `${commit.hash.substring(0, 7)} - ` : ''}Unexpected commit type: '${conventionalSubject.type}'`);
         }
         if (conventionalSubject.scope &&
             convention.commitScopes && convention.commitScopes.length &&
             !convention.commitScopes.includes(conventionalSubject.scope)) {
-            console.warn(`[WARN] ${commit.hash ? `${commit.hash} - ` : ''}Unexpected commit scope: '${conventionalSubject.scope}'`);
+            console.warn(`[WARN] ${commit.hash ? `${commit.hash.substring(0, 7)} - ` : ''}Unexpected commit scope: '${conventionalSubject.scope}'`);
         }
 
         return conventionalSubject;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-conventional-commits",
-  "version": "2.7.2",
+  "version": "2.8.0",
   "description": "git conventional commits util",
   "licence": "GPLv3",
   "main": "cli.js",