conventional-changelog/commitlint

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

Chiusa

#4091 aperta il 19 giu 2024

Vedi su GitHubGuida contributor
 (4 commenti) (0 reazioni) (0 assegnatari)TypeScript (896 fork)batch import
bughelp wanted

Metriche repository

Star
 (15.497 stelle)
Metriche merge PR
 (Merge medio 12h 56m) (52 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
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.
Tech stack
typescriptjavascriptnodejs
Dominio
cli
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Node.jsTypeScriptcommitlint configuration
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70