conventional-changelog/commitlint

Support `--path` option

Open

#3,104 创建于 2022年4月4日

在 GitHub 查看
 (4 评论) (0 反应) (0 负责人)TypeScript (15,497 star) (896 fork)batch import
featurehelp wanted

描述

In multi-package repo, I'd like to be able to use different commitlint configurations per package. Therefore with commitlint CLI I'd like to be able to validate commits that affect a given path only.

It'll be great if --path option is supported so we can narrow the list of validated commits to one affecting a specific directory (e.g. standard-version which generates changelog by retrieving commits supports path option, with commitlint it's not possible)

贡献者指南

技术栈
typescriptnodejs
领域
clitooling
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Familiarity with commitlintTypeScript programmingCLI argument parsing
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
To implement the path option, start by examining the CLI entry point in src/cli.ts to understand how existing options like edit are parsed. Then, modify the commit validation logic to accept an optional path filter, which can be passed to git log command via <path>. Review how standard version's path is implemented for reference. Ensure the change is backward compatible and add tests in the appropriate test file.