feat(conventional-commits-parser): add flag to enable/disable multiple-scopes (default: enabled)

packages/conventional-commits-parser/src/CommitParser.spec.ts

@@ -90,6 +90,34 @@ describe('conventional-commits-parser', () => {
         expect(result.scope).toBe('hello/world')
         expect(result.subject).toBe('message')
       })
+
+      it('should parse scopes with delimiters when default isEnableMultipleScopes and scopeDelimitersPattern option', () => {
+        const commitsWithScopeDelimiters = [
+          {
+            commit: 'feat(hello/world): message',
+            parsedScore: 'hello/world'
+          },
+          {
+            commit: 'feat(hello\\world): message',
+            parsedScore: 'hello\\world'
+          },
+          {
+            commit: 'feat(hello,world): message',
+            parsedScore: 'hello,world'
+          },
+          {
+            commit: 'feat(hello, world): message',
+            parsedScore: 'hello, world'
+          }
+        ]
+
+        Object.values(commitsWithScopeDelimiters).forEach(({ commit, parsedScore }) => {
+          const result = parser.parse(commit)
+
+          expect(result.scope).toBe(parsedScore)
+          expect(result.scopes).toEqual(['hello', 'world'])
+        })
+      })
     })
 
     describe('custom options', () => {
@@ -257,6 +285,37 @@ describe('conventional-commits-parser', () => {
 
         expect(commit.body).toBe('this is some body before a scissors-line')
       })
+
+      it('should not parse scopes with delimiters when isEnableMultipleScopes is false', () => {
+        const parser = new CommitParser({
+          isEnableMultipleScopes: false
+        })
+        const commitsWithScopeDelimiters = [
+          {
+            commit: 'feat(hello/world): message',
+            parsedScore: 'hello/world'
+          },
+          {
+            commit: 'feat(hello\\world): message',
+            parsedScore: 'hello\\world'
+          },
+          {
+            commit: 'feat(hello,world): message',
+            parsedScore: 'hello,world'
+          },
+          {
+            commit: 'feat(hello, world): message',
+            parsedScore: 'hello, world'
+          }
+        ]
+
+        Object.values(commitsWithScopeDelimiters).forEach(({ commit, parsedScore }) => {
+          const result = parser.parse(commit)
+
+          expect(result.scope).toBe(parsedScore)
+          expect(result.scopes).toBeUndefined()
+        })
+      })
     })
 
     describe('comments', () => {

packages/conventional-commits-parser/src/CommitParser.ts

@@ -388,6 +388,20 @@ export class CommitParser {
     })
   }
 
+  private parseScopes() {
+    const { commit, options: { isEnableMultipleScopes, scopeDelimitersPattern } } = this
+
+    if (!isEnableMultipleScopes || !scopeDelimitersPattern || !commit.scope) {
+      return
+    }
+
+    const messageScopes = commit.scope.split(scopeDelimitersPattern)
+
+    if (messageScopes.length > 1) {
+      commit.scopes = messageScopes
+    }
+  }
+
   /**
    * Parse commit message string into an object.
    * @param input - Commit message string.
@@ -432,6 +446,7 @@ export class CommitParser {
     this.parseBreakingHeader()
     this.parseMentions(input)
     this.parseRevert(input)
+    this.parseScopes()
     this.cleanupCommit()
 
     return commit

packages/conventional-commits-parser/src/options.ts

@@ -14,13 +14,15 @@ export const defaultOptions: ParserOptions = {
     'resolves',
     'resolved'
   ],
-  headerPattern: /^(\w*)(?:\(([\w$.\-*/ ]*)\))?: (.*)$/,
+  headerPattern: /^(\w*)(?:\(([\w$.\-*/\\, ]*)\))?: (.*)$/,
   headerCorrespondence: [
     'type',
     'scope',
     'subject'
   ],
   revertPattern: /^Revert\s"([\s\S]*)"\s*This reverts commit (\w*)\./,
   revertCorrespondence: ['header', 'hash'],
-  fieldPattern: /^-(.*?)-$/
+  fieldPattern: /^-(.*?)-$/,
+  isEnableMultipleScopes: true,
+  scopeDelimitersPattern: /\/|\\|, ?/g
 }

packages/conventional-commits-parser/src/types.ts

@@ -58,6 +58,16 @@ export interface ParserOptions {
    * Keywords to reference an issue. This value is case **insensitive**.
    */
   referenceActions?: string[]
+  /**
+   * Used to determine whether to separate scopes by slash or comma delimiters contain in scope.
+   * The default value of isEnableMultipleScopes is true.
+   */
+  isEnableMultipleScopes?: boolean
+  /**
+   * RegExp used to separate scopes.
+   * The default value of scopeDelimitersPattern is `/\/|\\|, ?/g`.
+   */
+  scopeDelimitersPattern?: RegExp
 }
 
 export interface ParserStreamOptions extends ParserOptions {
@@ -99,6 +109,7 @@ export interface CommitBase {
   notes: CommitNote[]
   mentions: string[]
   references: CommitReference[]
+  scopes: string[]
 }
 
 export type Commit = CommitBase & CommitMeta