conventional-changelog/commitlint

Rule does not work with #ids

Open

#3 615 ouverte le 31 mai 2023

Voir sur GitHub
 (12 commentaires) (0 réactions) (0 assignés)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.

Guide contributeur

Stack technique
typescriptnodejsshell
Domaine
clideveloper experiencetooling
Type d'issue
bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
conventional commitscommitlint configurationregex basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40
Direction de recherche
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.