conventional-changelog/commitlint

Support `--path` option

Open

#3104 opened on Apr 4, 2022

View on GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (15,497 stars) (896 forks)batch import
featurehelp wanted

Description

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)

Contributor guide

Tech stack
typescriptnodejs
Domain
clitooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with commitlintTypeScript programmingCLI argument parsing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.