Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hunghg255/verify-commit-msg

Verify Commit Message
https://github.com/hunghg255/verify-commit-msg

git husky npm package

Last synced: 3 months ago
JSON representation

Verify Commit Message

Awesome Lists containing this project

README

        



logo


A script to verify the commit message format.


NPM Version
NPM Downloads
Minizip
Contributors
License

## Git Commit Message Convention

> This is adapted from [Commit convention](https://www.conventionalcommits.org/en/v1.0.0/).

## Installation

```bash
npm i verify-commit-msg -D
```

## Usage with `git-scm-hooks`

[git-scm-hooks](https://github.com/hunghg255/git-scm-hooks)

```bash
npm pkg set scripts.verify-commit=verify-commit-msg
npm pkg set git-hooks.commit-msg="npm run verify-commit"
```

## Usage with `husky`

### Config `.husky/commit-msg`

- Bash
```bash
npm pkg set scripts.verify-commit=verify-commit-msg
npx husky add .husky/commit-msg "npm run verify-commit"
```

- Or manually update `.husky/commit-msg`

```bash
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npm run verify-commit
```