conventional-changelog/commitlint

Body mistaken for footer with issue reference

Fechada

#3.364 aberto em 4 de set. de 2022

Ver no GitHubGuia do colaborador
 (0 comentário) (4 reações) (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

Expected Behavior

Commit message:

fix: test

This is a very long line with at least one hundred characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters #32

rule: "body-max-line-length": [2, "always", "Infinity"],

The second paragraph should be interpreted as the body and therefore throw no error.

Current Behavior

The second paragraph is interpreted as the footer (because of the issue reference) and therefore footer rules are applied.

⧗   input: fix: test

This is a very long line with at least one hundred characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters characters #32
✖   footer's lines must not be longer than 100 characters [footer-max-line-length]

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

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

Steps to Reproduce (for bugs)

  1. Create commit with above message
  2. Run commitlint --verbose --from=HEAD~1
  3. See error

Context

Your Environment

Executable Version
commitlint --version 17.1.2
git --version 2.27.0.windows.1
node --version 16.13.0

Guia do colaborador

Direção de pesquisa
Investigate the commit message parser in commitlint, specifically how it distinguishes between body and footer sections. The issue occurs because a line with an issue reference (#32) at the end is treated as a footer. Look at the 'conventional commits parser' library, especially the regex that identifies footers. The maintainers may need to adjust the parser to allow body lines containing issue references without triggering footer detection. Check the '@commitlint/parse' module and the parsing logic in the conventional commits parser package.
Pilha de tecnologia
typescriptnodejs
Domain
toolingclideveloper experience
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.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
conventional commitscommitlint basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
45