Change Log
All notable changes to this project will be documented in this file.
See Conventional Commits for commit guidelines.
3.2.0 (2020-11-05)
Bug Fixes
Features
3.1.0 (2020-05-08)
Bug Fixes
- deps: update yargs-parser to move off a flagged-vulnerable version. (#635) (aafc0f0)
Features
- conventional-commits-parser: add issuePrefixesCaseSensitive parser option (#580) (526b282)
- support slash in headerPattern default options (93a547d)
3.2.4 (2021-12-29)
Bug Fixes
- support BREAKING-CHANGE alongside BREAKING CHANGE (#882) (e6f44ad)
3.2.3 (2021-10-23)
Bug Fixes
3.2.2 (2021-09-09)
Bug Fixes
- conventional-commits-parser: address CVE-2021-23425 (#841) (02b3d53)
3.2.1 (2021-02-15)
Bug Fixes
3.0.8 (2019-11-14)
Bug Fixes
3.0.7 (2019-11-07)
Bug Fixes
- conventional-commits-parser: add breaking change notes if header match
breakingHeaderPattern
(#544) (efdf3cb)
- conventional-commits-parser: add missing separator pipe to non tty parser (#546) (c522743)
3.0.6 (2019-10-24)
Bug Fixes
- conventional-commits-parser: downgrade is-text-path due to node 6 incompatibility (#536) (3aa2637)
- deps: update lodash to fix security issues (#535) (ac43f51)
3.0.4 (2019-10-02)
Note: Version bump only for package conventional-commits-parser
3.0.3 (2019-05-18)
Bug Fixes
- deps: update dependency is-text-path to v2 (#455) (0f40ec3)
3.0.2 (2019-04-10)
Bug Fixes
- deps: update dependency through2 to v3 (#392) (26fe91f)
3.0.1 (2018-11-01)
Bug Fixes
Chores
- package: set Node requirement to oldest supported LTS (#329) (cae2fe0)
BREAKING CHANGES
Note: Version bump only for package conventional-commits-parser
2.1.6 (2018-03-22)
Note: Version bump only for package conventional-commits-parser
2.1.5 (2018-02-24)
Note: Version bump only for package conventional-commits-parser
2.1.4 (2018-02-20)
Note: Version bump only for package conventional-commits-parser
2.1.3 (2018-02-13)
Note: Version bump only for package conventional-commits-parser
2.1.2 (2018-02-13)
Note: Version bump only for package conventional-commits-parser
2.1.1 (2018-02-05)
Bug Fixes
2.1.0 (2017-12-08)
Bug Fixes
Features
2.0.1 (2017-11-13)
Bug Fixes
2.0.0 (2017-07-17)
Bug Fixes
- cli: commit can be split when testing a commit file (f3b3a3f)
- cli: error handling for ENOENT is fixed (3c92233)
- cli: fix "undefined" in json string (0680e42)
- cli: options format (491357e)
- deps: require split2 (1941c37)
- error: change error type and wordings (d8be5e5)
- footer: notes contains more than one paragraphs after references (d744ec7)
- headerCorrespondence: string value for cli (fb774fc)
- headerPattern: change how capturing groups works (fe1fe0c)
- issuePrefixes: should return noMatch if falsy (72db2bf)
- mention: fix mention matching (965986b), closes #26
- newlines: preserve newlines in a part (06b8c7c), closes #15
- notes: note keywords must appear at the beginning of a sentence (5a2059e), closes #23
- parser: do not trim spaces but newlines (1e8c4c5)
- parser: it returns null if there is no header (8571c9e)
- regex: do not treat it as note if there are texts after keywords (571b03e)
- regex: make getReferencePartsRegex stricter (62adf54), closes #27 #30 #27 #28
- revertPattern: correct regex (8628983)
- util: remove an accidentally commited file (3710a8c)
- warn: should tell which commit cannot be parsed (04b0a9b)
Chores
Code Refactoring
- breaks: change
breaks
to notes
(5189a61), closes #2
- merge: pull-request should be merge (4e7c61c)
- regex: regex now takes
options
(eea319a)
Features
- cli: able to have two files, separator works for interactive (db1e3b5)
- cli: add aliases, more help details and tests (eb654a2)
- cli: add missing options (8ac1cf7)
- cli: add warn function for interactive shell (84fe31f)
- correspondence: add
headerCorrespondence
and improve commit parts (aca9e95), closes #6
- fieldPattern: should support string format (b6b6b52)
- hash: drop support (1ccc751)
- headerParts: headerParts can be anything (31e1c11), closes #10
- issuePrefixes: init and referenceKeywords -> referenceActions (86bf798), closes #11
- maxSubjectLength: removed (3448582)
- mentions: @someone in commit (d60fe76), closes #24
- newline: fields does not contain leading or trailing newlines (6db453b), closes #14
- note: noteKeywords is case insensitive (f779a29), closes #21
- options: all options can be a string (0fa17b4)
- otherFields: other fields are possible to be included (9e06278)
- improvements and bug fixes (1cde104), closes #5
- migrate repo to lerna mono-repo (793e823)
- regex: matching JIRA-123 like references (20f1f7a), closes #19
- support squash commits (#31) (fff60c0)
- owner: yield owner field (d8d0334), closes #12
- parser: notes can have more than one paragraph (733bfa9), closes #3
- pullRequest: Allow to skip and parse pull request header (a2e929f), closes #20
- reference: able to reference an issue without an action (6474123), closes #22
- reference: expose prefix (47df766), closes #17
- references: allow header to reference an issue (df18a24)
- references: support other formats of references (7c70213), closes #4 #8
- regex: leading and trailing space for closes and breaks keywords are trimmed (9639860)
- revert: parse a commit that reverts (2af7233)
- stream: emmit an empty string to down stream if commit cannot be parsed (76bf84e)
- sync: add the sync function (82071c6), closes #13
- warn: optionally warn user what is wrong when commit cannot be parsed (32b3cda)
Performance Improvements
- regex: regex should be constructed in index.html (15afd26)
BREAKING CHANGES
- merge:
pull request
should be merge
. Also make the parsed result to be consistent with other parts.
- This module is imported from https://github.com/ajoslin/conventional-changelog, and is originally written by @vojtajina, @btford and @ajoslin.
- hash: hash is no longer supported. This parser should just parse raw commit messages. Also text fields are appended with a newline "
".
- regex: It returns a nomatch regex if it's keywords are missing.
- headerParts:
headerParts
does not limit to type
, scope
and subject
. They can now be defined in options.headerCorrespondence
and the order is the order of capturing group in options.headerPattern
. If part is missing in options.headerCorrespondence
it is undefined
. If part is not captured but is not missing in options.headerCorrespondence
it is null
.
- maxSubjectLength:
maxSubjectLength
is not available any more.
- issuePrefixes:
options.referenceKeywords
is now options.referenceActions
- references:
closes
now becomes references
and it is loosely based the links above.
- parser: The regex for matching notes are loosen. The semicolon and space are optional. The
notes
object is no longer a key-value object but an array of note object, such as
js
{
title: 'BREAKING AMEND',
text: 'some breaking change'
}
The detection of notes, closes, continueNote and isBody are mutually exclusive.
* breaks: Variable name related to breaks
changes to notes
, because "Important Notes" a more generic term. There is no functional changes.
* stream: It no longer skips the chunk if commit cannot be parsed. An empty string is passed to down stream
* correspondence: body and footer will be null if they are not found. type and subject are nullable too.
# 1.3.0 (2016-10-15)
### Features
* support squash commits (#31) (860c7a1)
## 1.2.3 (2016-08-06)
### Bug Fixes
* regex: do not treat it as note if there are texts after keywords (9cb56bc)
## 1.2.2 (2016-05-04)
### Bug Fixes
* regex: make getReferencePartsRegex stricter (b8a9fda), closes #27 (#30 (2016-04-24)
### Bug Fixes
* mention: fix mention matching (43b32e7), closes #26
# 1.2.0 (2016-04-15)
### Features
* mentions: @someone in commit (b2eabbf), closes #24
# 1.1.0 (2016-04-10)
### Bug Fixes
* notes: note keywords must appear at the beginning of a sentence (6e13789), closes #23
### Features
* reference: able to reference an issue without an action (cf847b1), closes #22
## 1.0.1 (2016-02-05)
### Bug Fixes
* deps: require split2 (ad55810)
# 1.0.0 (2016-02-05)
# 0.2.0 (2016-02-04)
### Features
* note: noteKeywords is case insensitive (4442b86), closes #21
* pullRequest: Allow to skip and parse pull request header (aa85033), closes #20
* regex: matching JIRA-123 like references (5342f45), closes #19
## 0.1.2 (2015-09-18)
### Bug Fixes
* parser: do not trim spaces but newlines (62e7bf5)
## 0.1.1 (2015-09-12)
### Bug Fixes
* newlines: preserve newlines in a part (beb3d05), closes #15
### Features
* reference: expose prefix (9962dda), closes #17