fix: support BREAKING-CHANGE alongside BREAKING CHANGE (#882)

conventional-changelog · Dec 29, 2021 · e6f44ad · e6f44ad
1 parent b2245a7
commit e6f44ad
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 7 deletions.
diff --git a/packages/conventional-changelog-conventionalcommits/parser-opts.js b/packages/conventional-changelog-conventionalcommits/parser-opts.js
@@ -10,7 +10,7 @@ module.exports = function (config) {
       'scope',
       'subject'
     ],
-    noteKeywords: ['BREAKING CHANGE'],
+    noteKeywords: ['BREAKING CHANGE', 'BREAKING-CHANGE'],
     revertPattern: /^(?:Revert|revert:)\s"?([\s\S]+?)"?\s*This reverts commit (\w*)\./i,
     revertCorrespondence: ['header', 'hash'],
     issuePrefixes: config.issuePrefixes

diff --git a/packages/conventional-commits-parser/README.md b/packages/conventional-commits-parser/README.md
@@ -201,7 +201,8 @@ Used to define if `issuePrefixes` should be considered case sensitive.
 
 ##### noteKeywords
 
-Type: `array` of `string` or `string` Default: `['BREAKING CHANGE']`
+Type: `array` of `string` or `string` Default: `['BREAKING CHANGE',
+'BREAKING-CHANGE']`
 
 Keywords for important notes. This value is case **insensitive**. If it's a `string` it will be converted to an `array` separated by a comma.
 

diff --git a/packages/conventional-commits-parser/index.js b/packages/conventional-commits-parser/index.js
@@ -21,7 +21,7 @@ function assignOpts (options) {
       'resolved'
     ],
     issuePrefixes: ['#'],
-    noteKeywords: ['BREAKING CHANGE'],
+    noteKeywords: ['BREAKING CHANGE', 'BREAKING-CHANGE'],
     fieldPattern: /^-(.*?)-$/,
     revertPattern: /^Revert\s"([\s\S]*)"\s*This reverts commit (\w*)\./,
     revertCorrespondence: ['header', 'hash'],

diff --git a/packages/conventional-commits-parser/test/parser.spec.js b/packages/conventional-commits-parser/test/parser.spec.js
@@ -688,7 +688,7 @@ describe('parser', function () {
       const text = expectedText +
           '\n' +
           'Closes #9462'
-      options.noteKeywords = ['BREAKING CHANGE']
+      options.noteKeywords = ['BREAKING CHANGE', 'BREAKING-CHANGE']
       reg = regex(options)
       const msg = parser(
         'fix(core): report duplicate template bindings in templates\n' +
@@ -710,7 +710,7 @@ describe('parser', function () {
     })
 
     it('should not treat it as important notes if there are texts after `noteKeywords`', function () {
-      options.noteKeywords = ['BREAKING CHANGE']
+      options.noteKeywords = ['BREAKING CHANGE', 'BREAKING-CHANGE']
       reg = regex(options)
       const msg = parser(
         'fix(core): report duplicate template bindings in templates\n' +

diff --git a/packages/conventional-commits-parser/test/regex.spec.js b/packages/conventional-commits-parser/test/regex.spec.js
@@ -20,7 +20,7 @@ describe('regex', function () {
 
     it('should match notes with customized pattern', function () {
       const reNotes = regex({
-        noteKeywords: ['BREAKING CHANGE'],
+        noteKeywords: ['BREAKING CHANGE', 'BREAKING-CHANGE'],
         notesPattern: (noteKeywords) => new RegExp('^[\\s|*]*(' + noteKeywords + ')[:\\s]+(?:\\[.*\\] )(.*)', 'i')
       }).notes
       const notes = 'BREAKING CHANGE: [Do not match this prefix.] This is so important.'
@@ -62,7 +62,7 @@ describe('regex', function () {
 
     it('should not match if there is text after `noteKeywords`', function () {
       const reNotes = regex({
-        noteKeywords: [' BREAKING CHANGE'],
+        noteKeywords: ['BREAKING CHANGE', 'BREAKING-CHANGE'],
         issuePrefixes: ['#']
       }).notes
       const match = 'BREAKING CHANGES: Wow.'.match(reNotes)