conventional-changelog/commitlint

fix: `body-max-line-length` is not respecting `footer-max-line-length` and failing for long footers

Open

#4088 opened on Jun 12, 2024

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

Description

Steps to Reproduce

1. First step
set rules 

{
  "body-max-line-length": [2, "always", 100],
  "footer-max-line-length": [2, "always", 150],
}

2. Second step
In commit have a footer greater than 100 characters and less than 150 characters

Current Behavior

The commitlint fails with body-max-line-length

Expected Behavior

It shouldn't fail with body-max-line-length as footer-max-line-length is respected

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

No response

Context

Am facing this issue when using the commitlint-pre-commit-hook plugin for pre-commit.

Have current suppressed the checks with the following config

module.exports = {
    extends: ['@commitlint/config-conventional'],
    rules: {
        'body-max-line-length': [0, 'always', 0],
        'footer-max-line-length': [0, 'always', 0],
    }
};

commitlint --version

@commitlint/cli@19.3.0

git --version

v2.39.3

node --version

v12.22.12

Contributor guide

Tech stack
typescriptnodejs
Domain
clitooling
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.
1-3 hours
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 usageunderstanding of commit message sections
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Investigate the implementation of the `body max line length` rule in commitlint, likely in the `@commitlint/rules` package. The rule should ignore lines that belong to the footer section when `footer max line length` is set. Review how commitlint parses commit messages to distinguish between body and footer sections. Check if the rule is incorrectly checking all lines after the header, including footers, and modify it to only apply to the body section.