feat: change cli config commits structure

Author: zdm

lib/commands/git/commit-msg.js

@@ -79,17 +79,25 @@ git commit -m"feat(core)!: commit description"
                 return this.#throwError( `Commit message subject should not ends with ".".` );
             }
 
-            const type = pkg.cliConfig?.commits.types[ commit.type ],
-                scopes = new Set( pkg.cliConfig?.commits[ type?.primaryChange
+            const type = pkg.cliConfig?.commits.types[ commit.type ] || null,
+                scopes = new Set( Object.entries( pkg.cliConfig?.commits[ type?.primaryChange
                     ? "primaryScopes"
-                    : "secondaryScopes" ] || [] );
+                    : "secondaryScopes" ] || {} )
+                    .map( ( [ key, value ] ) => ( value
+                        ? key
+                        : null ) )
+                    .filter( item => item ) );
 
             // 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: ${ Object.keys( pkg.cliConfig.commits.types )
+                    return this.#throwError( `Commit type is not valid. Allowed types: ${ Object.entries( pkg.cliConfig.commits.types )
+                        .map( ( key, value ) => ( value
+                            ? key
+                            : null ) )
+                        .filter( item => item )
                         .sort()
                         .map( item => `"${ item }"` )
                         .join( ", " ) }.` );

lib/git/changelog.js

@@ -164,6 +164,13 @@ export default class GitChangelog {
     #indexChanges ( commitTypes ) {
         this.#changesGroups = [];
 
+        // remove disabled commit types
+        commitTypes = Object.entries( commitTypes ).reduce( ( commitTypes, [ key, value ] ) => {
+            if ( value ) commitTypes[ key ] = value;
+
+            return commitTypes;
+        }, {} );
+
         // index primary types
         const primaryTypes = new Map();
 

resources/cli.config.yaml

@@ -83,6 +83,12 @@ commits:
 
   primaryScopes: ~
 
-  secondaryScopes: [build, deps, docs, metadata, release, style]
+  secondaryScopes:
+    build: Package build related changes
+    deps: Package dependencies updates
+    docs: Documentation changes
+    metadata: Package metadata changes
+    release: Package release
+    style: Code stylistic changes
 
 docs: ~

resources/schemas/cli.config.schema.yaml

@@ -151,25 +151,37 @@ properties:
         type: object
         propertyNames: { type: string, format: kebab-case }
         additionalProperties:
-          type: object
-          properties:
-            title: { type: string }
-            primaryChange: { type: boolean }
-            notableChange: { type: boolean }
-            requireScope: { type: boolean }
-            strictScope: { type: boolean }
-          additionalProperties: false
-          required: [primaryChange, notableChange, requireScope, strictScope]
+          anyOf:
+            - const: false
+            - type: object
+              properties:
+                title: { type: string }
+                primaryChange: { type: boolean }
+                notableChange: { type: boolean }
+                requireScope: { type: boolean }
+                strictScope: { type: boolean }
+              additionalProperties: false
+              required: [primaryChange, notableChange, requireScope, strictScope]
 
       primaryScopes:
         anyOf:
           - type: "null"
-          - { type: array, items: { type: string, format: kebab-case }, minItems: 1, uniqueItems: true }
+          - type: object
+            propertyNames: { type: string, format: kebab-case }
+            additionalProperties:
+              anyOf:
+                - const: false
+                - type: string
 
       secondaryScopes:
         anyOf:
           - type: "null"
-          - { type: array, items: { type: string, format: kebab-case }, minItems: 1, uniqueItems: true }
+          - type: object
+            propertyNames: { type: string, format: kebab-case }
+            additionalProperties:
+              anyOf:
+                - const: false
+                - type: string
 
     additionalProperties: false
     required: [requireType, strictType, types, primaryScopes, secondaryScopes]