Conventional commit message wizard and validator; works with commitizen and pre-git
!Build statusconventional-commit-message-ci-image conventional-commit-message-ci-url !dependenciesconventional-commit-message-dependencies-image conventional-commit-message-dependencies-url !devdependenciesconventional-commit-message-devdependencies-image conventional-commit-message-devdependencies-url !semantic-releasesemantic-image semantic-url
PurposeThis module can:
- parse conventional commit message of the type
- validate a given message if it fits the above simple format
- guide the user with questions in order to form well formatted message
The validation was copied from validate-commit-msg, and the wizard is used from cz-conventional-changelog.
Install and use
See simple-commit-message for API details.
npm install --save conventional-commit-message
Small printAuthor: Gleb Bahmutov © 2015
License: MIT - do anything with the code, but don't blame me if it does not work.
Spread the word: tweet, star on github, etc.
Support: if you find any problems with this module, email / tweet / open issue on Github
MIT LicenseCopyright (c) 2015 Gleb Bahmutov
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.