conventional-changelog/commitlint

Rule does not work with #ids

Open

#3.615 geöffnet am 31. Mai 2023

Auf GitHub ansehen
 (12 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (15.497 Stars) (896 Forks)batch import
bughelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
active
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
conventional commitscommitlint configurationregex basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
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.