fix: if ! and BREAKING CHANGE were used, notes would populate twice (#…

…446)
conventional-changelog · May 5, 2019 · 63d8cbe · 63d8cbe
1 parent 2b8f1cd
commit 63d8cbe
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/packages/conventional-changelog-conventionalcommits/add-bang-notes.js b/packages/conventional-changelog-conventionalcommits/add-bang-notes.js
@@ -2,7 +2,7 @@ const { breakingHeaderPattern } = require('./parser-opts')()
 
 module.exports = (commit) => {
   const match = commit.header.match(breakingHeaderPattern)
-  if (match) {
+  if (match && commit.notes.length === 0) {
     const noteText = match[3] // the description of the change.
     commit.notes.push({
       text: noteText

diff --git a/packages/conventional-changelog-conventionalcommits/test/test.js b/packages/conventional-changelog-conventionalcommits/test/test.js
@@ -22,7 +22,7 @@ betterThanBefore.setups([
     shell.mkdir('git-templates')
     shell.exec('git init --template=./git-templates')
 
-    gitDummyCommit(['build: first build setup', 'BREAKING CHANGE: New build system.'])
+    gitDummyCommit(['build!: first build setup', 'BREAKING CHANGE: New build system.'])
     gitDummyCommit(['ci(travis): add TravisCI pipeline', 'BREAKING CHANGE: Continuously integrated.'])
     gitDummyCommit(['Feat: amazing new module', 'BREAKING CHANGE: Not backward compatible.'])
     gitDummyCommit(['Fix(compile): avoid a bug', 'BREAKING CHANGE: The Change is huge.'])
@@ -113,6 +113,22 @@ describe('conventionalcommits.org preset', function () {
       }))
   })
 
+  it('should not list breaking change twice if ! is used', function (done) {
+    preparing(1)
+
+    conventionalChangelogCore({
+      config: preset
+    })
+      .on('error', function (err) {
+        done(err)
+      })
+      .pipe(through(function (chunk) {
+        chunk = chunk.toString()
+        expect(chunk).to.not.match(/\* first build setup\r?\n/)
+        done()
+      }))
+  })
+
   it('should allow alternative "types" configuration to be provided', function (done) {
     preparing(1)
     conventionalChangelogCore({
@@ -432,7 +448,7 @@ describe('conventionalcommits.org preset', function () {
       })
       .pipe(through(function (chunk) {
         chunk = chunk.toString()
-        expect(chunk).to.match(/incredible new flag FIXES: #33\n/)
+        expect(chunk).to.match(/incredible new flag FIXES: #33\r?\n/)
         done()
       }))
   })