fix(types): adds TargetCaseType[] for CaseRuleConfig

[chanceaclark]

Description

CaseRuleConfig now accepts TargetCaseType | TargetCaseType[].

Fixes #2631.

Motivation and Context

Building a plugin + config package and running into the issue with all the CaseRuleConfig types don't except an array of cases.

Usage examples

// index.ts (config package)
const config: UserConfig = {
  extends: ['@commitlint/config-conventional'],
  plugins: ['@bigcommerce/commitlint-plugin-jira'],
  rules: {
    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
    // @ts-expect-error
    'subject-case': [2, 'never', ['start-case', 'pascal-case']],
  },
};

exports = config;

How Has This Been Tested?

Installed and tested changes locally

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.

[escapedcat]

Thanks!

[AdeAttwood]

As is think this type is a bit to general for CaseRuleConfig we have a few rules that use this type, and not all of them accept a TargetCaseType[].

We have:

• body-case TargetCaseType
• header-case TargetCaseType | TargetCaseType[]
• scope-case TargetCaseType | TargetCaseType[]
• subject-case TargetCaseType | TargetCaseType[]
• type-case TargetCaseType | TargetCaseType[]

I have amended body-case to now accept TargetCaseType | TargetCaseType[] in #2671. So when the two PRs are merged, we should be all good.

@chanceaclark @escapedcat What do you think?

[chanceaclark]

@AdeAttwood I thought I covered all of them, good catch! 😅 But I like that plan. I'll keep watching out for that PR to get merged and I'll rebase when I see it.

[AdeAttwood]

@chanceaclark PRs have now been merged, thanks for your contribution.