Skip to content

Commit febeba9

Browse files
Zhengqbbbchrisbbreuer
Zhengqbbb
and
chrisbbreuer
authored
fix(cz-git,czg)!: fix typo option issuePrefixs field #82 (#84)
 BREAKING CHANGE: Main fix `issuePrefixs` typo field Current version has been already processed for **normal compatibility** But I also hope that you can modify this message as soon as possible ```diff { message: { - footerPrefixsSelect + footerPrefixesSelect - customFooterPrefixs + customFooterPrefix } - issuePrefixs + issuePrefixes - customIssuePrefixsAlign + customIssuePrefixAlign - emptyIssuePrefixsAlias + emptyIssuePrefixAlias - customIssuePrefixsAlias + customIssuePrefixAlias - allowCustomIssuePrefixs + allowCustomIssuePrefix - allowEmptyIssuePrefixs + allowEmptyIssuePrefix } ``` Co-authored-by: Chris < chrisbbreuer@users.noreply.github.com>
1 parent 2e0476c commit febeba9

28 files changed

Lines changed: 273 additions & 198 deletions

File tree

‎.commitlintrc.cjs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ module.exports = {
4242
{ value: 'link', name: 'link: Work in processing to ISSUES' },
4343
{ value: 'closed', name: 'closed: ISSUES has been processed' },
4444
],
45-
customIssuePrefixsAlign: !issue ? 'top' : 'bottom',
45+
customIssuePrefixAlign: !issue ? 'top' : 'bottom',
4646
defaultIssues: !issue ? '' : `#${issue}`,
4747
formatMessageCB: ({ defaultMessage }) => defaultMessage + coAuthoredBy,
4848
},

‎.vscode/settings.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,25 @@
3131
},
3232
"picgo.picBed.github.path": "cz/",
3333
"editor.formatOnSave": false,
34+
"cSpell.files": [
35+
"packages/cz-git/src/shared/types/options.ts",
36+
"README.md",
37+
"docs/**/*"
38+
],
39+
"cSpell.words": [
40+
"BREAKCHANGE",
41+
"BREAKINGCHANGE",
42+
"BREAKINGCHANGES",
43+
"breakline",
44+
"Commitlint",
45+
"commitlintrc",
46+
"czrc",
47+
"gitbash",
48+
"Gitee",
49+
"Qiubin",
50+
"readdir",
51+
"USERPROFILE",
52+
"Zheng",
53+
"Zhengqbbb"
54+
],
3455
}

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ More engineered, lightweight, customizable, standard output format [commitizen a
6363
- 💪 Just to be a **lazy man** !!! Friendly command line tool, Supports **search and selection** on the command line, reducing spelling errors.
6464
- ⚡️ **Lightweight**, **Highly Customizable**, but the output format follows the standard [Angular commit](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) specification.
6565
- 🔨 [Better for monorepo engineering](https://cz-git.qbb.sh/recipes/#scopes) and **commitlint** project to give relevant verification information to the command line.
66-
- ✅ Support commit with **emoji** ｜ Better linking with [issuePrefixs](https://cz-git.qbb.sh/recipes/default-issues.html) **for issue**
66+
- ✅ Support commit with **emoji** ｜ Better linking with [issuePrefix](https://cz-git.qbb.sh/recipes/default-issues.html) **for issue**
6767

6868
[⇒ Why cz-git](https://cz-git.qbb.sh/guide/why.html)
6969

‎docs/.vitepress/config/sidebar/zh.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ export const zh: DefaultTheme.Sidebar = {
121121
link: '/zh/recipes/breakingchange',
122122
},
123123
{
124-
text: 'issuePrefixs',
124+
text: 'issuePrefixes',
125125
link: '/zh/recipes/issue-prefixs',
126126
},
127127
{

‎docs/config/engineer.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,21 +134,21 @@ If commitlint is used, it will automatically read `body-max-line-length` and set
134134
- **type** : `Array<"scope" | "body" | "breaking" | "footerPrefix" | "footer">`
135135
- **default** : `[]`
136136

137-
## issuePrefixs
137+
## issuePrefixes
138138

139139
- **description** : custom select issue prefix
140140
- **type** : `Array<{ value: string, name: string }>`
141141
- **default** : `[{ value: "closed", name: "closed: ISSUES has been processed" }]`
142142

143-
## allowCustomIssuePrefixs
143+
## allowCustomIssuePrefix
144144

145-
- **description** : whether to display custom options when selecting ISSUES prefixs (custom)
145+
- **description** : whether to display custom options when selecting ISSUES prefix (custom)
146146
- **type** : `boolean`
147147
- **default** : `true`
148148

149-
## allowEmptyIssuePrefixs
149+
## allowEmptyIssuePrefix
150150

151-
- **description** : whether to display an empty option when selecting ISSUES prefixs (skip)
151+
- **description** : whether to display an empty option when selecting ISSUES prefix (skip)
152152
- **type** : `boolean`
153153
- **default** : `true`
154154

‎docs/config/index.md‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ module.exports = {
3333
subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
3434
body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
3535
breaking: 'List any BREAKING CHANGES (optional). Use "|" to break new line:\n',
36-
footerPrefixsSelect: 'Select the ISSUES type of changeList by this change (optional):',
37-
customFooterPrefixs: 'Input ISSUES prefix:',
36+
footerPrefixSelect: 'Select the ISSUES type of changeList by this change (optional):',
37+
customFooterPrefix: 'Input ISSUES prefix:',
3838
footer: 'List any ISSUES by this change. E.g.: #31, #34:\n',
3939
confirmCommit: 'Are you sure you want to proceed with the commit above?'
4040
},
@@ -66,12 +66,12 @@ module.exports = {
6666
breaklineNumber: 100,
6767
breaklineChar: '|',
6868
skipQuestions: [],
69-
issuePrefixs: [{ value: 'closed', name: 'closed: ISSUES has been processed' }],
70-
customIssuePrefixsAlign: 'top',
71-
emptyIssuePrefixsAlias: 'skip',
72-
customIssuePrefixsAlias: 'custom',
73-
allowCustomIssuePrefixs: true,
74-
allowEmptyIssuePrefixs: true,
69+
issuePrefixes: [{ value: 'closed', name: 'closed: ISSUES has been processed' }],
70+
customIssuePrefixAlign: 'top',
71+
emptyIssuePrefixAlias: 'skip',
72+
customIssuePrefixAlias: 'custom',
73+
allowCustomIssuePrefix: true,
74+
allowEmptyIssuePrefix: true,
7575
confirmColorize: true,
7676
maxHeaderLength: Infinity,
7777
maxSubjectLength: Infinity,
@@ -106,8 +106,8 @@ module.exports = {
106106
subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
107107
body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
108108
breaking: 'List any BREAKING CHANGES (optional). Use "|" to break new line:\n',
109-
footerPrefixsSelect: 'Select the ISSUES type of changeList by this change (optional):',
110-
customFooterPrefixs: 'Input ISSUES prefix:',
109+
footerPrefixesSelect: 'Select the ISSUES type of changeList by this change (optional):',
110+
customFooterPrefix: 'Input ISSUES prefix:',
111111
footer: 'List any ISSUES by this change. E.g.: #31, #34:\n',
112112
confirmCommit: 'Are you sure you want to proceed with the commit above?'
113113
},
@@ -139,12 +139,12 @@ module.exports = {
139139
breaklineNumber: 100,
140140
breaklineChar: '|',
141141
skipQuestions: [],
142-
issuePrefixs: [{ value: 'closed', name: 'closed: ISSUES has been processed' }],
143-
customIssuePrefixsAlign: 'top',
144-
emptyIssuePrefixsAlias: 'skip',
145-
customIssuePrefixsAlias: 'custom',
146-
allowCustomIssuePrefixs: true,
147-
allowEmptyIssuePrefixs: true,
142+
issuePrefixes: [{ value: 'closed', name: 'closed: ISSUES has been processed' }],
143+
customIssuePrefixAlign: 'top',
144+
emptyIssuePrefixAlias: 'skip',
145+
customIssuePrefixAlias: 'custom',
146+
allowCustomIssuePrefix: true,
147+
allowEmptyIssuePrefix: true,
148148
confirmColorize: true,
149149
maxHeaderLength: Infinity,
150150
maxSubjectLength: Infinity,
@@ -195,8 +195,8 @@ module.exports = {
195195
subject: "Write a SHORT, IMPERATIVE tense description of the change:\n",
196196
body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
197197
breaking: 'List any BREAKING CHANGES (optional). Use "|" to break new line:\n',
198-
footerPrefixsSelect: "Select the ISSUES type of changeList by this change (optional):",
199-
customFooterPrefixs: "Input ISSUES prefix:",
198+
footerPrefixesSelect: "Select the ISSUES type of changeList by this change (optional):",
199+
customFooterPrefix: "Input ISSUES prefix:",
200200
footer: "List any ISSUES by this change. E.g.: #31, #34:\n",
201201
confirmCommit: "Are you sure you want to proceed with the commit above?"
202202
},
@@ -228,12 +228,12 @@ module.exports = {
228228
breaklineNumber: 100,
229229
breaklineChar: "|",
230230
skipQuestions: [],
231-
issuePrefixs: [{ value: "closed", name: "closed: ISSUES has been processed" }],
232-
customIssuePrefixsAlign: "top",
233-
emptyIssuePrefixsAlias: "skip",
234-
customIssuePrefixsAlias: "custom",
235-
allowCustomIssuePrefixs: true,
236-
allowEmptyIssuePrefixs: true,
231+
issuePrefixes: [{ value: "closed", name: "closed: ISSUES has been processed" }],
232+
customIssuePrefixAlign: "top",
233+
emptyIssuePrefixAlias: "skip",
234+
customIssuePrefixAlias: "custom",
235+
allowCustomIssuePrefix: true,
236+
allowEmptyIssuePrefix: true,
237237
confirmColorize: true,
238238
maxHeaderLength: Infinity,
239239
maxSubjectLength: Infinity,
@@ -274,8 +274,8 @@ It is recommended to use JavaScript for configuration files in the project. You
274274
"subject": "Write a SHORT, IMPERATIVE tense description of the change:\n",
275275
"body": "Provide a LONGER description of the change (optional). Use \"|\" to break new line:\n",
276276
"breaking": "List any BREAKING CHANGES (optional). Use \"|\" to break new line:\n",
277-
"footerPrefixsSelect": "Select the ISSUES type of changeList by this change (optional):",
278-
"customFooterPrefixs": "Input ISSUES prefix:",
277+
"footerPrefixesSelect": "Select the ISSUES type of changeList by this change (optional):",
278+
"customFooterPrefix": "Input ISSUES prefix:",
279279
"footer": "List any ISSUES by this change. E.g.: #31, #34:\n",
280280
"confirmCommit": "Are you sure you want to proceed with the commit above?"
281281
},
@@ -307,12 +307,12 @@ It is recommended to use JavaScript for configuration files in the project. You
307307
"breaklineNumber": 100,
308308
"breaklineChar": "|",
309309
"skipQuestions": [],
310-
"issuePrefixs": [{ "value": "closed", "name": "closed: ISSUES has been processed" }],
311-
"customIssuePrefixsAlign": "top",
312-
"emptyIssuePrefixsAlias": "skip",
313-
"customIssuePrefixsAlias": "custom",
314-
"allowCustomIssuePrefixs": true,
315-
"allowEmptyIssuePrefixs": true,
310+
"issuePrefixes": [{ "value": "closed", "name": "closed: ISSUES has been processed" }],
311+
"customIssuePrefixAlign": "top",
312+
"emptyIssuePrefixAlias": "skip",
313+
"customIssuePrefixAlias": "custom",
314+
"allowCustomIssuePrefix": true,
315+
"allowEmptyIssuePrefix": true,
316316
"confirmColorize": true,
317317
"minSubjectLength": 0,
318318
"defaultBody": "",

‎docs/config/show.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ sitemap:
3838
#### Use 256 RGB Color
3939
> Not recommended for use in projects, poor compatibility
4040
- **rule**: `"38;2;${R};${G};${B}"`
41-
⇒ You can check this link to see if your terminal supports displaying 256 RGB Color Truecolor: [https://github.com/termstandard/colors](https://github.com/termstandard/colors#truecolor-support-in-output-devices)
41+
⇒ You can check this link to see if your terminal supports displaying 256 RGB Color True-Color: [https://github.com/termstandard/colors](https://github.com/termstandard/colors#truecolor-support-in-output-devices)
4242
- **example**: `"38;2;255;100;0"`
4343
---
4444
If you don't want to use the theme color of the configuration record, you can add a line to the profile file such as `~/.bashrc` or `~/.zshrc`, which will have a higher priority:
@@ -118,19 +118,19 @@ Try running command to **enable output emoji mode in the current session**
118118
- **type** : `string`
119119
- **default** : `empty`
120120

121-
## customIssuePrefixsAlign
121+
## customIssuePrefixAlign
122122

123123
- **description** : Set the **location** of skip option (skip) and custom option (custom) in **select issue prefix**
124124
- **type** : `"top" | "bottom" | "top-bottom" | "bottom-top"`
125125
- **default** : `"top"`
126126

127-
## customIssuePrefixsAlias
127+
## customIssuePrefixAlias
128128

129129
- **description** : custom **select the issue prefix** in the custom option (custom) to display the **name** on the command line
130130
- **type** : `string`
131131
- **default** : `custom`
132132

133-
## emptyIssuePrefixsAlias
133+
## emptyIssuePrefixAlias
134134

135135
- **description** : Customize the **name** displayed on the command line in the skip option (skip) in the **select issue prefix**
136136
- **type** : `string`
@@ -163,7 +163,7 @@ Using ==default value== can produce many ways to make the tool more suitable for
163163
- **description** : pin scope item the top of the scope list (match item value)
164164
- **type** : `string`
165165
- **default** : `""`
166-
- **other** : Initialize the complation template in **custom scope**. you can use <kbd>Tab</kbd> or <kbd>→</kbd> to quickly complete; you can also use the <kbd> Enter</kbd> output template directly.
166+
- **other** : Initialize the completion template in **custom scope**. you can use <kbd>Tab</kbd> or <kbd>→</kbd> to quickly complete; you can also use the <kbd> Enter</kbd> output template directly.
167167

168168
==Tip== [⇒ see the recipes](/recipes/default-scope.html)
169169

@@ -173,7 +173,7 @@ Using ==default value== can produce many ways to make the tool more suitable for
173173
- **description** : Whether to use the display default value in the **short description**
174174
- **type** : `string`
175175
- **default** : `""`
176-
- **use** : **Initialize the complation template**, you can use <kbd>Tab</kbd> or <kbd>→</kbd> to quickly complete; you can also use the <kbd> Enter</kbd> output template directly.
176+
- **use** : **Initialize the completion template**, you can use <kbd>Tab</kbd> or <kbd>→</kbd> to quickly complete; you can also use the <kbd> Enter</kbd> output template directly.
177177

178178
==Tip== [⇒ see the recipes](/recipes/default-subject.html)
179179

@@ -182,20 +182,20 @@ Using ==default value== can produce many ways to make the tool more suitable for
182182
- **description** : Whether to use the display default value in the **detailed description**
183183
- **type** : `string`
184184
- **default** : `""`
185-
- **use** : **Initialize the complation template**, you can use <kbd>Tab</kbd> or <kbd>→</kbd> to quickly complete; you can also use the <kbd> Enter</kbd> output template directly.
185+
- **use** : **Initialize the completion template**, you can use <kbd>Tab</kbd> or <kbd>→</kbd> to quickly complete; you can also use the <kbd> Enter</kbd> output template directly.
186186

187187
## defaultFooterPrefix
188188

189189
- **description** : Whether to use the display default value in the **custom ISSUE prefix**
190190
- **type** : `string`
191191
- **default** : `""`
192-
- **use** : **Initialize the complation template**, you can use <kbd>Tab</kbd> or <kbd>→</kbd> to quickly complete; you can also use the <kbd> Enter</kbd> output template directly.
192+
- **use** : **Initialize the completion template**, you can use <kbd>Tab</kbd> or <kbd>→</kbd> to quickly complete; you can also use the <kbd> Enter</kbd> output template directly.
193193

194194
## defaultIssues
195195

196196
- **description** : Whether to use the display default value in the **input ISSUE**
197197
- **type** : `string`
198198
- **default** : `""`
199-
- **use** : **Initialize the complation template**, you can use <kbd>Tab</kbd> or <kbd>→</kbd> to quickly complete; you can also use the <kbd> Enter</kbd> output template directly.
199+
- **use** : **Initialize the completion template**, you can use <kbd>Tab</kbd> or <kbd>→</kbd> to quickly complete; you can also use the <kbd> Enter</kbd> output template directly.
200200

201201
==Tip== [⇒ see the recipes](/recipes/default-issues.html)

‎docs/guide/introduction.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ A more engineered, lightweight, customizable, standard output format [commitizen
6060
- 💪 Just to be a **lazy man** !!! Friendly command line tool, Supports **search and selection** on the command line, reducing spelling errors.
6161
- ⚡️ **Lightweight**, **Highly Customizable**, but the output format follows the standard [Angular commit](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) specification.
6262
- 🔨 [Better for monorepo engineering](https://cz-git.qbb.sh/recipes/#scopes) and **commitlint** project to give relevant verification information to the command line.
63-
- ✅ Support commit with **emoji** ｜ Better linking with [issuePrefixs](https://cz-git.qbb.sh/recipes/default-issues.html) **for issue**
63+
- ✅ Support commit with **emoji** ｜ Better linking with [issuePrefix](https://cz-git.qbb.sh/recipes/default-issues.html) **for issue**
6464

6565
```sh
6666
$ npm install -D cz-git

‎docs/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ titleTemplate: More engineered, lightweight, customizable, standard output forma
88
hero:
99
name: cz-git
1010
text: ""
11-
tagline: More engineered, lightweight, customizable, standard output format commitizen adapter and CLI.
11+
tagline: More engineered, lightweight, customizable, standard output format Commitizen adapter and CLI.
1212
image:
1313
src: https://user-images.githubusercontent.com/40693636/154064210-964aeaa0-d9dc-4cea-9e52-2ffc3789611b.png
1414
alt: cz-git
@@ -28,7 +28,7 @@ hero:
2828

2929
czFeatures:
3030
- title: Friendly First
31-
details: Friendly command line tool, Supports search and selection on the command line, reducing spelling errors.To be a lazyman.
31+
details: Friendly command line tool, Supports search and selection on the command line, reducing spelling errors.To be a lazy man.
3232
- title: Highly Customizable
3333
details: Enjoy the customization process to make the tool more in line with your or team habits.
3434
- title: Engineering Support

‎docs/recipes/alias.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,5 +38,5 @@ cz_alias=fd git cz
3838
![demo-gif](https://user-images.githubusercontent.com/40693636/176701915-3f57721a-a54b-4e23-8de6-4d205e01ef9f.gif) <!-- size=688x263 -->
3939

4040
::: warning
41-
Use Commitizen CLI like `cz_alias=fd cz`. The proccess can't exit after commit. Because `cz-cli` not listening for Node.js `close` event, cz-git can't handle.
41+
Use Commitizen CLI like `cz_alias=fd cz`. The process can't exit after commit. Because `cz-cli` not listening for Node.js `close` event, cz-git can't handle.
4242
:::

0 commit comments

Comments
 (0)