conventional-commits-parser 3.0.6 → 3.2.0

package/CHANGELOG.md

@@ -3,6 +3,63 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.2.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-commits-parser@3.1.0...conventional-commits-parser@3.2.0) (2020-11-05)
+
+
+### Bug Fixes
+
+* ignore gpg lines ([#685](https://github.com/conventional-changelog/conventional-changelog/issues/685)) ([f8fcbc2](https://github.com/conventional-changelog/conventional-changelog/commit/f8fcbc2e8b0834c29178ace6382b438a020ad828))
+* **deps:** update dependency through2 to v4 ([#657](https://github.com/conventional-changelog/conventional-changelog/issues/657)) ([7ae618c](https://github.com/conventional-changelog/conventional-changelog/commit/7ae618c81491841e5b1d796d3933aac0c54bc312))
+
+
+### Features
+
+* allows notes pattern to be customized ([#586](https://github.com/conventional-changelog/conventional-changelog/issues/586)) ([9c00f32](https://github.com/conventional-changelog/conventional-changelog/commit/9c00f3242d916be1774a618d943f908f8d9699a6))
+
+
+
+
+
+# [3.1.0](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-commits-parser@3.0.8...conventional-commits-parser@3.1.0) (2020-05-08)
+
+
+### Bug Fixes
+
+* **deps:** update yargs-parser to move off a flagged-vulnerable version. ([#635](https://github.com/conventional-changelog/conventional-changelog/issues/635)) ([aafc0f0](https://github.com/conventional-changelog/conventional-changelog/commit/aafc0f00412c3e4b23b8418300e5a570a48fe24d))
+
+
+### Features
+
+* **conventional-commits-parser:** add issuePrefixesCaseSensitive parser option ([#580](https://github.com/conventional-changelog/conventional-changelog/issues/580)) ([526b282](https://github.com/conventional-changelog/conventional-changelog/commit/526b28214d12c55158eb2e4d44408378587ceb97))
+* support slash in headerPattern default options ([93a547d](https://github.com/conventional-changelog/conventional-changelog/commit/93a547d742634d8676f499cfa2a274bc3792d020))
+
+
+
+
+
+## [3.0.8](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-commits-parser@3.0.7...conventional-commits-parser@3.0.8) (2019-11-14)
+
+
+### Bug Fixes
+
+* add types for cli flags ([#551](https://github.com/conventional-changelog/conventional-changelog/issues/551)) ([bf1d64a](https://github.com/conventional-changelog/conventional-changelog/commit/bf1d64aeaf8f262d4b2beec02d2aebb78df7343b))
+
+
+
+
+
+## [3.0.7](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-commits-parser@3.0.6...conventional-commits-parser@3.0.7) (2019-11-07)
+
+
+### Bug Fixes
+
+* **conventional-commits-parser:** add breaking change notes if header match `breakingHeaderPattern` ([#544](https://github.com/conventional-changelog/conventional-changelog/issues/544)) ([efdf3cb](https://github.com/conventional-changelog/conventional-changelog/commit/efdf3cbc9de3278b180a48beebb74e596e3c5f94))
+* **conventional-commits-parser:** add missing separator pipe to non tty parser ([#546](https://github.com/conventional-changelog/conventional-changelog/issues/546)) ([c522743](https://github.com/conventional-changelog/conventional-changelog/commit/c5227437b0b300f30a57e8ba5df2a8ab8d163af0))
+
+
+
+
+
 ## [3.0.6](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-commits-parser@3.0.5...conventional-commits-parser@3.0.6) (2019-10-24)
 
 

package/README.md

@@ -193,12 +193,24 @@ Type: `array` of `string` or `string` Default: `['#']`
 
 The prefixes of an issue. EG: In `gh-123` `gh-` is the prefix.
 
+##### issuePrefixesCaseSensitive
+
+Type: `boolean` Default: false
+
+Used to define if `issuePrefixes` should be considered case sensitive.
+
 ##### noteKeywords
 
 Type: `array` of `string` or `string` Default: `['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.
 
+##### notesPattern
+
+Type: `function` Default: `noteKeywordsSelection => ^[\\s|*]*(' + noteKeywordsSelection + ')[:\\s]+(.*)` where `noteKeywordsSelection` is `join(noteKeywords, '|')`
+
+A function that takes `noteKeywordsSelection` and returns a `RegExp` to be matched against the notes.
+
 ##### fieldPattern
 
 Type: `regex` or `string` Default: `/^-(.*?)-$/`

package/cli.js

@@ -1,19 +1,19 @@
 #!/usr/bin/env node
 'use strict'
-var conventionalCommitsParser = require('./')
-var forEach = require('lodash').forEach
-var fs = require('fs')
-var isTextPath = require('is-text-path')
-var JSONStream = require('JSONStream')
-var meow = require('meow')
-var readline = require('readline')
-var split = require('split2')
-var through = require('through2')
+const conventionalCommitsParser = require('./')
+const forEach = require('lodash').forEach
+const fs = require('fs')
+const isTextPath = require('is-text-path')
+const JSONStream = require('JSONStream')
+const meow = require('meow')
+const readline = require('readline')
+const split = require('split2')
+const through = require('through2')
 
-var filePaths = []
-var separator = '\n\n\n'
+const filePaths = []
+let separator = '\n\n\n'
 
-var cli = meow(`
+const cli = meow(`
     Practice writing commit messages or parse messages from files.
     If used without specifying a text file path, you will enter an interactive shell.
     Otherwise the commit messages in the files are parsed and printed
@@ -31,37 +31,54 @@ var cli = meow(`
       conventional-commits-parser log2.txt '===' >> parsed.txt
 
     Options
-      -p, --header-pattern           Regex to match header pattern
-      -c, --header-correspondence    Comma separated parts used to define what capturing group of 'headerPattern' captures what
-      -r, --reference-actions        Comma separated keywords that used to reference issues
-      -i, --issue-prefixes           Comma separated prefixes of an issue
-      -n, --note-keywords            Comma separated keywords for important notes
-      -f, --field-pattern            Regex to match other fields
-      --revert-pattern               Regex to match revert pattern
-      --revert-correspondence        Comma separated fields used to define what the commit reverts
-      -v, --verbose                  Verbose output
+      -p, --header-pattern              Regex to match header pattern
+      -c, --header-correspondence       Comma separated parts used to define what capturing group of 'headerPattern' captures what
+      -r, --reference-actions           Comma separated keywords that used to reference issues
+      -i, --issue-prefixes              Comma separated prefixes of an issue
+      --issue-prefixes-case-sensitive   Treat issue prefixes as case sensitive
+      -n, --note-keywords               Comma separated keywords for important notes
+      -f, --field-pattern               Regex to match other fields
+      --revert-pattern                  Regex to match revert pattern
+      --revert-correspondence           Comma separated fields used to define what the commit reverts
+      -v, --verbose                     Verbose output
 `, {
   flags: {
     'header-pattern': {
-      alias: `p`
+      alias: 'p',
+      type: 'string'
     },
     'header-correspondence': {
-      alias: `c`
+      alias: 'c',
+      type: 'string'
     },
     'reference-actions': {
-      alias: `r`
+      alias: 'r',
+      type: 'string'
     },
     'issue-prefixes': {
-      alias: `i`
+      alias: 'i',
+      type: 'string'
+    },
+    'issue-prefixes-case-sensitive': {
+      type: 'boolean'
     },
     'note-keywords': {
-      alias: `n`
+      alias: 'n',
+      type: 'string'
     },
     'field-pattern': {
-      alias: `f`
+      alias: 'f',
+      type: 'string'
+    },
+    'revert-pattern': {
+      type: 'string'
+    },
+    'revert-correspondence': {
+      type: 'string'
     },
     verbose: {
-      alias: `v`
+      alias: 'v',
+      type: 'boolean'
     }
   }
 })
@@ -74,15 +91,15 @@ forEach(cli.input, function (arg) {
   }
 })
 
-var length = filePaths.length
-var options = cli.flags
+const length = filePaths.length
+const options = cli.flags
 
 if (options.verbose) {
   options.warn = console.log.bind(console)
 }
 
 function processFile (fileIndex) {
-  var filePath = filePaths[fileIndex]
+  const filePath = filePaths[fileIndex]
   fs.createReadStream(filePath)
     .on('error', function (err) {
       console.warn('Failed to read file ' + filePath + '\n' + err)
@@ -105,9 +122,9 @@ if (process.stdin.isTTY) {
   if (length > 0) {
     processFile(0)
   } else {
-    var commit = ''
-    var stream = through()
-    var rl = readline.createInterface({
+    let commit = ''
+    const stream = through()
+    const rl = readline.createInterface({
       input: process.stdin,
       output: process.stdout,
       terminal: true
@@ -137,6 +154,7 @@ if (process.stdin.isTTY) {
 } else {
   options.warn = true
   process.stdin
+    .pipe(split(separator))
     .pipe(conventionalCommitsParser(options))
     .on('error', function (err) {
       console.error(err.toString())

package/index.js

@@ -1,13 +1,13 @@
 'use strict'
 
-var parser = require('./lib/parser')
-var regex = require('./lib/regex')
-var through = require('through2')
-var _ = require('lodash')
+const parser = require('./lib/parser')
+const regex = require('./lib/regex')
+const through = require('through2')
+const _ = require('lodash')
 
 function assignOpts (options) {
   options = _.extend({
-    headerPattern: /^(\w*)(?:\(([\w$.\-* ]*)\))?: (.*)$/,
+    headerPattern: /^(\w*)(?:\(([\w$.\-*/ ]*)\))?: (.*)$/,
     headerCorrespondence: ['type', 'scope', 'subject'],
     referenceActions: [
       'close',
@@ -71,10 +71,10 @@ function assignOpts (options) {
 
 function conventionalCommitsParser (options) {
   options = assignOpts(options)
-  var reg = regex(options)
+  const reg = regex(options)
 
   return through.obj(function (data, enc, cb) {
-    var commit
+    let commit
 
     try {
       commit = parser(data.toString(), options, reg)
@@ -92,7 +92,7 @@ function conventionalCommitsParser (options) {
 
 function sync (commit, options) {
   options = assignOpts(options)
-  var reg = regex(options)
+  const reg = regex(options)
 
   return parser(commit, options, reg)
 }

package/lib/parser.js

@@ -1,9 +1,9 @@
 'use strict'
-var trimOffNewlines = require('trim-off-newlines')
-var _ = require('lodash')
+const trimOffNewlines = require('trim-off-newlines')
+const _ = require('lodash')
 
-var CATCH_ALL = /()(.+)/gi
-var SCISSOR = '# ------------------------ >8 ------------------------'
+const CATCH_ALL = /()(.+)/gi
+const SCISSOR = '# ------------------------ >8 ------------------------'
 
 function append (src, line) {
   if (src) {
@@ -22,7 +22,7 @@ function getCommentFilter (char) {
 }
 
 function truncateToScissor (lines) {
-  var scissorIndex = lines.indexOf(SCISSOR)
+  const scissorIndex = lines.indexOf(SCISSOR)
 
   if (scissorIndex === -1) {
     return lines
@@ -32,29 +32,29 @@ function truncateToScissor (lines) {
 }
 
 function getReferences (input, regex) {
-  var references = []
-  var referenceSentences
-  var referenceMatch
+  const references = []
+  let referenceSentences
+  let referenceMatch
 
-  var reApplicable = input.match(regex.references) !== null
+  const reApplicable = input.match(regex.references) !== null
     ? regex.references
     : CATCH_ALL
 
   while ((referenceSentences = reApplicable.exec(input))) {
-    var action = referenceSentences[1] || null
-    var sentence = referenceSentences[2]
+    const action = referenceSentences[1] || null
+    const sentence = referenceSentences[2]
 
     while ((referenceMatch = regex.referenceParts.exec(sentence))) {
-      var owner = null
-      var repository = referenceMatch[1] || ''
-      var ownerRepo = repository.split('/')
+      let owner = null
+      let repository = referenceMatch[1] || ''
+      const ownerRepo = repository.split('/')
 
       if (ownerRepo.length > 1) {
         owner = ownerRepo.shift()
         repository = ownerRepo.join('/')
       }
 
-      var reference = {
+      const reference = {
         action: action,
         owner: owner,
         repository: repository || null,
@@ -87,39 +87,37 @@ function parser (raw, options, regex) {
     throw new TypeError('Expected regex')
   }
 
-  var headerMatch
-  var mergeMatch
-  var currentProcessedField
-  var mentionsMatch
-  var revertMatch
-  var otherFields = {}
-  var commentFilter = typeof options.commentChar === 'string'
+  let currentProcessedField
+  let mentionsMatch
+  const otherFields = {}
+  const commentFilter = typeof options.commentChar === 'string'
     ? getCommentFilter(options.commentChar)
     : passTrough
+  const gpgFilter = line => !line.match(/^\s*gpg:/)
 
-  var rawLines = trimOffNewlines(raw).split(/\r?\n/)
-  var lines = truncateToScissor(rawLines).filter(commentFilter)
+  const rawLines = trimOffNewlines(raw).split(/\r?\n/)
+  const lines = truncateToScissor(rawLines).filter(commentFilter).filter(gpgFilter)
 
-  var continueNote = false
-  var isBody = true
-  var headerCorrespondence = _.map(options.headerCorrespondence, function (part) {
+  let continueNote = false
+  let isBody = true
+  const headerCorrespondence = _.map(options.headerCorrespondence, function (part) {
     return part.trim()
   })
-  var revertCorrespondence = _.map(options.revertCorrespondence, function (field) {
+  const revertCorrespondence = _.map(options.revertCorrespondence, function (field) {
     return field.trim()
   })
-  var mergeCorrespondence = _.map(options.mergeCorrespondence, function (field) {
+  const mergeCorrespondence = _.map(options.mergeCorrespondence, function (field) {
     return field.trim()
   })
 
-  var body = null
-  var footer = null
-  var header = null
-  var mentions = []
-  var merge = null
-  var notes = []
-  var references = []
-  var revert = null
+  let body = null
+  let footer = null
+  let header = null
+  const mentions = []
+  let merge = null
+  const notes = []
+  const references = []
+  let revert = null
 
   if (lines.length === 0) {
     return {
@@ -139,12 +137,12 @@ function parser (raw, options, regex) {
 
   // msg parts
   merge = lines.shift()
-  var mergeParts = {}
-  var headerParts = {}
+  const mergeParts = {}
+  const headerParts = {}
   body = ''
   footer = ''
 
-  mergeMatch = merge.match(options.mergePattern)
+  const mergeMatch = merge.match(options.mergePattern)
   if (mergeMatch && options.mergePattern) {
     merge = mergeMatch[0]
 
@@ -154,7 +152,7 @@ function parser (raw, options, regex) {
     }
 
     _.forEach(mergeCorrespondence, function (partName, index) {
-      var partValue = mergeMatch[index + 1] || null
+      const partValue = mergeMatch[index + 1] || null
       mergeParts[partName] = partValue
     })
   } else {
@@ -166,10 +164,10 @@ function parser (raw, options, regex) {
     })
   }
 
-  headerMatch = header.match(options.headerPattern)
+  const headerMatch = header.match(options.headerPattern)
   if (headerMatch) {
     _.forEach(headerCorrespondence, function (partName, index) {
-      var partValue = headerMatch[index + 1] || null
+      const partValue = headerMatch[index + 1] || null
       headerParts[partName] = partValue
     })
   } else {
@@ -186,7 +184,7 @@ function parser (raw, options, regex) {
   // body or footer
   _.forEach(lines, function (line) {
     if (options.fieldPattern) {
-      var fieldMatch = options.fieldPattern.exec(line)
+      const fieldMatch = options.fieldPattern.exec(line)
 
       if (fieldMatch) {
         currentProcessedField = fieldMatch[1]
@@ -201,16 +199,16 @@ function parser (raw, options, regex) {
       }
     }
 
-    var referenceMatched
+    let referenceMatched
 
     // this is a new important note
-    var notesMatch = line.match(regex.notes)
+    const notesMatch = line.match(regex.notes)
     if (notesMatch) {
       continueNote = true
       isBody = false
       footer = append(footer, line)
 
-      var note = {
+      const note = {
         title: notesMatch[1],
         text: notesMatch[2]
       }
@@ -220,7 +218,7 @@ function parser (raw, options, regex) {
       return
     }
 
-    var lineReferences = getReferences(line, {
+    const lineReferences = getReferences(line, {
       references: regex.references,
       referenceParts: regex.referenceParts
     })
@@ -253,16 +251,27 @@ function parser (raw, options, regex) {
     }
   })
 
+  if (options.breakingHeaderPattern && notes.length === 0) {
+    const breakingHeader = header.match(options.breakingHeaderPattern)
+    if (breakingHeader) {
+      const noteText = breakingHeader[3] // the description of the change.
+      notes.push({
+        title: 'BREAKING CHANGE',
+        text: noteText
+      })
+    }
+  }
+
   while ((mentionsMatch = regex.mentions.exec(raw))) {
     mentions.push(mentionsMatch[1])
   }
 
   // does this commit revert any other commit?
-  revertMatch = raw.match(options.revertPattern)
+  const revertMatch = raw.match(options.revertPattern)
   if (revertMatch) {
     revert = {}
     _.forEach(revertCorrespondence, function (partName, index) {
-      var partValue = revertMatch[index + 1] || null
+      const partValue = revertMatch[index + 1] || null
       revert[partName] = partValue
     })
   } else {
@@ -275,7 +284,7 @@ function parser (raw, options, regex) {
     return note
   })
 
-  var msg = _.merge(headerParts, mergeParts, {
+  const msg = _.merge(headerParts, mergeParts, {
     merge: merge,
     header: header,
     body: body ? trimOffNewlines(body) : null,

package/lib/regex.js

@@ -1,6 +1,6 @@
 'use strict'
 
-var reNomatch = /(?!.*)/
+const reNomatch = /(?!.*)/
 
 function join (array, joiner) {
   return array
@@ -13,20 +13,27 @@ function join (array, joiner) {
     .join(joiner)
 }
 
-function getNotesRegex (noteKeywords) {
+function getNotesRegex (noteKeywords, notesPattern) {
   if (!noteKeywords) {
     return reNomatch
   }
 
-  return new RegExp('^[\\s|*]*(' + join(noteKeywords, '|') + ')[:\\s]+(.*)', 'i')
+  const noteKeywordsSelection = join(noteKeywords, '|')
+
+  if (!notesPattern) {
+    return new RegExp('^[\\s|*]*(' + noteKeywordsSelection + ')[:\\s]+(.*)', 'i')
+  }
+
+  return notesPattern(noteKeywordsSelection)
 }
 
-function getReferencePartsRegex (issuePrefixes) {
+function getReferencePartsRegex (issuePrefixes, issuePrefixesCaseSensitive) {
   if (!issuePrefixes) {
     return reNomatch
   }
 
-  return new RegExp('(?:.*?)??\\s*([\\w-\\.\\/]*?)??(' + join(issuePrefixes, '|') + ')([\\w-]*\\d+)', 'gi')
+  const flags = issuePrefixesCaseSensitive ? 'g' : 'gi'
+  return new RegExp('(?:.*?)??\\s*([\\w-\\.\\/]*?)??(' + join(issuePrefixes, '|') + ')([\\w-]*\\d+)', flags)
 }
 
 function getReferencesRegex (referenceActions) {
@@ -35,15 +42,15 @@ function getReferencesRegex (referenceActions) {
     return /()(.+)/gi
   }
 
-  var joinedKeywords = join(referenceActions, '|')
+  const joinedKeywords = join(referenceActions, '|')
   return new RegExp('(' + joinedKeywords + ')(?:\\s+(.*?))(?=(?:' + joinedKeywords + ')|$)', 'gi')
 }
 
 module.exports = function (options) {
   options = options || {}
-  var reNotes = getNotesRegex(options.noteKeywords)
-  var reReferenceParts = getReferencePartsRegex(options.issuePrefixes)
-  var reReferences = getReferencesRegex(options.referenceActions)
+  const reNotes = getNotesRegex(options.noteKeywords, options.notesPattern)
+  const reReferenceParts = getReferencePartsRegex(options.issuePrefixes, options.issuePrefixesCaseSensitive)
+  const reReferences = getReferencesRegex(options.referenceActions)
 
   return {
     notes: reNotes,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conventional-commits-parser",
-  "version": "3.0.6",
+  "version": "3.2.0",
   "description": "Parse raw conventional commits",
   "bugs": {
     "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
@@ -17,7 +17,7 @@
   },
   "license": "MIT",
   "engines": {
-    "node": ">=6.9.0"
+    "node": ">=10"
   },
   "files": [
     "index.js",
@@ -36,9 +36,9 @@
     "JSONStream": "^1.0.4",
     "is-text-path": "^1.0.1",
     "lodash": "^4.17.15",
-    "meow": "^4.0.0",
+    "meow": "^8.0.0",
     "split2": "^2.0.0",
-    "through2": "^3.0.0",
+    "through2": "^4.0.0",
     "trim-off-newlines": "^1.0.0"
   },
   "scripts": {
@@ -47,5 +47,8 @@
   "bin": {
     "conventional-commits-parser": "cli.js"
   },
-  "gitHead": "e865af4df8d06795cebc7af09364ade19119e089"
+  "devDependencies": {
+    "forceable-tty": "^0.1.0"
+  },
+  "gitHead": "cc567b98facf71315f4b1620d81ce01d155efaca"
 }