# conventional-commit-message > Conventional commit message wizard and validator; works with commitizen and pre-git Latest version **1.1.0** (published 2015-12-09) · MIT license · 0 weekly downloads ## Install ```sh npm install conventional-commit-message pnpm add conventional-commit-message yarn add conventional-commit-message bun add conventional-commit-message ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 1.1.0 | | Published | 2015-12-09 | | First published | 2015-12-09 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 4 | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 11 | | Author | Gleb Bahmutov | | Maintainers | bahmutov | | Keywords | commit, message, validation, wizard, pre-git, commitizen | ## Links - npm: https://www.npmjs.com/package/conventional-commit-message - Repository: https://github.com/bahmutov/conventional-commit-message - Homepage: https://github.com/bahmutov/conventional-commit-message#readme - Issues: https://github.com/bahmutov/conventional-commit-message/issues - npm.io page: https://npm.io/package/conventional-commit-message ## Dependencies (4) - [lazy-ass](https://npm.io/package/lazy-ass.md) 1.3.0 - [word-wrap](https://npm.io/package/word-wrap.md) 1.1.0 - [check-more-types](https://npm.io/package/check-more-types.md) 2.3.0 - [cz-conventional-changelog](https://npm.io/package/cz-conventional-changelog.md) 1.1.5 ## Alternatives - [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads - [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads - [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads - [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads - [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads ## Recent versions - 1.1.0 (latest) — 2015-12-09 - 1.0.0 — 2015-12-09 ## README # conventional-commit-message > Conventional commit message wizard and validator; > works with commitizen and pre-git [![NPM][conventional-commit-message-icon] ][conventional-commit-message-url] [![Build status][conventional-commit-message-ci-image] ][conventional-commit-message-ci-url] [![dependencies][conventional-commit-message-dependencies-image] ][conventional-commit-message-dependencies-url] [![devdependencies][conventional-commit-message-devdependencies-image] ][conventional-commit-message-devdependencies-url] [![semantic-release][semantic-image] ][semantic-url] [![manpm](https://img.shields.io/badge/manpm-%E2%9C%93-3399ff.svg)](https://github.com/bahmutov/manpm) [![standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) ## Purpose This module can: * parse conventional commit message of the type `type(scope): message` * 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](https://www.npmjs.com/package/validate-commit-msg), and the wizard is used from [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog). ## Install and use npm install --save conventional-commit-message See [simple-commit-message](https://github.com/bahmutov/simple-commit-message) for API details. ### Small print Author: Gleb Bahmutov © 2015 * [@bahmutov](https://twitter.com/bahmutov) * [glebbahmutov.com](http://glebbahmutov.com) * [blog](http://glebbahmutov.com/blog/) 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](https://github.com/bahmutov/conventional-commit-message/issues) on Github ## MIT License Copyright (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. [conventional-commit-message-icon]: https://nodei.co/npm/conventional-commit-message.png?downloads=true [conventional-commit-message-url]: https://npmjs.org/package/conventional-commit-message [conventional-commit-message-ci-image]: https://travis-ci.org/bahmutov/conventional-commit-message.png?branch=master [conventional-commit-message-ci-url]: https://travis-ci.org/bahmutov/conventional-commit-message [conventional-commit-message-dependencies-image]: https://david-dm.org/bahmutov/conventional-commit-message.png [conventional-commit-message-dependencies-url]: https://david-dm.org/bahmutov/conventional-commit-message [conventional-commit-message-devdependencies-image]: https://david-dm.org/bahmutov/conventional-commit-message/dev-status.png [conventional-commit-message-devdependencies-url]: https://david-dm.org/bahmutov/conventional-commit-message#info=devDependencies [semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg [semantic-url]: https://github.com/semantic-release/semantic-release --- _Source: https://npm.io/package/conventional-commit-message · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._