/
configuration-options.test-d.ts
167 lines (147 loc) · 4.39 KB
/
configuration-options.test-d.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
import { assertType, test } from 'vitest'
import type { CoverageProviderModule, ResolvedCoverageOptions, Vitest } from 'vitest'
import type { defineConfig } from 'vitest/config'
type NarrowToTestConfig<T> = T extends { test?: any } ? NonNullable<T['test']> : never
type Configuration = NarrowToTestConfig<(Parameters<typeof defineConfig>[0])>
type Coverage = NonNullable<Configuration['coverage']>
test('providers, built-in', () => {
assertType<Coverage>({ provider: 'c8' })
assertType<Coverage>({ provider: 'istanbul' })
// @ts-expect-error -- String options must be known ones only
assertType<Coverage>({ provider: 'unknown-provider' })
})
test('providers, custom', () => {
assertType<Coverage>({
provider: 'custom',
customProviderModule: 'custom-provider-module.ts',
})
})
test('provider options, generic', () => {
assertType<Coverage>({
provider: 'c8',
enabled: true,
include: ['string'],
})
assertType<Coverage>({
provider: 'istanbul',
enabled: true,
include: ['string'],
})
})
test('provider specific options, c8', () => {
assertType<Coverage>({
provider: 'c8',
src: ['string'],
100: true,
excludeNodeModules: false,
allowExternal: true,
})
assertType<Coverage>({
provider: 'c8',
// @ts-expect-error -- Istanbul-only option is not allowed
ignoreClassMethods: ['string'],
})
})
test('provider specific options, istanbul', () => {
assertType<Coverage>({
provider: 'istanbul',
ignoreClassMethods: ['string'],
watermarks: {
statements: [80, 95],
functions: [80, 95],
branches: [80, 95],
lines: [80, 95],
},
})
assertType<Coverage>({
provider: 'istanbul',
// @ts-expect-error -- C8-only option is not allowed
src: ['string'],
})
})
test('provider specific options, custom', () => {
assertType<Coverage>({
provider: 'custom',
customProviderModule: 'custom-provider-module.ts',
enabled: true,
})
// @ts-expect-error -- customProviderModule is required
assertType<Coverage>({ provider: 'custom' })
assertType<Coverage>({
provider: 'custom',
customProviderModule: 'some-module',
// @ts-expect-error -- typings of BaseCoverageOptions still apply
enabled: 'not boolean',
})
})
test('provider module', () => {
assertType<CoverageProviderModule>({
getProvider() {
return {
name: 'custom-provider',
initialize(_: Vitest) {},
resolveOptions(): ResolvedCoverageOptions {
return {
clean: true,
cleanOnRerun: true,
enabled: true,
exclude: ['string'],
extension: ['string'],
reporter: ['html', 'json'],
reportsDirectory: 'string',
}
},
clean(_: boolean) {},
onBeforeFilesRun() {},
onAfterSuiteRun({ coverage: _coverage }) {},
reportCoverage() {},
onFileTransform(_code: string, _id: string, ctx) {
ctx.getCombinedSourcemap()
},
}
},
takeCoverage() {},
startCoverage() {},
stopCoverage() {},
})
})
test('reporters, single', () => {
assertType<Coverage>({ reporter: 'clover' })
assertType<Coverage>({ reporter: 'cobertura' })
assertType<Coverage>({ reporter: 'html-spa' })
assertType<Coverage>({ reporter: 'html' })
assertType<Coverage>({ reporter: 'json-summary' })
assertType<Coverage>({ reporter: 'json' })
assertType<Coverage>({ reporter: 'lcov' })
assertType<Coverage>({ reporter: 'lcovonly' })
assertType<Coverage>({ reporter: 'none' })
assertType<Coverage>({ reporter: 'teamcity' })
assertType<Coverage>({ reporter: 'text-lcov' })
assertType<Coverage>({ reporter: 'text-summary' })
assertType<Coverage>({ reporter: 'text' })
// @ts-expect-error -- String reporters must be known built-in's
assertType<Coverage>({ reporter: 'unknown-reporter' })
})
test('reporters, multiple', () => {
assertType<Coverage>({
reporter: [
'clover',
'cobertura',
'html-spa',
'html',
'json-summary',
'json',
'lcov',
'lcovonly',
'none',
'teamcity',
'text-lcov',
'text-summary',
'text',
],
})
// @ts-expect-error -- List of string reporters must be known built-in's
assertType<Coverage>({ reporter: ['unknown-reporter'] })
// @ts-expect-error -- ... and all reporters must be known
assertType<Coverage>({ reporter: ['html', 'json', 'unknown-reporter'] })
})