commitplease | Validates strings as commit messages
kandi X-RAY | commitplease Summary
kandi X-RAY | commitplease Summary
commitplease is a JavaScript library. commitplease has no bugs, it has no vulnerabilities and it has low support. You can install using 'npm i commitplease' or download it from GitHub, npm.
This node.js module makes sure your git commit messages consistently follow one of these style guides:. You can also make customized validation rules based on those styles.
This node.js module makes sure your git commit messages consistently follow one of these style guides:. You can also make customized validation rules based on those styles.
Support
Quality
Security
License
Reuse
Support
commitplease has a low active ecosystem.
It has 85 star(s) with 19 fork(s). There are 4 watchers for this library.
It had no major release in the last 12 months.
There are 6 open issues and 63 have been closed. On average issues are closed in 142 days. There are 1 open pull requests and 0 closed requests.
It has a neutral sentiment in the developer community.
The latest version of commitplease is 3.2.0
Quality
commitplease has no bugs reported.
Security
commitplease has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.
License
commitplease does not have a standard license declared.
Check the repository for any license declaration and review the terms closely.
Without a license, all rights are reserved, and you cannot use the library in your applications.
Reuse
commitplease releases are available to install and integrate.
Deployable package is available in npm.
Installation instructions, examples and code snippets are available.
Top functions reviewed by kandi - BETA
kandi's functional review helps you automatically verify the functionalities of the libraries and avoid rework.
Currently covering the most popular Java, JavaScript and Python libraries. See a Sample of commitplease
Currently covering the most popular Java, JavaScript and Python libraries. See a Sample of commitplease
commitplease Key Features
No Key Features are available at this moment for commitplease.
commitplease Examples and Code Snippets
No Code Snippets are available at this moment for commitplease.
Community Discussions
No Community Discussions are available at this moment for commitplease.Refer to stack overflow page for discussions.
Community Discussions, Code Snippets contain sources that include Stack Exchange Network
Vulnerabilities
No vulnerabilities reported
Install commitplease
Commitplease can be installed locally or globally (or both):.
Commit as usual. Git will trigger commitplease to check your commit message for errors. Invalid messages will prevent the commit, with details about what went wrong and a copy of the input.
Navigate to your repository and run the global commitplease executable. By default, it will check all the commit messages. Other examples include (just anything you can pass to git log really):. Here you can read more about git commit ranges.
You can configure commitplease from package.json of your project. Here are the options common for all style guidelines:.
limits.firstLine and limits.otherLine are the hard limits for the number of symbols on the first line and on other lines of the commit message, respectively.
"nohook": false tells commitplease to install its commit-msg hook. Setting "nohook": true makes commitplease skip installing the hook or skip running the hook if it has already been installed. This can be used when wrapping the commitplease validation API into another module, like a grunt plugin or husky. This setting does not affect the global commitplease executable, only repo-local.
markerPattern: A (intentionally loose) RegExp that indicates that the line might be a ticket reference. Case insensitive.
actionPattern: A RegExp that makes a line marked by markerPattern valid even if the line does not fit ticketPattern
ticketPattern: A RegExp that detects ticket references: Closes gh-1, Fixes gh-42, WEB-451 and similar.
Commit as usual. Git will trigger commitplease to check your commit message for errors. Invalid messages will prevent the commit, with details about what went wrong and a copy of the input.
Navigate to your repository and run the global commitplease executable. By default, it will check all the commit messages. Other examples include (just anything you can pass to git log really):. Here you can read more about git commit ranges.
You can configure commitplease from package.json of your project. Here are the options common for all style guidelines:.
limits.firstLine and limits.otherLine are the hard limits for the number of symbols on the first line and on other lines of the commit message, respectively.
"nohook": false tells commitplease to install its commit-msg hook. Setting "nohook": true makes commitplease skip installing the hook or skip running the hook if it has already been installed. This can be used when wrapping the commitplease validation API into another module, like a grunt plugin or husky. This setting does not affect the global commitplease executable, only repo-local.
markerPattern: A (intentionally loose) RegExp that indicates that the line might be a ticket reference. Case insensitive.
actionPattern: A RegExp that makes a line marked by markerPattern valid even if the line does not fit ticketPattern
ticketPattern: A RegExp that detects ticket references: Closes gh-1, Fixes gh-42, WEB-451 and similar.
Support
For any new features, suggestions and bugs create an issue on GitHub.
If you have any questions check and ask questions on community page Stack Overflow .
Find more information at:
Reuse Trending Solutions
Find, review, and download reusable Libraries, Code Snippets, Cloud APIs from over 650 million Knowledge Items
Find more librariesStay Updated
Subscribe to our newsletter for trending solutions and developer bootcamps
Share this Page