Can't use async rule configuration

[alebianco]

Expected Behavior

In a typescript project, provide an asynchronous list for the scope-enum rule, as described in the doc https://github.com/conventional-changelog/commitlint/blob/master/docs/reference-rules.md

Current Behavior

Typescript complains of a type mismatch and the code is not compiled

Affected packages

• types

Possible Solution

I don't think the QualifiedConfig type is correct for the async option. It should probably be (() => Promise<RuleConfigTuple<T>>) instead.

Steps to Reproduce (for bugs)

1. Try to compile the typescript configuration provided to javascript with tsc

commitlint.config.ts

import type { RulesConfig } from '@commitlint/types';
import { RuleConfigSeverity } from '@commitlint/types';

const { Error } = RuleConfigSeverity;

export const rules: Partial<RulesConfig> = {
  'scope-enum': () => Promise.resolve([Error, 'always', ['one', 'two', 'three']]),
};

export default {
  rules,
};

Context

I want to restrict commit scopes to a predefined list that cannot be defined synchronously. I have to define a custom rule/plugin to work around this issue.

Your Environment

Executable	Version
commitlint --version	14.1.0
git --version	V2.33.1
node --version	v16.12.0

[escapedcat]

Hey @alebianco thanks for reporting this,
would you have time to test this and create PR?

[alebianco]

Sure, the change is trivial if you agree that that's the problem.

Any suggestion on which are the relevant tests to check and/or integrate for this change?

[escapedcat]

Sure, the change is trivial if you agree that that's the problem.

Not sure, but it sounds correct :)

Any suggestion on which are the relevant tests to check and/or integrate for this change?

All existing tests should still pass. If one doesn't have a look and see if it needs to be adjusted.
I'm not too familiar with this but I assume here a new test with the async config should de added:
https://github.com/conventional-changelog/commitlint/blob/f5ebf6ef07ebd20367453f29af863fb6f8791029/%40commitlint/load/src/load.test.ts

Does this make sense to you?

[alebianco]

All existing tests should still pass.

yes all existing tests are fine with the change

I assume here a new test with the async config should de added

agree, that looks like the right place, thanks

I'll open the PR once I have the time to add a couple tests

[escapedcat]

I'll open the PR once I have the time to add a couple tests

No rush, thanks a lot!