-
-
Notifications
You must be signed in to change notification settings - Fork 40
/
question.ts
286 lines (275 loc) · 9.88 KB
/
question.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
/**
* @description: generate commitizen questions(generateQuestions)
* @author: @Zhengqbbb (zhengqbbb@gmail.com)
* @license: MIT
*/
import { fuzzyFilter, style } from '@cz-git/inquirer'
import type { Answers, CommitizenGitOptions, Option } from '../shared'
import {
getCurrentScopes,
getMaxSubjectLength,
getProcessSubject,
isSingleItem,
log,
parseStandardScopes,
resolveListItemPinTop,
resovleCustomListTemplate,
} from '../shared'
import { generateMessage } from './message'
const useThemeCode = (input: string, themeColorCode?: string) =>
themeColorCode ? style.rgb(themeColorCode)(input) : style.cyan(input)
export const generateQuestions = (options: CommitizenGitOptions, cz: any) => {
if (!Array.isArray(options.types) || options.types.length === 0) {
if (!process.env.VITEST)
log('err', 'Error [types] Option')
return false
}
return [
{
type: 'search-list',
name: 'type',
message: options.messages?.type,
themeColorCode: options?.themeColorCode,
source: (_: unknown, input: string) => {
const typeSource = resolveListItemPinTop(
options.types?.concat(options.typesAppend || []) || [],
options.defaultType,
)
const searchTarget = options.typesSearchValueKey
? 'value'
: 'name'
return fuzzyFilter(input, typeSource, searchTarget)
},
},
{
type: options.enableMultipleScopes ? 'search-checkbox' : 'search-list',
name: 'scope',
message: options.messages?.scope,
themeColorCode: options?.themeColorCode,
separator: options.scopeEnumSeparator,
source: (answer: Answers, input: string) => {
let scopeSource: Option[] = []
scopeSource = parseStandardScopes(
getCurrentScopes(options.scopes, options.scopeOverrides, answer.type),
)
scopeSource = resovleCustomListTemplate(
scopeSource,
cz,
options.customScopesAlign,
options.emptyScopesAlias,
options.customScopesAlias,
options.allowCustomScopes,
options.allowEmptyScopes,
options.defaultScope as string,
options.scopeFilters,
)
return fuzzyFilter(input, scopeSource)
},
validate: (input: string | Array<string>) => {
if (options.allowEmptyScopes)
return true
if (typeof input === 'string')
return input.length ? true : style.red('[ERROR] scope is required')
else
return input.length !== 0 ? true : style.red('[ERROR] scope is required')
},
when: (answer: Answers) => {
return !isSingleItem(
options.allowCustomScopes,
options.allowEmptyScopes,
parseStandardScopes(
getCurrentScopes(options.scopes, options.scopeOverrides, answer.type),
),
)
},
},
{
type: 'complete-input',
name: 'customScope',
message: options.messages?.customScope,
completeValue: options.defaultScope || undefined,
validate: (input: string | Array<string>) => {
if (options.allowEmptyScopes)
return true
if (typeof input === 'string')
return input.length ? true : style.red('[ERROR] scope is required')
else
return input.length !== 0 ? true : style.red('[ERROR] scope is required')
},
when: (answers: Answers) => {
return answers.scope === '___CUSTOM___'
},
transformer: (input: string) => useThemeCode(input, options.themeColorCode),
},
{
type: 'complete-input',
name: 'subject',
message: options.messages?.subject,
validate: (subject: string, answers: Answers) => {
const processedSubject = getProcessSubject(subject)
if (processedSubject.length === 0)
return style.red('[ERROR] subject is required')
if (!options.minSubjectLength && !options.maxSubjectLength) {
log('err', 'Error [Subject Length] Option')
return false
}
const maxSubjectLength = getMaxSubjectLength(answers.type, answers.scope, options)
if (options.minSubjectLength && processedSubject.length < options.minSubjectLength) {
return style.red(
`[ERROR]subject length must be greater than or equal to ${options.minSubjectLength} characters`,
)
}
if (processedSubject.length > maxSubjectLength) {
return options.isIgnoreCheckMaxSubjectLength
? true
: style.red(
`[ERROR]subject length must be less than or equal to ${maxSubjectLength} characters`,
)
}
return true
},
transformer: (subject: string, answers: Answers) => {
const { minSubjectLength, isIgnoreCheckMaxSubjectLength } = options
const subjectLength = subject.length
const maxSubjectLength = getMaxSubjectLength(answers.type, answers.scope, options)
let tooltip
let isWarning = false
if (typeof minSubjectLength === 'number' && subjectLength < minSubjectLength) {
tooltip = `${minSubjectLength - subjectLength} more chars needed`
}
else if (subjectLength > maxSubjectLength) {
if (isIgnoreCheckMaxSubjectLength) {
tooltip = `${subjectLength - maxSubjectLength} chars over the expected`
isWarning = true
}
else { tooltip = `${subjectLength - maxSubjectLength} chars over the limit` }
}
else {
tooltip = `${maxSubjectLength - subjectLength} more chars allowed`
}
tooltip
= minSubjectLength !== undefined
&& subjectLength >= minSubjectLength
&& subjectLength <= maxSubjectLength
? style.gray(`[${tooltip}]`)
: isWarning ? style.yellow(`[${tooltip}]`) : style.red(`[${tooltip}]`)
subject
= minSubjectLength !== undefined
&& subjectLength >= minSubjectLength
&& subjectLength <= maxSubjectLength
? useThemeCode(subject, options.themeColorCode)
: isWarning ? useThemeCode(subject, options.themeColorCode) : style.red(subject)
return `${tooltip}\n` + ` ${subject}`
},
filter: (subject: string) => {
const upperCaseSubject = options.upperCaseSubject || false
return (
(upperCaseSubject ? subject.charAt(0).toUpperCase() : subject.charAt(0).toLowerCase())
+ subject.slice(1)
)
},
completeValue: options.defaultSubject || undefined,
},
{
type: 'complete-input',
name: 'body',
message: options.messages?.body,
completeValue: options.defaultBody || undefined,
transformer: (input: string) => useThemeCode(input, options.themeColorCode),
},
{
type: 'confirm',
name: 'markBreaking',
message: options.messages?.markBreaking,
default: false,
when: () => options.markBreakingChangeMode === true,
},
{
type: 'complete-input',
name: 'breaking',
message: options.messages?.breaking,
completeValue: options.defaultBody || undefined,
when: (answers: Answers) => {
if (
options.allowBreakingChanges
&& answers.type
&& options.allowBreakingChanges.includes(answers.type)
)
return true
else
return answers.markBreaking || Boolean(process.env.break === '1') || false
},
transformer: (input: string) => useThemeCode(input, options.themeColorCode),
},
{
type: 'search-list',
name: 'footerPrefix',
message: options.messages?.footerPrefixsSelect,
themeColorCode: options?.themeColorCode,
source: (_: Answers, input: string) => {
const issuePrefixSource = resovleCustomListTemplate(
options.issuePrefixs as Option[],
cz,
options.customIssuePrefixsAlign,
options.emptyIssuePrefixsAlias,
options.customIssuePrefixsAlias,
options.allowCustomIssuePrefixs,
options.allowEmptyIssuePrefixs,
)
return fuzzyFilter(input, issuePrefixSource)
},
when: () =>
!isSingleItem(
options.allowCustomIssuePrefixs,
options.allowEmptyIssuePrefixs,
options.issuePrefixs,
),
},
{
type: 'complete-input',
name: 'customFooterPrefixs',
message: options.messages?.customFooterPrefixs,
completeValue: options.defaultFooterPrefix || undefined,
when: (answers: Answers) => {
return answers.footerPrefix === '___CUSTOM___'
},
transformer: (input: string) => useThemeCode(input, options.themeColorCode),
},
{
type: 'complete-input',
name: 'footer',
completeValue: options.defaultIssues || undefined,
when(answers: Answers) {
return (answers.footerPrefix as string | boolean) !== false
},
message: options.messages?.footer,
transformer: (input: string) => useThemeCode(input, options.themeColorCode),
},
{
type: 'expand',
name: 'confirmCommit',
choices: [
{ key: 'y', name: 'Yes', value: 'yes' },
{ key: 'n', name: 'Abort commit', value: 'no' },
{ key: 'e', name: 'Edit message(wq: save, cq: exit)', value: 'edit' },
],
default: 0,
message(answers: Answers) {
const SEP = options.confirmColorize
? style.gray('###--------------------------------------------------------###')
: '###--------------------------------------------------------###'
console.info(
`\n${SEP}\n${generateMessage(answers, options, options.confirmColorize)}\n${SEP}\n`,
)
return options.messages?.confirmCommit
},
},
].filter(
i =>
!options.skipQuestions?.includes(
i.name as 'scope' | 'body' | 'breaking' | 'footer' | 'footerPrefix',
),
)
}
type GenerateQuestionsType = typeof generateQuestions
export type QuestionsType = ReturnType<GenerateQuestionsType>