conventional-changelog/commitlint

fix: Body line with reference like `#123` is considered footer

Fechada

#4.099 aberto em 10 de jul. de 2024

Ver no GitHubGuia do colaborador
 (2 comentários) (1 reação) (0 responsável)TypeScript (896 forks)batch import
bughelp wanted

Métricas do repositório

Stars
 (15.497 estrelas)
Métricas de merge de PR
 (Mesclagem média 12h 56m) (52 fundiu PRs em 30d)

Description

Steps to Reproduce

echo 'rules: {footer-leading-blank: [2, always]}' > .commitlintrc.yml
cat > commit-message.txt << EOF
fix: don't frobnicate the foobar

This commit prevents the foobar from being frobnicated
during operation, and therefore fixes #69.
EOF
npx '@commitlint/cli@19.3.0' -e commit-message.txt

Current Behavior

Validation fails with:

⧗   input: fix: don't frobnicate the foobar

This commit prevents the foobar from being frobnicated

during operation, and therefore fixes #69.
✖   footer must have leading blank line [footer-leading-blank]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

Expected Behavior

Validation passes.

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

No response

Context

Also happens with the full reference format: user/repo#123

commitlint --version

@commitlint/cli@19.3.0

git --version

v2.45.2

node --version

v22.4.0

Guia do colaborador

Direção de pesquisa
Investigate the commit message parsing logic in the @commitlint/parse package, specifically the function that separates body and footer. The current implementation treats any line starting with a reference (like #123 or user/repo#123) as footer, which is incorrect. Review the regex or conditional logic to ensure that reference lines within the body are not mistaken for footer lines. Check for existing tests or comments in the codebase related to footer detection.
Pilha de tecnologia
typescriptnodejs
Domain
cli
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 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
commit message conventionscommitlint configurationNode.jsTypeScript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65