conventional-changelog/commitlint

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

Fermée

#4 091 ouverte le 19 juin 2024

Voir sur GitHubGuide contributeur
 (4 commentaires) (0 réaction) (0 personne assignée)TypeScript (896 forks)batch import
bughelp wanted

Métriques du dépôt

Stars
 (15 497 étoiles)
Métriques de merge PR
 (Merge moyen 12h 56m) (52 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
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.
Stack technique
typescriptjavascriptnodejs
Domaine
cli
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 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Node.jsTypeScriptcommitlint configuration
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70