Skip to content

Commit

Permalink
fix: stop truncating the body in presence of dashes
Browse files Browse the repository at this point in the history
In the current version of commitlint the body is truncated
unexpectedly when there is a pattern like
'- Something between dashes -' in the commit message body.
The reason for this behavior is that in the commit parser
package the commitlint uses (conventional-commit-parser[1]),
this pattern '- something -' is a special pattern for any
arbitrary filed. For example, if you put '-myNote-' in the
commit message body, everything that comes after this field
will be saved in an arbitrary field called myNote (Or
whatever is written between dashes) and you can use it like
other fields (header, body, etc.), but I believe we should
disable this functionality because, in the commit messages
like the one in the bug report that this commit fixes, the
user might put stack trace in the commit message body and
this way it will be truncated unexpectedly.

Fixes #3428

[1] https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-commits-parser/README.md
  • Loading branch information
tehraninasab committed Jan 3, 2023
1 parent 4cf0cc1 commit 970ffa1
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions @commitlint/parse/src/index.ts
Expand Up @@ -12,6 +12,7 @@ export default async function parse(
const opts = {
...defaultOpts,
...(parserOpts || {}),
fieldPattern: null
};
const parsed = parser(message, opts) as Commit;
parsed.raw = message;
Expand Down

0 comments on commit 970ffa1

Please sign in to comment.