conventional-changelog/commitlint

Camel-case is confused with sentence-case / start-case

Open

#3,501 opened on Jan 13, 2023

View on GitHub
 (0 comments) (1 reaction) (0 assignees)TypeScript (896 forks)batch import
bughelp wanted

Repository metrics

Stars
 (15,497 stars)
PR merge metrics
 (Avg merge 12h 56m) (52 merged PRs in 30d)

Description

Expected Behavior

If only sentence-case and start-case are denied from scopes, I'd expect camel-case to work.

Current Behavior

With

  scope-case:
    - 2
    - never
    - - sentence-case
      - start-case

I get

⧗   input: fix(ClearlyDefined): Make `Described` use `CurationFacets`

These are glob lists, not facet objects.

Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>
✖   scope must not be sentence-case, start-case [scope-case]

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

When checking for sentence-case / start-case, ensure that there is more than a single word.

Steps to Reproduce

See https://github.com/oss-review-toolkit/ort/actions/runs/3909253534/jobs/6680143679#step:4:17

Context

No response

commitlint --version

17.4.2

git --version

2.39.0

node --version

16.14.2

Contributor guide

Research direction
Inspect the scope case rule implementation in commitlint. Locate where sentence case and start case are checked. Ensure that the detection requires more than one word to avoid false positives with camel case.
Tech stack
typescript
Domain
clitooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
GitNode.jsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65