commitplease
Advanced tools
Comparing version 2.7.1-0 to 2.7.2
{ | ||
"name": "commitplease", | ||
"version": "2.7.1-0", | ||
"version": "2.7.2", | ||
"description": "Validates strings as commit messages", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -31,2 +31,12 @@ # Commitplease | ||
You could also install a global commitplease executable and put it into a `package.json` script or as a git hook of your choice. Here is an example with a `pre-push` hook: | ||
``` | ||
#!/bin/sh | ||
npm run commitplease --silent | ||
``` | ||
And `chmod +x .git/hooks/pre-push`. Now each time you do a `git push`, the hook will be checking **all** commits on current branch. | ||
## Usage | ||
@@ -41,3 +51,3 @@ | ||
Another special scenario is to do `git commit --no-verify` which will skip the commit-msg hook and bypass commitplease. | ||
Other ways to make your commit messages special and bypass style checks are [described below](#skip-style-check). | ||
@@ -58,2 +68,3 @@ Non-special commit messages must follow one of the style guides ([jQuery Commit Guidelines][1] by default) | ||
| Check all commits on branch `feature` that are not on `master` | `commitplease master..feature` | | ||
| Check all commits on current branch that are not on `master` | `commitplease master..HEAD` | | ||
| Check the latest 1 commit | `commitplease -1` | | ||
@@ -135,2 +146,11 @@ | Check all commits between `84991d` and `2021ce` | `commitplease 84991d..2021ce` | | ||
## Skip style check | ||
This paragraph assumes that you would like to skip the style check that happens during `git commit`. One way to do so is to type `git commit --no-verify` that will skip a few git hooks, including the one used by commitplease. If skipping many hooks is not what you want or you find yourself doing it too many times, just set the `nohook` option. You could set that inside `package.json` as described at the beginning of the [setup section](#setup). However, if modifying `package.json` is not possible, just set it in `.npmrc` (it will overwrite `package.json`) like so: | ||
``` | ||
[commitplease] | ||
nohook = true | ||
``` | ||
## Husky | ||
@@ -137,0 +157,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
44717
1
249