conventional-changelog/commitlint

Rule does not work with #ids

Open

#3.615 aberto em 31 de mai. de 2023

Ver no 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.

Guia do colaborador

Pilha de tecnologia
typescriptnodejsshell
Domain
clideveloper experiencetooling
Tipo Issue
bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
active
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
conventional commitscommitlint configurationregex basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40
Direção de pesquisa
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.