https://github.com/voxpelli/validate-conventional-commit

Smallest simplest conventional commit validator to use with eg Husky
https://github.com/voxpelli/validate-conventional-commit

cli commit-msg commit-msg-linter conventional-commit conventional-commits git-hooks husky validation

Last synced: 5 months ago
JSON representation

Smallest simplest conventional commit validator to use with eg Husky

• Host: GitHub
• URL: https://github.com/voxpelli/validate-conventional-commit
• Owner: voxpelli
• License: 0bsd
• Created: 2023-05-23T12:20:36.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-04T19:50:21.000Z (5 months ago)
• Last Synced: 2025-01-04T20:29:17.544Z (5 months ago)
• Topics: cli, commit-msg, commit-msg-linter, conventional-commit, conventional-commits, git-hooks, husky, validation
• Language: JavaScript
• Homepage:
• Size: 27.3 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# validate-conventional-commit

Smallest simplest conventional commit validator to use with eg [`husky`](https://github.com/typicode/husky)

[![npm version](https://img.shields.io/npm/v/validate-conventional-commit.svg?style=flat)](https://www.npmjs.com/package/validate-conventional-commit)

[![npm downloads](https://img.shields.io/npm/dm/validate-conventional-commit.svg?style=flat)](https://www.npmjs.com/package/validate-conventional-commit)

[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-7fffff?style=flat&labelColor=ff80ff)](https://github.com/neostandard/neostandard)

[![Types in JS](https://img.shields.io/badge/types_in_js-yes-brightgreen)](https://github.com/voxpelli/types-in-js)

[![Follow @[email protected]](https://img.shields.io/mastodon/follow/109247025527949675?domain=https%3A%2F%2Fmastodon.social&style=social)](https://mastodon.social/@voxpelli)

## Usage

```bash

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

```

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

## Related modules

* [`@commitlint/cli`](https://www.npmjs.com/package/@commitlint/cli) – a much more comprehensive and much more heavy alternative

* [`husky`](https://github.com/typicode/husky) – my preferred git hook manager

* [`mtfoley/pr-compliance-action`](https://github.com/mtfoley/pr-compliance-action) – an action that helps validating conventional commit style in PR:s, something this module is not really geared towards