Skip to content

Latest commit

 

History

History
 
 

config-lerna-scopes

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
fixtures
fixtures
 
 
CHANGELOG.md
CHANGELOG.md
 
 
index.js
index.js
 
 
package.json
package.json
 
 
readme.md
readme.md
 
 
test.js
test.js
 
 

readme.md

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 "buid(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.