core: multiple scopes in commit message

[virkt25]

Hi,

I have a project where the commitlint is used to enforce the commit message using the angular & lerna-scopes config. This works fine for most messages but it errors for multiple scopes in a message: Example: fix(core,context): fixed some situation.

Is there a configuration to support this or should this be a feature request?

[marionebl]

Currently commitlint assumes there is only one scope in each commit message. Supporting multiple scopes would require new rules and/or new options on existing ones.

Could you elaborate on the error messages you see and the behaviour you expect?

[virkt25]

Thanks for the quick reply @marionebl :)

For a lerna project with the following packages:

packages/
  pkg1
  pkg2
  pkg3
  pkg4

Current Behaviour

Commit Message: feat(pkg1, pkg2): add some new feature
commitlint Error: scope must be one of [pkg1, pkg2, pkg3, pkg4]

Expected Behaviour

As long as all the scopes are valid and comma separated, the commit message should pass commitlint.

Reason: Some features/fixes may at times require multiple packages to be changed and this approach allows all affected scopes to be listed.

[marionebl]

This would require:

• A conventional-commits-parser preset parsing comma separated types to an array. That should be provided by the user

• New rules working on the types array. I lean towards adding something similar to the eslint plugin API. The new types rules would be such a plugin then.

[virkt25]

I like the sound of a plugin API for rules :) That way additional rules can be written by the community as needed. Are you currently working on the this by any chance?

I looked into conventional-commits-parser and it can only return a string of the scope and the types rules would have to split it at commas to create the scopes array to be compared against available scopes.

[marionebl]

Have not worked on plugins yet. I'd mostly copycat the eslint way of things, removing most effort for tech. concept etc.

If conventional-commits-parser does not support array results for scope and type let's spin up a related PR there to add it - I want to keep actual parsing out of commitlint.

[escapedcat]

Linking possible plugin PR

[PaulRBerg]

It's not maintained anymore, but isn't cz-lerna-changelog an implementation of what's been discussed in this thread? Could be a good place to start.

[escapedcat]

@PaulRBerg sorry, what is not maintained anymore?

[PaulRBerg]

cz-lerna-changelog. I was just saying that they seem to have implemented multiple scopes, despite the fact that there hasn't been much activity on their repo lately.

[escapedcat]

Ah, thx for clarifying!

[backflip]

Could this be closed as #901 was merged?

[escapedcat]

Thanks @backflip for pointing this out! Closing this 🎉