JSPM

  • Created
  • Published
  • Downloads 35774
  • Score
    100M100P100Q160898F
  • License MIT

git commit message linter hook

Package Exports

  • git-commit-msg-linter

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 (git-commit-msg-linter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

git-commit-msg-linter

Watching your every git commit message. 👀

git-commit-msg-linter-demo

A git "commit-msg" hook for linting your git commit message against the Angular Commit Message Guidelines. As a hook it will run at every commiting to make sure that your every commit message is valid against the conventions. If not the commit will be aborted.

The repo is heavily influenced by pre-commit. Thanks.

Install

npm install git-commit-msg-linter --save-dev

To uninstall run the uninstall script instead of removing it manually because only in this way, the old commit-msg hook can be restored, then your next commit messages can be ignored by git-commit-msg-linter.

npm uninstall git-commit-msg-linter --save-dev

Why yet a new linter

Firstly it's very important to follow certain git commit message conventions and we recommend Angular's.

Secondly no simple git commit message hook ever exists right now. To Add, to overwrite or to remove types is not so friendly supported. Why not conventional-changelog/commitlint, read the FAQs.

<type>(<scope>): <subject>

// scope optional

Documentations

Configuration and FAQs.