https://github.com/stormwarning/cz-adapter-eslint
🔌 A commitizen adapter for the conventional-changelog eslint preset.
https://github.com/stormwarning/cz-adapter-eslint
commitizen-adapter conventional-changelog
Last synced: about 1 year ago
JSON representation
🔌 A commitizen adapter for the conventional-changelog eslint preset.
- Host: GitHub
- URL: https://github.com/stormwarning/cz-adapter-eslint
- Owner: stormwarning
- Created: 2017-11-17T17:52:46.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-08-01T12:17:02.000Z (almost 5 years ago)
- Last Synced: 2025-03-17T02:03:02.573Z (about 1 year ago)
- Topics: commitizen-adapter, conventional-changelog
- Language: JavaScript
- Homepage:
- Size: 1.33 MB
- Stars: 3
- Watchers: 2
- Forks: 7
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cz-adapter-eslint
[![npm version][npm-img]][npm-url]
[![npm downloads][dls-img]][npm-url]
A [commitizen][] adapter for the conventional-changelog [eslint preset][].
## Installation
### Global
```sh
npm install --global cz-adapter-eslint
# Set as the default adapter.
echo '{ "path": "cz-adapter-eslint" }' > ~/.czrc
```
### Local
```sh
npm install --save-dev cz-adapter-eslint
```
```json
"config": {
"commitizen": {
"path": "./node_modules/cz-adapter-eslint"
}
}
```
## Usage
Once installed, stage your changes and run
```sh
git cz
```
instead of `git commit`.
[npm-url]: https://www.npmjs.com/package/cz-adapter-eslint
[npm-img]: https://img.shields.io/npm/v/cz-adapter-eslint.svg?style=flat-square
[dls-img]: https://img.shields.io/npm/dw/cz-adapter-eslint.svg?style=flat-square
[commitizen]: https://github.com/commitizen/cz-cli
[eslint preset]: https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-eslint