conventional-commits-parser 3.0.5 → 3.1.0

package/CHANGELOG.md

@@ -3,6 +3,58 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [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)
+
+
+### Bug Fixes
+
+* **conventional-commits-parser:** downgrade is-text-path due to node 6 incompatibility ([#536](https://github.com/conventional-changelog/conventional-changelog/issues/536)) ([3aa2637](https://github.com/conventional-changelog/conventional-changelog/commit/3aa2637a1c65bb4db3d8bf2c6ce17e6f5abe1ca1))
+* **deps:** update lodash to fix security issues ([#535](https://github.com/conventional-changelog/conventional-changelog/issues/535)) ([ac43f51](https://github.com/conventional-changelog/conventional-changelog/commit/ac43f51de1f3b597c32f7f8442917a2d06199018))
+
+
+
+
+
 ## [3.0.4](https://github.com/conventional-changelog/conventional-changelog/compare/conventional-commits-parser@3.0.3...conventional-commits-parser@3.0.4) (2019-10-02)
 
 **Note:** Version bump only for package conventional-commits-parser

package/README.md

@@ -193,6 +193,12 @@ 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']`

package/cli.js

@@ -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'
     }
   }
 })
@@ -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

@@ -7,7 +7,7 @@ var _ = require('lodash')
 
 function assignOpts (options) {
   options = _.extend({
-    headerPattern: /^(\w*)(?:\(([\w$.\-* ]*)\))?: (.*)$/,
+    headerPattern: /^(\w*)(?:\(([\w$.\-*/ ]*)\))?: (.*)$/,
     headerCorrespondence: ['type', 'scope', 'subject'],
     referenceActions: [
       'close',

package/lib/parser.js

@@ -253,6 +253,17 @@ function parser (raw, options, regex) {
     }
   })
 
+  if (options.breakingHeaderPattern && notes.length === 0) {
+    var 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])
   }

package/lib/regex.js

@@ -21,12 +21,13 @@ function getNotesRegex (noteKeywords) {
   return new RegExp('^[\\s|*]*(' + join(noteKeywords, '|') + ')[:\\s]+(.*)', 'i')
 }
 
-function getReferencePartsRegex (issuePrefixes) {
+function getReferencePartsRegex (issuePrefixes, issuePrefixesCaseSensitive) {
   if (!issuePrefixes) {
     return reNomatch
   }
 
-  return new RegExp('(?:.*?)??\\s*([\\w-\\.\\/]*?)??(' + join(issuePrefixes, '|') + ')([\\w-]*\\d+)', 'gi')
+  var flags = issuePrefixesCaseSensitive ? 'g' : 'gi'
+  return new RegExp('(?:.*?)??\\s*([\\w-\\.\\/]*?)??(' + join(issuePrefixes, '|') + ')([\\w-]*\\d+)', flags)
 }
 
 function getReferencesRegex (referenceActions) {
@@ -42,7 +43,7 @@ function getReferencesRegex (referenceActions) {
 module.exports = function (options) {
   options = options || {}
   var reNotes = getNotesRegex(options.noteKeywords)
-  var reReferenceParts = getReferencePartsRegex(options.issuePrefixes)
+  var reReferenceParts = getReferencePartsRegex(options.issuePrefixes, options.issuePrefixesCaseSensitive)
   var reReferences = getReferencesRegex(options.referenceActions)
 
   return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "conventional-commits-parser",
-  "version": "3.0.5",
+  "version": "3.1.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",
@@ -34,9 +34,9 @@
   ],
   "dependencies": {
     "JSONStream": "^1.0.4",
-    "is-text-path": "^2.0.0",
-    "lodash": "^4.2.1",
-    "meow": "^4.0.0",
+    "is-text-path": "^1.0.1",
+    "lodash": "^4.17.15",
+    "meow": "^7.0.0",
     "split2": "^2.0.0",
     "through2": "^3.0.0",
     "trim-off-newlines": "^1.0.0"
@@ -47,5 +47,8 @@
   "bin": {
     "conventional-commits-parser": "cli.js"
   },
-  "gitHead": "7c1c8ad819b05c12c7d58c92ac386b45ada6f6a8"
+  "devDependencies": {
+    "forceable-tty": "^0.1.0"
+  },
+  "gitHead": "83643c5a0d2c4d7c9ba14cbf990ffbc577a51e8c"
 }