conventional-changelog/commitlint

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

Geschlossen

#4.091 geöffnet am 19.06.2024

Auf GitHub ansehenContributor Guide
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (896 Forks)batch import
bughelp wanted

Repository-Metriken

Stars
 (15.497 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 12h 56m) (52 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
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
Domain
cli
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Node.jsTypeScriptcommitlint configuration
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70