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.