cz-format-extension
Extensible Commitizen's format
## Usage
```
npm install -D commitizen cz-format-extension
```
Make `.czrc` or add `config` fields into package.json
`.czrc`
```json
{
"path": "cz-format-extension"
}
```
`package.json`
```json
{
"config": {
"commitizen": {
"path": "cz-format-extension"
}
}
}
```
### Create Config file
Make `.czferc.js`
```js
module.exports = {
questions({inquirer, gitInfo}) {
return [
{...},
{...},
]
},
commitMessage({answers, gitInfo}) {
return ...
}
}
```
- questions
- params
- [inquirer](https://github.com/SBoudrias/Inquirer.js)
- [gitInfo](https://github.com/rwjblue/git-repo-info) + `not_added`, `created`, `deleted`, `modified`, `renamed`, `staged` from [StatusResult](https://github.com/steveukx/git-js/blob/master/typings/response.d.ts) of [simple-git](https://github.com/steveukx/git-js)
- return
- [Question Object](https://github.com/SBoudrias/Inquirer.js#question)
- commitMessage
- params
- [answers](https://github.com/SBoudrias/Inquirer.js#answers)
- [gitInfo](https://github.com/rwjblue/git-repo-info) + `not_added`, `created`, `deleted`, `modified`, `renamed`, `staged` from [StatusResult](https://github.com/steveukx/git-js/blob/master/typings/response.d.ts) of [simple-git](https://github.com/steveukx/git-js)
- return
- string
We prepare [the example](https://github.com/tyankatsu0105/cz-format-extension/tree/master/example).
#### Tips: Configuration settings with types
If you love to develop with types, you can use that with `JSDocs`.
```js
/**
* @typedef {{questionType1: string; questionType2: string}} Answers
*/
/** @type import('cz-format-extension').Config */
module.exports = {
questions({inquirer, gitInfo}) {
return [
{
type: "list",
name: "questionType1",
message: "Select answer",
choices: [
{...},
{...}
]
},
]
},
commitMessage({answers, gitInfo}) {
return `${answers.questionType1}${answers.questionType2}`
}
}
```
## Inspired by
- [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog)
- [cz-conventional-changelog-ja](https://github.com/AquiTCD/cz-conventional-changelog-ja)