[Question]How to write rules with regex

[HikawaRin]

How to write rules with regex

Expected Behavior

Hi, I want to write my own rules based on Angular rules but has strict rules for scope, which may looks like below:

feat(core/module): add new feature ...

I want rule the scope message with a fixed head, like core, ui, etc...
then give more message descrip affected part(could be empty).
I think the rules I want to add can be expressed with regex like

'^core.*'

I tried

const scopes = [
    '^core.*',
    '^ui.*',
];

module.exports = {
    "rules":{
        'scope-enum': [2, 'always', scopes],
    },
};

but it doesn`t work.
So is there anyway can I apply regex to commitlint rules?

Current Behavior

Affected packages

• cli
• core
• prompt
• config-angular

Possible Solution

Steps to Reproduce (for bugs)

1. First step
2. Second step

commitlint.config.js

```js ```

Context

Your Environment

Executable	Version
commitlint --version	VERSION
git --version	VERSION
node --version	VERSION

[jdbruijn]

@HikawaRin I think this issue can be resolved using my plugin commitlint-plugin-function-rules.

Using the plugin, you can write something like this as commitlint config. Note that I've changed from regex to simply do startsWith and give a nice error message with allowed scope, but you could also use a regex!

Hope this helps!

module.exports = {
  extends: ['@commitlint/config-conventional'],
  plugins: ['commitlint-plugin-function-rules'],
  rules: {
    'scope-enum': [0], // level: disabled
    'function-rules/scope-enum': [
      2, // level: error
      'always',
      (parsed) => {
        const scopes = ['core', 'ui'];

        if (
          !parsed.scope ||
          scopes.some((scope) => parsed.scope.startsWith(scope))
        ) {
          return [true];
        }

        return [false, `scope must be one of ${scopes.join(', ')}`];
      },
    ],
  },
};

[xianshenglu]

Thanks very much. @jdbruijn You saved me. Here is my demo commit to customize commit lint rules.

[escapedcat]

We consider this question answered. Please reopen if you think you need more input.