@commitlint/config-lerna-scopes

Lint your commits, angular-style

@commitlint/config-lerna-scopes

Shareable commitlint config enforcing lerna package names as scopes. Use with @commitlint/cli and @commitlint/prompt-cli.

Getting started

npm install --save-dev @commitlint/config-lerna-scopes @commitlint/cli
echo "module.exports = {extends: ['@commitlint/config-lerna-scopes']};" > commitlint.config.js

Examples

❯ cat commitlint.config.js
{
  extends: ['@commitlint/config-lerna-scopes']
}

❯ tree packages

packages
├── api
├── app
└── web

❯ echo "build(api): change something in api's build" | commitlint
⧗   input: build(api): change something in api's build
✔   found 0 problems, 0 warnings

❯ echo "test(foo): this won't pass" | commitlint
⧗   input: test(foo): this won't pass
✖   scope must be one of [api, app, web] [scope-enum]
✖   found 1 problems, 0 warnings

❯ echo "ci: do some general maintenance" | commitlint
⧗   input: ci: do some general maintenance
✔   found 0 problems, 0 warnings

Consult docs/rules for a list of available rules.

Changelog

7.6.0 (2019-05-06)

Bug Fixes

• add @lerna/project to repository dependencies (#598) (56f03ee)
• address security warnings for dev dependencies (3e0d824)
• avoid excessive help text #606 (#637) (8f3c3b1)
• don't merge array properties with custom opts (#616) (f321647), closes #594
• remove unneeded dev dependency (6ccaf79)
• update cosmiconfig to safe >=5 #599 (f186fcb)
• use sander.readFile correctly (#448) (#630) (8e47985)

Features

• resolve-extends: accept short scoped package names in extends (#597) (ba90e8e)
• adds support for plugins (#228) (#588) (cea4564)
• config based is-ignored overrides (#595) (2434d71)