# validate-commit-message

> GIT COMMIT-MSG hook for validating commit message.

Latest version **3.2.0** (published 2021-03-22) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install validate-commit-message
pnpm add validate-commit-message
yarn add validate-commit-message
bun add validate-commit-message
```

Provides the command `validate-commit-msg`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.2.0 |
| Published | 2021-03-22 |
| First published | 2015-09-05 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 39 |
| Author | Frederik Krautwald |
| Maintainers | frikki |
| Keywords | git, message validation |

## Links

- npm: https://www.npmjs.com/package/validate-commit-message
- Repository: https://github.com/Frikki/validate-commit-message
- Homepage: https://github.com/Frikki/validate-commit-message#readme
- Issues: https://github.com/Frikki/validate-commit-message/issues
- npm.io page: https://npm.io/package/validate-commit-message

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 3.2.0 (latest) — 2021-03-22
- 3.0.1 — 2015-09-08
- 3.0.0 — 2015-09-06
- 2.0.0 — 2015-09-05
- 1.0.0 — 2015-09-05

## README

# validate-commit-message
GIT COMMIT-MSG hook for validating commit message.

`$ validate-commit-msg` creates a symbolic link `.git/hooks/commit-msg` 
to `./lib/validate-commit-msg.js` which is executed on every commit.

The hook script validates commit messages on each commit according 
to [the AngularJS commit message guidelines]. 

## Installation

```shell
$ npm install validate-commit-message
```

## Usage

You can activate the hook from the command line of your project.

```shell
$ node ./node_modules/.bin/validate-commit-msg
```

A more consistent way is to add a script in your `package.json`.

```
"scripts": {
  "init": "validate-commit-msg"
}
```

Then execute `$ npm run init`.

[the AngularJS commit message guidelines]: https://docs.google.com/document/d/1rk04jEuGfk9kYzfqCuOlPTSJw3hEDZJTBN5E5f1SALo

---
_Source: https://npm.io/package/validate-commit-message · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._