fix(types): add scope-delimiter-style types by what1s1ove · Pull Request #4592 · conventional-changelog/commitlint

what1s1ove · 2026-01-08T14:36:00Z

User description

Description

This PR adds TypeScript support for object-based configurations introduced in the previous changes (#4580).

While the runtime behavior and config validation already support object-based values for scope-enum and scope-case, TypeScript types were still restricted to the tuple-based format only. As a result, valid configurations caused TypeScript errors even though commitlint worked correctly at runtime.

This change extends the rule value types only for the affected rules (scope-enum and scope-case) to allow object-based configurations, without altering shared generic rule types. This keeps the existing type model intact while aligning TypeScript definitions with the actual supported configuration format.

No runtime behavior is changed, this PR only updates TypeScript types to reflect the existing functionality.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.

PR Type

Bug fix

Description

Add ObjectRuleConfig generic type for object-based rule configurations
Extend scope-case type to support object format with cases and delimiters
Extend scope-enum type to support object format with scopes and delimiters
Add scope-delimiter-style rule type to RulesConfig

Diagram Walkthrough

flowchart LR
  A["ObjectRuleConfig<br/>Generic Type"] --> B["scope-case<br/>Union Type"]
  A --> C["scope-enum<br/>Union Type"]
  D["scope-delimiter-style<br/>EnumRuleConfig"] --> E["RulesConfig<br/>Updated"]
  B --> E
  C --> E

File Walkthrough

Relevant files

Bug fix

rules.ts `Add object-based scope rule configuration types` @commitlint/types/src/rules.ts Added new `ObjectRuleConfig` generic type to support object-based configurations Updated `scope-case` to union type allowing both `CaseRuleConfig` and object format with `cases` and optional `delimiters` Updated `scope-enum` to union type allowing both `EnumRuleConfig` and object format with `scopes` and optional `delimiters` Added `scope-delimiter-style` rule using `EnumRuleConfig` type	+11/-2

qodo-code-review · 2026-01-08T14:36:23Z

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪	🎫 No ticket provided Create ticket/issue
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
🟢	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

codesandbox-ci · 2026-01-08T14:36:36Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

qodo-code-review · 2026-01-08T14:37:20Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Align object configuration with existing type Update the `scope-case` object configuration to allow the `cases` property to be either a single `TargetCaseType` or an array, aligning it with the existing `CaseRuleConfig` for better consistency. @commitlint/types/src/rules.ts [116-118] "scope-case": \| CaseRuleConfig<V> - \| ObjectRuleConfig<V, { cases: TargetCaseType[]; delimiters?: string[] }>; + \| ObjectRuleConfig< + V, + { cases: TargetCaseType \| TargetCaseType[]; delimiters?: string[] } + >; Apply / Chat Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies a type inconsistency in the newly added object configuration for `scope-case` and proposes a fix that aligns it with the existing `CaseRuleConfig`, improving API consistency and usability.	Medium
More

Copilot

Pull request overview

This PR adds TypeScript type definitions to support object-based configurations for scope-related rules. Previously, the TypeScript types only allowed tuple-based formats while the runtime already supported object-based configurations, causing type errors for valid configurations.

Introduces ObjectRuleConfig generic type for object-based rule configurations
Extends scope-case and scope-enum types to support both traditional and object formats with optional delimiters
Adds missing scope-delimiter-style rule type definition

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

escapedcat · 2026-01-08T15:10:41Z

Thanks!

escapedcat · 2026-01-08T15:21:12Z

https://github.com/conventional-changelog/commitlint/releases/tag/v20.3.1

Try this :)

what1s1ove · 2026-01-08T15:34:51Z

Now everything works fine. Thank you!

fix(types): add scope-delimiter-style types

c8bbc52

qodo-code-review Bot added the Review effort 1/5 label Jan 8, 2026

what1s1ove mentioned this pull request Jan 8, 2026

feat(rules): add scope-delimiter-style #4580

Merged

7 tasks

escapedcat requested a review from Copilot January 8, 2026 15:01

Copilot started reviewing on behalf of escapedcat January 8, 2026 15:01 View session

Copilot AI reviewed Jan 8, 2026

View reviewed changes

escapedcat merged commit 23c1f6e into conventional-changelog:master Jan 8, 2026
18 checks passed

This was referenced Jan 11, 2026

chore(deps): update dependency @commitlint/cli to 20.4.1 stacksjs/bun-plugin-yml#38

Closed

chore(deps): update dependency @commitlint/cli to 20.4.1 stacksjs/biome-config#31

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(types): add scope-delimiter-style types#4592

fix(types): add scope-delimiter-style types#4592
escapedcat merged 1 commit intoconventional-changelog:masterfrom
what1s1ove:master

what1s1ove commented Jan 8, 2026 •

edited

Loading

Uh oh!

qodo-code-review Bot commented Jan 8, 2026

Uh oh!

codesandbox-ci Bot commented Jan 8, 2026

Uh oh!

qodo-code-review Bot commented Jan 8, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

escapedcat commented Jan 8, 2026

Uh oh!

escapedcat commented Jan 8, 2026

Uh oh!

what1s1ove commented Jan 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Conversation

what1s1ove commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User description

Description

Types of changes

Checklist:

PR Type

Description

Diagram Walkthrough

File Walkthrough

Uh oh!

qodo-code-review Bot commented Jan 8, 2026

PR Compliance Guide 🔍

Uh oh!

codesandbox-ci Bot commented Jan 8, 2026

Uh oh!

qodo-code-review Bot commented Jan 8, 2026

PR Code Suggestions ✨

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

escapedcat commented Jan 8, 2026

Uh oh!

escapedcat commented Jan 8, 2026

Uh oh!

what1s1ove commented Jan 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

what1s1ove commented Jan 8, 2026 •

edited

Loading