/
coverage.ts
177 lines (148 loc) · 3.52 KB
/
coverage.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
import type { TransformPluginContext, TransformResult } from 'rollup'
import type { Vitest } from '../node'
import type { Arrayable } from './general'
import type { AfterSuiteRunMeta } from './worker'
export interface CoverageProvider {
name: string
initialize(ctx: Vitest): Promise<void> | void
resolveOptions(): ResolvedCoverageOptions
clean(clean?: boolean): void | Promise<void>
onBeforeFilesRun?(): void | Promise<void>
onAfterSuiteRun(meta: AfterSuiteRunMeta): void | Promise<void>
reportCoverage(): void | Promise<void>
onFileTransform?(
sourceCode: string,
id: string,
pluginCtx: TransformPluginContext
): TransformResult | Promise<TransformResult>
}
export interface CoverageProviderModule {
/**
* Factory for creating a new coverage provider
*/
getProvider(): CoverageProvider | Promise<CoverageProvider>
/**
* Executed on after each run in the worker thread. Possible to return a payload passed to the provider
*/
takeCoverage?(): unknown | Promise<unknown>
}
export type CoverageReporter =
| 'clover'
| 'cobertura'
| 'html-spa'
| 'html'
| 'json-summary'
| 'json'
| 'lcov'
| 'lcovonly'
| 'none'
| 'teamcity'
| 'text-lcov'
| 'text-summary'
| 'text'
export type CoverageOptions =
| BaseCoverageOptions & { provider?: null | CoverageProviderModule }
| CoverageC8Options & { provider?: 'c8' }
| CoverageIstanbulOptions & { provider?: 'istanbul' }
export type ResolvedCoverageOptions =
& { tempDirectory: string }
& Required<CoverageOptions>
export interface BaseCoverageOptions {
/**
* Enable coverage, pass `--coverage` to enable
*
* @default false
*/
enabled?: boolean
/**
* Clean coverage before running tests
*
* @default true
*/
clean?: boolean
/**
* Clean coverage report on watch rerun
*
* @default false
*/
cleanOnRerun?: boolean
/**
* Directory to write coverage report to
*/
reportsDirectory?: string
/**
* Reporters
*
* @default 'text'
*/
reporter?: Arrayable<CoverageReporter>
/**
* List of files included in coverage as glob patterns
*/
include?: string[]
/**
* List of files excluded from coverage as glob patterns
*/
exclude?: string[]
/**
* Do not show files with 100% statement, branch, and function coverage
*/
skipFull?: boolean
/**
* Check thresholds per file
*
* @default false
*/
perFile?: boolean
/**
* Threshold for lines
*/
lines?: number
/**
* Threshold for functions
*/
functions?: number
/**
* Threshold for branches
*/
branches?: number
/**
* Threshold for statements
*/
statements?: number
/**
* Extensions for files to be included in coverage
*/
extension?: string | string[]
/**
* Whether to include all files, including the untested ones into report
*/
all?: boolean
}
export interface CoverageIstanbulOptions extends BaseCoverageOptions {
/* Set to array of class method names to ignore for coverage */
ignoreClassMethods?: string[]
/* Watermarks for statements, lines, branches and functions */
watermarks?: {
statements?: [number, number]
functions?: [number, number]
branches?: [number, number]
lines?: [number, number]
}
}
export interface CoverageC8Options extends BaseCoverageOptions {
/**
* Allow files from outside of your cwd.
*
* @default false
*/
allowExternal?: any
/**
* Exclude coverage under /node_modules/
*
* @default true
*/
excludeNodeModules?: boolean
src?: string[]
100?: boolean
}