Skip to content

README.md

Latest commit

 

History

History
29 lines (20 loc) · 1.82 KB

README.md

File metadata and controls

29 lines (20 loc) · 1.82 KB
Raw

validate-conventional-commit

Smallest simplest conventional commit validator to use with eg husky

npm version npm downloads neostandard javascript style Types in JS Follow @voxpelli@mastodon.social

Usage

npx --no validate-conventional-commit < .git/COMMIT_EDITMSG

Add --strict to also require the commit type to be one of the exact conventional commit types (build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test), eg to catch test: vs tests: or testing::

npx --no validate-conventional-commit --strict < .git/COMMIT_EDITMSG

(Or simply just copy and paste the cli.js file into your project if you want to avoid a dependency)

Related modules

  • @commitlint/cli – a much more comprehensive and much more heavy alternative
  • husky – my preferred git hook manager
  • mtfoley/pr-compliance-action – an action that helps validating conventional commit style in PR:s, something this module is not really geared towards