README.md

Several ways to use commitlint

Commit lint helps your team adhering to a commit convention. By supporting npm-installed configurations it makes sharing of commit conventions easy.

Quick types ref:

[
  'build',
  'ci',
  'chore',
  'docs',
  'feat',
  'fix',
  'perf',
  'refactor',
  'revert',
  'style',
  'test',
  'breaking',
  'config',
  'no-release'
]

Option 1(current project configuration)

Using .huskyrc file

• Install commitlint libraries globally

npm i -g @commitlint/cli @commitlint/config-conventional

• Create project husky hooks

npm i

Option 2

Install hook locally by curl taken the idea from hazcod

• Install commitlint libraries globally

npm i -g @commitlint/cli @commitlint/config-conventional

• Get hook from repo

curl --fail -o .git/hooks/commit-msg https://raw.githubusercontent.com/mpielvitori/commitlint-usage/master/commit-msg && chmod 500 .git/hooks/commit-msg

Option 3

Configuring husky on package.json

• Add following config

{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  },
  "devDependencies": {
    "@commitlint/cli": "latest",
    "@commitlint/config-conventional": "latest",
    "husky": "latest"
  }
}

• Create project husky hooks

npm i

Option 4

Run on gitlab pipeline linting the last commit

  before_script:
    - npm i -g @commitlint/cli @commitlint/config-conventional
    - echo $(git log -1 --pretty=%B) | commitlint

Or linting all the commits to merge

  before_script:
    - npm i -g @commitlint/cli @commitlint/config-conventional
    - commitlint --from=$CI_BUILD_BEFORE_SHA

Option 5

Add GitLab push rules

(^(Notes added by \'git notes add\'))|(^(feat|fix|docs|breaking|config|no-release|style|refactor|test|build|ci|perf|chore)(\(.+\))?\:\s(.{3,}))

Regex using workaround for semantic release -> issue

References

• @commitlint/config-conventional
• Angular Commit Message Conventions