JSPM

  • Created
  • Published
  • Downloads 185659
  • Score
    100M100P100Q166936F
  • License MIT

Shareable commitlint config enforcing the angular commit convention

Package Exports

  • @commitlint/config-angular

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@commitlint/config-angular) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Lint your commits, angular-style

@commitlint/config-angular

Shareable commitlint config enforcing the angular commit convention.

Getting started

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

Rules

Problems

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

type-enum

  • condition: type is found in value

  • rule: always

  • value

    [
      'build',
      'chore',
      'ci',
      'docs',
      'feat',
      'fix',
      'perf',
      'refactor',
      'revert',
      'style',
      'test'
      ]

type-case

  • description: type is in case value
  • rule: always
  • value
      'lowerCase'

type-empty

  • condition: type is empty
  • rule: never

scope-case

  • condition: scope is in case value
  • rule: always
  'lowerCase'

subject-empty

  • condition: subject is empty
  • rule: never

subject-full-stop

  • condition: subject ends with value
  • rule: never
  • value
  '.'

header-max-length

  • condition: header has value or less characters
  • rule: always
  • value
  72

Warnings

The following rules are considered warnings for @commitlint/config-angular and will print warning messages when not met.

body-leading-blank

  • condition: Body begins with blank line
  • rule: always

lang

  • condition: subject is of language value
  • rule: always
  • value
  eng