conventional-changelog/commitlint

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

已关闭

#4,091 创建于 2024年6月19日

在 GitHub 查看贡献者指南
 (4 条评论) (0 个反应) (0 位负责人)TypeScript (896 个派生)batch import
bughelp wanted

仓库指标

星标
 (15,497 个星标)
PR 合并指标
 (平均合并 12小时 56分钟) (30 天内合并 52 个 PR)

描述

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

贡献者指南

研究方向
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.
技术栈
typescriptjavascriptnodejs
领域
cli
议题类型
缺陷
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
新近可参与
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Node.jsTypeScriptcommitlint configuration
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70