-
Notifications
You must be signed in to change notification settings - Fork 69
/
validate.ts
188 lines (162 loc) · 6.93 KB
/
validate.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
import {
InvalidArgsSpecError,
RequiredArgsError,
Validation,
UnexpectedArgsError,
FailedFlagValidationError,
} from './errors'
import {ParserArg, ParserInput, ParserOutput, Flag, CompletableFlag} from '../interfaces'
import {FlagRelationship} from '../interfaces/parser'
import {uniq} from '../config/util'
export async function validate(parse: {
input: ParserInput;
output: ParserOutput;
}) {
function validateArgs() {
const maxArgs = parse.input.args.length
if (parse.input.strict && parse.output.argv.length > maxArgs) {
const extras = parse.output.argv.slice(maxArgs)
throw new UnexpectedArgsError({parse, args: extras})
}
const missingRequiredArgs: ParserArg<any>[] = []
let hasOptional = false
for (const [index, arg] of parse.input.args.entries()) {
if (!arg.required) {
hasOptional = true
} else if (hasOptional) {
// (required arg) check whether an optional has occurred before
// optionals should follow required, not before
throw new InvalidArgsSpecError({parse, args: parse.input.args})
}
if (arg.required && !parse.output.argv[index] && parse.output.argv[index] as any as number !== 0) {
missingRequiredArgs.push(arg)
}
}
if (missingRequiredArgs.length > 0) {
throw new RequiredArgsError({parse, args: missingRequiredArgs})
}
}
async function validateFlags() {
const promises = Object.entries(parse.input.flags).map(async ([name, flag]) => {
const results: Validation[] = []
if (parse.output.flags[name] !== undefined) {
results.push(
...await validateRelationships(name, flag),
await validateDependsOn(name, flag.dependsOn ?? []),
await validateExclusive(name, flag.exclusive ?? []),
await validateExactlyOne(name, flag.exactlyOne ?? []),
)
} else if (flag.required) {
results.push({status: 'failed', name, validationFn: 'required', reason: `Missing required flag ${name}`})
} else if (flag.exactlyOne && flag.exactlyOne.length > 0) {
results.push(validateAcrossFlags(flag))
}
return results
})
const results = (await Promise.all(promises)).flat()
const failed = results.filter(r => r.status === 'failed')
if (failed.length > 0) throw new FailedFlagValidationError({parse, failed})
}
async function resolveFlags(flags: FlagRelationship[]): Promise<Record<string, unknown>> {
const promises = flags.map(async flag => {
if (typeof flag === 'string') {
return [flag, parse.output.flags[flag]]
}
const result = await flag.when(parse.output.flags)
return result ? [flag.name, parse.output.flags[flag.name]] : null
})
const resolved = await Promise.all(promises)
return Object.fromEntries(resolved.filter(r => r !== null) as [string, unknown][])
}
function getPresentFlags(flags: Record<string, unknown>): string[] {
return Object.keys(flags).reduce((acc, key) => {
if (flags[key]) acc.push(key)
return acc
}, [] as string[])
}
function validateAcrossFlags(flag: Flag<any>): Validation {
const base = {name: flag.name, validationFn: 'validateAcrossFlags'}
const intersection = Object.entries(parse.input.flags)
.map(entry => entry[0]) // array of flag names
.filter(flagName => parse.output.flags[flagName] !== undefined) // with values
.filter(flagName => flag.exactlyOne && flag.exactlyOne.includes(flagName)) // and in the exactlyOne list
if (intersection.length === 0) {
// the command's exactlyOne may or may not include itself, so we'll use Set to add + de-dupe
const deduped = uniq(flag.exactlyOne?.map(flag => `--${flag}`) ?? []).join(', ')
const reason = `Exactly one of the following must be provided: ${deduped}`
return {...base, status: 'failed', reason}
}
return {...base, status: 'success'}
}
async function validateExclusive(name: string, flags: FlagRelationship[]): Promise<Validation> {
const base = {name, validationFn: 'validateExclusive'}
const resolved = await resolveFlags(flags)
const keys = getPresentFlags(resolved)
for (const flag of keys) {
// do not enforce exclusivity for flags that were defaulted
if (parse.output.metadata.flags && parse.output.metadata.flags[flag]?.setFromDefault)
continue
if (parse.output.metadata.flags && parse.output.metadata.flags[name]?.setFromDefault)
continue
if (parse.output.flags[flag]) {
return {...base, status: 'failed', reason: `--${flag}=${parse.output.flags[flag]} cannot also be provided when using --${name}`}
}
}
return {...base, status: 'success'}
}
async function validateExactlyOne(name: string, flags: FlagRelationship[]): Promise<Validation> {
const base = {name, validationFn: 'validateExactlyOne'}
const resolved = await resolveFlags(flags)
const keys = getPresentFlags(resolved)
for (const flag of keys) {
if (flag !== name && parse.output.flags[flag]) {
return {...base, status: 'failed', reason: `--${flag} cannot also be provided when using --${name}`}
}
}
return {...base, status: 'success'}
}
async function validateDependsOn(name: string, flags: FlagRelationship[]): Promise<Validation> {
const base = {name, validationFn: 'validateDependsOn'}
const resolved = await resolveFlags(flags)
const foundAll = Object.values(resolved).every(Boolean)
if (!foundAll) {
const formattedFlags = Object.keys(resolved).map(f => `--${f}`).join(', ')
return {...base, status: 'failed', reason: `All of the following must be provided when using --${name}: ${formattedFlags}`}
}
return {...base, status: 'success'}
}
async function validateSome(name: string, flags: FlagRelationship[]): Promise<Validation> {
const base = {name, validationFn: 'validateSome'}
const resolved = await resolveFlags(flags)
const foundAtLeastOne = Object.values(resolved).some(Boolean)
if (!foundAtLeastOne) {
const formattedFlags = Object.keys(resolved).map(f => `--${f}`).join(', ')
return {...base, status: 'failed', reason: `One of the following must be provided when using --${name}: ${formattedFlags}`}
}
return {...base, status: 'success'}
}
async function validateRelationships(name: string, flag: CompletableFlag<any>): Promise<Validation[]> {
if (!flag.relationships) return []
const results = await Promise.all(flag.relationships.map(async relationship => {
const flags = relationship.flags ?? []
const results = []
switch (relationship.type) {
case 'all':
results.push(await validateDependsOn(name, flags))
break
case 'some':
results.push(await validateSome(name, flags))
break
case 'none':
results.push(await validateExclusive(name, flags))
break
default:
break
}
return results
}))
return results.flat()
}
validateArgs()
await validateFlags()
}