commitlint-plugin-multiscope
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

Commitlint Plugin Multiscope

Node.js CI

A commitlint plugin that supports multiple scopes

Getting Started

npm install -D commitlint-plugin-multiscope

And configure commitlint.config.js to use multiscope plugin.

module.exports = {
  plugins: ['commitlint-plugin-multiscope'],
  rules: {
    'multiscope': [2, 'always', {
      delimiter: ',',
      enum: [
        'api',
        'app',
        'web',
      ],
      case: 'lower-case'
    }]
  }
}

options: MultiScopeOptions

  • delimiter?: string | RegExp
    • specify delimiter that scopes joined by
    • default: ,
  • enum?: string[]
    • condition: scope is found in enum
    • default: []
  • case?: string
    • condition: scope is in case
    • default: lower-case

Package Sidebar

Install

npm i commitlint-plugin-multiscope

Weekly Downloads

1

Version

0.2.0

License

MIT

Unpacked Size

6.95 kB

Total Files

12

Last publish

Collaborators

  • fmatzy