bug: footer-leading-blank complains with the number sign in the commit body · conventional-changelog/commitlint#896

(15 comments) (16 reactions) (0 assignees)TypeScript (15,497 stars) (896 forks)batch import

bughelp wanted

Description

Expected Behavior

The following commit message should pass the footer-leading-blank rule:

test: footer-leading-blank bug

hello
see issue #1234

Current Behavior

The above commit message, however, fails with the following:

⧗   input: test: footer-leading-blank bug
⚠   footer must have leading blank line [footer-leading-blank]

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

This happens when the following conditions are true:

The # symbol is present in the commit body
It is immediately followed by a number
It is not at the beginning of a line
It doesn't appear in the first line of the commit body

For instance, the following example, taken from the spec, also triggers this bug:

fix: correct minor typos in code

see the issue for details

on typos fixed.

Reviewed-by: Z
Refs #133

Affected packages

cli
core
prompt
config-angular

Steps to Reproduce

Create a repo with the below config file
In this repo, create a commit such as the above examples
Run commitlint --edit
An error such as the above appears

module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [
      1,
      'always',
      [
        'build',
        'chore',
        'ci',
        'docs',
        'feat',
        'fix',
        'perf',
        'refactor',
        'revert',
        'style',
        'test'
      ]
    ]
  }
}

Context

I was referencing a GitHub issue in the standard GitHub format, which is #1234. This was inside a very detailed commit message with multiple lines.

Your Environment

Executable	Version
`commitlint --version`	8.3.4
`git --version`	2.20.1
`node --version`	10.17.0

Contributor guide

Tech stack: typescript
Domain: clitooling
Issue type: bug
Difficulty: 3
Estimated time: 1-3 hours
Activity status: stale
Clarity: clear
Prerequisites: Familiarity with conventional commitsBasic understanding of commitlint rules
Newbie friendliness: 60
Research direction: The bug is in the `footer leading blank` rule. Look at the rule implementation in `@commitlint/rules/src/footer leading blank.ts` and the underlying parser that identifies footers. The issue is that lines containing `#` followed by a number are incorrectly treated as footers, even when they appear in the body. The fix likely involves adjusting the regex or logic that distinguishes footers from body text. Check the existing tests for this rule and consider adding test cases with `#` in the body.