conventional-changelog/commitlint

`parserPreset` in `.commitlintc.json` is ignored

Fechada

#4.091 aberto em 19 de jun. de 2024

Ver no GitHubGuia do colaborador
 (4 comentários) (0 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

  1. Create .commitlintrc.json with the following contents
{
  "extends": ["@commitlint/config-conventional"],
  "parserPreset:": {
    "parserOpts": {
      "issuePrefixes": ["PREFIX-"]
    }
  },
  "rules": {
    "references-empty": [2, "never"]
  }
}
  1. Run echo "feat: some feature (PREFIX-123)" | npx commitlint and observe how an error for empty references is thrown.
  2. Run npx commitlint --print-config and observe how parserPreset.parserOpts.issuePrefixes is [ '#' ].

With a commitlint.config.js this does not happen.

Current Behavior

see above.

Expected Behavior

It should correctly pick up parserPreset from the JSON configuration.

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

No response

Context

No response

commitlint --version

@commitlint/cli@19.3.0

git --version

2.45.2

node --version

v20.13.1

Guia do colaborador

Direção de pesquisa
The issue likely lies in the configuration loading logic, specifically how `loadConfig` handles JSON vs JS files. Investigate the `@commitlint/load` package, focusing on the `parserPreset` key handling. Look at the source files like `src/load.ts` or similar. Check how the config is parsed and if there is a difference in the way `parserPreset` is applied for JSON configs. Possible fix involves ensuring that `parserPreset` from JSON config is recognized and merged similarly to JS config.
Pilha de tecnologia
typescriptjavascriptnodejs
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.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Node.jsTypeScriptcommitlint configuration
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70