# commitlint-plugin-multiscope

> Commitlint plugin that supports multiple scopes

Latest version **0.2.0** (published 2020-06-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install commitlint-plugin-multiscope
pnpm add commitlint-plugin-multiscope
yarn add commitlint-plugin-multiscope
bun add commitlint-plugin-multiscope
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2020-06-12 |
| First published | 2020-02-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | fmatzy |
| Maintainers | fmatzy |
| Keywords | typescript, commitlint, commitlintplugin |

## Links

- npm: https://www.npmjs.com/package/commitlint-plugin-multiscope
- Repository: https://github.com/fmatzy/commitlint-plugin-multiscope
- Homepage: https://github.com/fmatzy/commitlint-plugin-multiscope#readme
- Issues: https://github.com/fmatzy/commitlint-plugin-multiscope/issues
- npm.io page: https://npm.io/package/commitlint-plugin-multiscope

## Dependencies (2)

- [@commitlint/parse](https://npm.io/package/@commitlint/parse.md) ^8.3.4
- [@commitlint/rules](https://npm.io/package/@commitlint/rules.md) ^8.3.4

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.2.0 (latest) — 2020-06-12
- 0.1.2 — 2020-02-22
- 0.1.1 — 2020-02-22
- 0.1.0 — 2020-02-22

## README

# Commitlint Plugin Multiscope

![Node.js CI](https://github.com/fmatzy/commitlint-plugin-multiscope/workflows/Node.js%20CI/badge.svg)

A commitlint plugin that supports multiple scopes

## Getting Started

```shell
npm install -D commitlint-plugin-multiscope
```

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

```javascript
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`

---
_Source: https://npm.io/package/commitlint-plugin-multiscope · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._