1 | > commitizen adapter using commitlint.config.js
|
2 |
|
3 | # @commitlint/prompt
|
4 |
|
5 | This is the library and commitizen adapter version of commitlint prompt.
|
6 | A ready-to-use cli version is available at [@commitlint/prompt-cli](../prompt-cli).
|
7 | Learn how to use it at [docs/prompt](https://conventional-changelog.github.io/commitlint/#/guides-use-prompt).
|
8 |
|
9 | ## Getting started
|
10 |
|
11 | ```bash
|
12 | npm install --save-dev @commitlint/prompt @commitlint/config-conventional commitizen
|
13 | echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
|
14 | ```
|
15 |
|
16 | In package.json
|
17 |
|
18 | ```
|
19 | {
|
20 | "scripts": {
|
21 | "commit": "git-cz"
|
22 | },
|
23 | "config": {
|
24 | "commitizen": {
|
25 | "path": "@commitlint/prompt"
|
26 | }
|
27 | }
|
28 | }
|
29 | ```
|
30 |
|
31 | ```bash
|
32 | git add .
|
33 | npm run commit
|
34 | ```
|