conventional-changelog/commitlint

Rule does not work with #ids

Open

#3615 opened on May 31, 2023

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

Description

I was trying this utility in my project as we are planning to enforce conventional commit messages. It works nicely but I was pleasantly surprised when it started failing miserably. When I tried to commit with messages like git commit -m "#123 - test commit" it does not throw any error. However when I run commitlint --from=HEAD~1 it shows error.

Screenshot 2023-05-31 at 14 34 20

This is causing issues as the team is accustomed to #ticket-id - message pattern.

Contributor guide

Tech stack
typescriptnodejsshell
Domain
clideveloper experiencetooling
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.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
conventional commitscommitlint configurationregex basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate how commitlint's parser handles commit messages that start with '#' (e.g., '#123 message'). The bug likely lies in the parsing logic that treats '#' as a comment or ignores it. Check the `@commitlint/parse` package and the conventional changelog parser. Look for tests related to subject line parsing and consider adding support for common patterns like '#ticket message'. Review comments in issue #3615 for additional context.