Skip to content

Commit

Permalink
fix: ignore gpg lines (#685)
Browse files Browse the repository at this point in the history
  • Loading branch information
bernot-dev authored Oct 25, 2020
1 parent be1246c commit f8fcbc2
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 1 deletion.
3 changes: 2 additions & 1 deletion packages/conventional-commits-parser/lib/parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,10 @@ function parser (raw, options, regex) {
var commentFilter = typeof options.commentChar === 'string'
? getCommentFilter(options.commentChar)
: passTrough
var gpgFilter = line => !line.match(/^\s*gpg:/)

var rawLines = trimOffNewlines(raw).split(/\r?\n/)
var lines = truncateToScissor(rawLines).filter(commentFilter)
var lines = truncateToScissor(rawLines).filter(commentFilter).filter(gpgFilter)

var continueNote = false
var isBody = true
Expand Down
37 changes: 37 additions & 0 deletions packages/conventional-commits-parser/test/parser.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,43 @@ describe('parser', function () {
})
})

it('should ignore gpg signature lines', function () {
expect(parser(
'gpg: Signature made Thu Oct 22 12:19:30 2020 EDT\n' +
'gpg: using RSA key ABCDEF1234567890\n' +
'gpg: Good signature from "Author <[email protected]>" [ultimate]\n' +
'feat(scope): broadcast $destroy event on scope destruction\n' +
'perf testing shows that in chrome this change adds 5-15% overhead\n' +
'when destroying 10k nested scopes where each scope has a $destroy listener\n' +
'BREAKING AMEND: some breaking change\n' +
'Kills #1\n',
options,
reg
)).to.eql({
merge: null,
header: 'feat(scope): broadcast $destroy event on scope destruction',
body: 'perf testing shows that in chrome this change adds 5-15% overhead\nwhen destroying 10k nested scopes where each scope has a $destroy listener',
footer: 'BREAKING AMEND: some breaking change\nKills #1',
notes: [{
title: 'BREAKING AMEND',
text: 'some breaking change'
}],
references: [{
action: 'Kills',
owner: null,
repository: null,
issue: '1',
raw: '#1',
prefix: '#'
}],
mentions: ['example'],
revert: null,
scope: 'scope',
subject: 'broadcast $destroy event on scope destruction',
type: 'feat'
})
})

it('should ignore comments according to commentChar', function () {
var commentOptions = _.assign({}, options, { commentChar: '#' })

Expand Down

0 comments on commit f8fcbc2

Please sign in to comment.