conventional-changelog/commitlint

Error when linting a message with the word "fix" in it using custom parser preset

Open

#3231 opened on Jun 7, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (15,497 stars) (896 forks)batch import
bughelp wanted

Description

When using a custom parser preset, any form of the word "fix" seems to break parsing of references.

Running echo "refs#111111 Fixed something" | commitlint yields the following error:

{
  references: [],
  subject: 'Fixed something',
  merge: null,
  header: 'refs#111111 Fixed something',
  body: null,
  footer: null,
  notes: [],
  mentions: [],
  revert: null,
  raw: 'refs#111111 Fixed something\r\n'
}
⧗   input: refs#111111 Fixed something
✖   references may not be empty [references-empty]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

However, linting "refs#111111 This is a correct message" passes as expected.

echo "refs#111111 This is a correct message" | commitlint

{
  references: [
    {
      action: null,
      owner: null,
      repository: null,
      issue: '111111',
      raw: 'refs#111111',
      prefix: 'refs#'
    }
  ],
  subject: 'This is a correct message',
  merge: null,
  header: 'refs#111111 This is a correct message',
  body: null,
  footer: null,
  notes: [],
  mentions: [],
  revert: null,
  raw: 'refs#111111 This is a correct message\r\n'
}

Expected Behavior

The mentioned commit message should pass validation

Current Behavior

It seems as if any form of the word "fix" (e.g. "fixed", "fixes", "Fix..") must be the last word of the message or the linter will mistakenly fail.

Affected packages

  • cli
  • core (I suppose)
  • prompt
  • config-angular

Steps to Reproduce (for bugs)

Context

I am trying to configure commitlint for our custom message format refs#TICKETNO Sentence case message, where ticketno is a number at least 6 digits wide.

Your Environment

Executable Version
commitlint --version @commitlint/cli@17.0.2
git --version git version 2.35.3.windows.1
node --version v14.16.0

Contributor guide

Tech stack
typescriptnodejs
Domain
cli
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic commitlint knowledgeunderstanding of regular expressions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
This bug occurs when a commit message contains the word 'fix' (or its variants) along with a reference like 'refs#111111'. The custom parser preset's headerPattern regex may be incorrectly matching 'fix' as part of the reference. Start by examining the headerPattern in commitlint.preset.js: `/^(?:(refs#\d{5,}(?:, ?refs#\d{5,})*) )?(.*)$/`. The issue suggests that 'fix' being the first word in the subject causes the reference to not be captured. Check how the parser handles the 'fix' keyword, particularly if there is any default behavior that treats 'fix' as a special action (like in conventional commits). Review the commitlint core's reference extraction logic in the `@commitlint/parse` package. Additionally, look at the custom rule 'references empty' that triggers the error. Consider modifying the regex to be more flexible or investigating the parser's handling of issue prefixes. There are no linked PRs or assignees, so this is open for contribution.