Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alan-agius4/speedy-commit-msg-hook
Git commit message hook
https://github.com/alan-agius4/speedy-commit-msg-hook
commit commit-conventions commit-hooks commit-message commit-msg conventions git hook hooks standards
Last synced: 7 days ago
JSON representation
Git commit message hook
- Host: GitHub
- URL: https://github.com/alan-agius4/speedy-commit-msg-hook
- Owner: alan-agius4
- Created: 2017-03-23T18:05:40.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-06-22T05:15:34.000Z (over 2 years ago)
- Last Synced: 2024-10-24T15:55:23.328Z (15 days ago)
- Topics: commit, commit-conventions, commit-hooks, commit-message, commit-msg, conventions, git, hook, hooks, standards
- Language: TypeScript
- Homepage:
- Size: 170 KB
- Stars: 6
- Watchers: 3
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# @speedy/commit-msg-hook
[](https://circleci.com/gh/alan-agius4/speedy-commit-msg-hook)
[](https://www.npmjs.com/package/@speedy/commit-msg-hook)
[](https://david-dm.org/alan-agius4/speedy-commit-msg-hook)
[](https://david-dm.org/alan-agius4/speedy-commit-msg-hook?type=dev)
A highly customizable git commit message hook. Validates a commit message against a set of configuration, based on the [`Conventional Changelog`](https://github.com/conventional-changelog/conventional-changelog) standards.
Commit first line format:
```txt
():
```
## Installation
```
npm install @speedy/commit-msg-hook --save-dev
```
## Rules
The majority of the rules can be applied in any part of the configuration.
| Name | Description | Type | Section |
|--------------------|--------------------------------------------------------------------------------------------------------|----------|---------|
| `no-unscoped` | Disallows unscoped commit messages | boolean | Message |
| `skip-validation` | Disable validation for commit messages matching a RegExp. Useful for `Merge` and `Revert` commits) | RegExp | Message |
| `valid-types` | An array of allowed commit message types ex: `["feat", "chore"]` | string[] | Type |
| `valid-scopes` | An array of allowed commit message scopes ex: `["router", "platform"]` (Case sensitive) | string[] | Scope |
| `banned-phrases` | An array of disallowed phrases. (Case insensitive) | string[] | All |
| `max-length` | Requires text to be under a certain max length | number | All |
| `no-dash` | Disallows dashes | boolean | All |
| `no-space` | Disallows spaces | boolean | All |
| `no-underscore` | Disallows underscores | boolean | All |
| `no-camel-case` | Disallows camel cases | boolean | All |
| `no-kebab-case` | Disallows kebab case | boolean | All |
| `no-upper-first` | Enforces first character to be lower case | boolean | All |
| `no-lower-first` | Enforces first character to be upper case | boolean | All |
| `no-period-at-end` | Enforces last character not to be a period | boolean | All |
## Configuration
By default, will try to locate the `speedy-commit-msg.json` file in the root of your project folder.
If the file is not found it will fallback to an internal `speedy-commit-msg.json` found in `config` folder.
### Default rules
[speedy-commit-msg.json](https://github.com/alan-agius4/speedy-commit-msg-hook/blob/master/config/speedy-commit-msg.json).
```json
{
"rules": {
"message": {
"skip-validation": "^(Merge)\\s",
"max-length": 100,
"banned-phrases": [
"minor change",
"minor fix",
"minor refactor",
"pr change",
"pr comment",
"following pr"
],
"no-period-at-end": true,
"no-upper-first": true
},
"type": {
"valid-types": [
"feat",
"fix",
"docs",
"style",
"refactor",
"perf",
"test",
"chore",
"revert"
]
},
"scope": {
"no-dash": true,
"no-underscore": true
},
"subject": {
"no-period-at-end": true,
"no-upper-first": true
}
}
}
```
### extends
Configuration can be extended with one or many existing configurations.
```json
{
"extends": [
"@speedy/commit-msg-hook:latest"
],
"rules": {
"message": {
"no-unscoped": true
},
"scope": {
"no-dash": false
}
}
}
```