-
Notifications
You must be signed in to change notification settings - Fork 69
/
validate.ts
166 lines (146 loc) · 5.62 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
/* eslint-disable no-await-in-loop */
import {CLIError} from '../errors'
import {
InvalidArgsSpecError,
RequiredArgsError,
RequiredFlagError,
UnexpectedArgsError,
} from './errors'
import {ParserArg, ParserInput, ParserOutput, Flag, CompletableFlag} from '../interfaces'
import {FlagRelationship} from '../interfaces/parser'
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})
}
}
function validateAcrossFlags(flag: Flag<any>) {
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
throw new CLIError(`Exactly one of the following must be provided: ${[
...new Set(flag.exactlyOne?.map(flag => `--${flag}`)),
].join(', ')}`)
}
}
async function validateFlags() {
for (const [name, flag] of Object.entries(parse.input.flags)) {
if (parse.output.flags[name] !== undefined) {
await validateRelationships(name, flag)
await validateDependsOn(name, flag.dependsOn ?? [])
await validateExclusive(name, flag.exclusive ?? [])
validateExactlyOne(name, flag.exactlyOne ?? [])
} else if (flag.required) {
throw new RequiredFlagError({parse, flag})
} else if (flag.exactlyOne && flag.exactlyOne.length > 0) {
validateAcrossFlags(flag)
}
}
}
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][])
}
async function validateExclusive(name: string, flags: FlagRelationship[]) {
const resolved = await resolveFlags(flags)
const keys = Object.keys(resolved).reduce((acc, key) => {
if (resolved[key]) acc.push(key)
return acc
}, [] as string[])
for (const flag of keys) {
// do not enforce exclusivity for flags that were defaulted
if (
parse.output.metadata.flags[flag] &&
parse.output.metadata.flags[flag].setFromDefault
)
continue
if (
parse.output.metadata.flags[name] &&
parse.output.metadata.flags[name].setFromDefault
)
continue
if (parse.output.flags[flag]) {
throw new CLIError(
`--${flag}=${parse.output.flags[flag]} cannot also be provided when using --${name}`,
)
}
}
}
function validateExactlyOne(name: string, exactlyOne: FlagRelationship[]) {
for (const flag of exactlyOne || []) {
const flagName = typeof flag === 'string' ? flag : flag.name
if (flagName !== name && parse.output.flags[flagName]) {
throw new CLIError(
`--${flagName} cannot also be provided when using --${name}`,
)
}
}
}
async function validateDependsOn(name: string, flags: FlagRelationship[]) {
const resolved = await resolveFlags(flags)
const foundAll = Object.values(resolved).every(Boolean)
if (!foundAll) {
const formattedFlags = Object.keys(resolved).map(f => `--${f}`).join(', ')
throw new CLIError(
`All of the following must be provided when using --${name}: ${formattedFlags}`,
)
}
}
async function validateSome(name: string, flags: FlagRelationship[]) {
const resolved = await resolveFlags(flags)
const foundAtLeastOne = Object.values(resolved).some(Boolean)
if (!foundAtLeastOne) {
const formattedFlags = Object.keys(resolved).map(f => `--${f}`).join(', ')
throw new CLIError(`One of the following must be provided when using --${name}: ${formattedFlags}`)
}
}
async function validateRelationships(name: string, flag: CompletableFlag<any>) {
if (!flag.relationships) return
for (const relationship of flag.relationships) {
const flags = relationship.flags ?? []
if (relationship.type === 'all') {
await validateDependsOn(name, flags)
}
if (relationship.type === 'some') {
await validateSome(name, flags)
}
if (relationship.type === 'none') {
await validateExclusive(name, flags)
}
}
}
validateArgs()
await validateFlags()
}