feat(noteKeywords): make BREAKING CHANGE more forgiving

People might type BREAKING CHANGES unintentionally. EG: angular/angular@098b461
Hipo · Mar 5, 2017 · 283b223 · 283b223
1 parent 28427c6
commit 283b223
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/index.js b/index.js
@@ -22,7 +22,7 @@ var parserOpts = {
     'scope',
     'subject'
   ],
-  noteKeywords: 'BREAKING CHANGE',
+  noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES'],
   revertPattern: /^revert:\s([\s\S]*?)\s*This reverts commit (\w*)\./,
   revertCorrespondence: ['header', 'hash']
 };

diff --git a/test/test.js b/test/test.js
@@ -121,6 +121,24 @@ describe('angular preset', function() {
       }));
   });
 
+  it('should BREAKING CHANGES the same as BREAKING CHANGE', function(done) {
+    gitDummyCommit(['feat(deps): bump', 'BREAKING CHANGES: Also works :)']);
+
+    conventionalChangelogCore({
+      config: preset
+    })
+      .on('error', function(err) {
+        done(err);
+      })
+      .pipe(through(function(chunk) {
+        chunk = chunk.toString();
+
+        expect(chunk).to.include('Also works :)');
+
+        done();
+      }));
+  });
+
   it('should work if there is a semver tag', function(done) {
     var i = 0;
 
@@ -173,5 +191,4 @@ describe('angular preset', function() {
         done();
       }));
   });
-
 });