Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.01 KB

README.md

File metadata and controls

30 lines (19 loc) · 1.01 KB
Raw

Lint your commits, patternplate-style

@commitlint/config-patternplate

Shareable commitlint config enforcing the patternplate commit convention. Use with @commitlint/cli and @commitlint/prompt-cli.

Getting started

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

Rules

@commitlint/config-patternplate extends the shareable angular config. Additionally these rules apply:

Problems

The following rules are considered problems for @commitlint/config-patternplate and will yield a non-zero exit code when not met.

scope-enum

  • description: scope is found in value
  • rule: always
  • value: determined based on pattern tree. system and all pattern ids present in patterns are allowed

Consult docs/rules for a list of available rules.