https://github.com/nodejs/core-validate-commit
Validate commit messages for Node.js core
https://github.com/nodejs/core-validate-commit
node nodejs
Last synced: about 1 year ago
JSON representation
Validate commit messages for Node.js core
- Host: GitHub
- URL: https://github.com/nodejs/core-validate-commit
- Owner: nodejs
- License: mit
- Created: 2016-04-21T13:56:46.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-12-21T09:32:38.000Z (over 1 year ago)
- Last Synced: 2025-05-08T11:29:38.869Z (about 1 year ago)
- Topics: node, nodejs
- Language: JavaScript
- Homepage:
- Size: 315 KB
- Stars: 54
- Watchers: 9
- Forks: 52
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# core-validate-commit
[](https://github.com/nodejs/core-validate-commit/actions/workflows/node.js.yml)
[](https://codecov.io/gh/nodejs/core-validate-commit)
Validate the commit message for a particular commit in node core
## Install
```bash
$ npm install [-g] core-validate-commit
```
## Usage
```bash
# for a single commit
$ core-validate-commit
# validate since
$ git rev-list ..HEAD | xargs core-validate-commit
# list all rules
$ core-validate-commit --list
fixes-url enforce format of Fixes URLs
line-after-title enforce a blank newline after the commit title
line-length enforce max length of lines in commit body
metadata-end enforce that metadata is at the end of commit messages
pr-url enforce PR-URL
reviewers enforce having reviewers
subsystem enforce subsystem validity
title-format enforce commit title format
title-length enforce max length of commit title
```
To see a list of valid subsystems:
```bash
$ core-validate-commit --list-subsystem
```
Valid subsystems are also defined in [lib/rules/subsystem.js](./lib/rules/subsystem.js).
## Test
```bash
$ npm test
```
## Author
Evan Lucas
## License
MIT (See `LICENSE` for more info)