.commitlintrc.yml

# Git Commit Message Convention
# - follow: https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md
# - tool:   https://commitlint.js.org/#/concepts-commit-conventions
#
#  ```
#  <type>(<scope?>): <subject>
#  <BLANK LINE>
#  <body?>
#  <BLANK LINE>
#  <footer?>
#  ```
extends:
  # https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional
  - '@commitlint/config-conventional'

# # https://commitlint.js.org/#/reference-rules
rules:
  # https://commitlint.js.org/#/reference-rules?id=type-enum
  type-enum:
    - 2 # error
    - always
    - - build
      - chore
      - ci
      - docs
      - feat
      - fix
      - perf
      - refactor
      - revert
      - style
      - test
      - polish
      - hotfix
      - release
      # work in progress
      - WIP

  # https://commitlint.js.org/reference/rules.html#type-case
  type-case:
    - 2 # error
    - always
    - - lower-case
      - upper-case

  # https://commitlint.js.org/#/reference-rules?id=scope-case
  scope-case:
    - 2 # error
    - always
    - - lower-case
      - upper-case
      - kebab-case
      - pascal-case
      - start-case

  # https://commitlint.js.org/#/reference-rules?id=subject-case
  subject-case:
    - 1 # warning
    - always
    - - lower-case
      - sentence-case
      - start-case

  # https://commitlint.js.org/#/reference-rules?id=header-max-length
  header-max-length:
    - 2 # error
    - always
    - 120

  # https://commitlint.js.org/#/reference-rules?id=footer-leading-blank
  footer-leading-blank:
    - 2 # error
    - always

  # https://commitlint.js.org/#/reference-rules?id=body-leading-blank
  body-leading-blank:
    - 2 # error
    - always