-
-
Notifications
You must be signed in to change notification settings - Fork 368
/
DangerResults.ts
261 lines (227 loc) · 7.37 KB
/
DangerResults.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
import { Violation, isInline } from "../dsl/Violation"
/**
* The representation of what running a Dangerfile generates.
* This needs to be passed between processes, so data only please.
*/
export interface DangerResults {
/**
* Failed messages
*/
fails: Violation[]
/**
* Messages for info
*/
warnings: Violation[]
/**
* A set of messages to show inline
*/
messages: Violation[]
/**
* Markdown messages to attach at the bottom of the comment
*/
markdowns: Violation[]
}
export interface DangerRuntimeContainer extends DangerResults {
/**
* Asynchronous functions to be run after parsing
*/
scheduled?: any[]
}
export interface DangerInlineResults {
/**
* Path to the file
*/
file: string
/**
* Line in the file
*/
line: number
/**
* Failed messages
*/
fails: string[]
/**
* Messages for info
*/
warnings: string[]
/**
* A set of messages to show inline
*/
messages: string[]
/**
* Markdown messages to attach at the bottom of the comment
*/
markdowns: string[]
}
/// End of Danger DSL definition
export const emptyDangerResults = {
fails: [],
warnings: [],
messages: [],
markdowns: [],
}
export function validateResults(results: DangerResults) {
// The data we get back is JSON sent by STDIN that can come from many
// consumers, let's take the time to ensure the data is how we think it is.
const { fails, warnings, messages, markdowns } = results
const props = { fails, warnings, messages, markdowns }
Object.keys(props).forEach(name => {
//
// Must include the key 4 types
if (!props[name]) {
throw new Error(`Results passed to Danger JS did not include ${name}.\n\n${JSON.stringify(results, null, " ")}`)
}
const violations: Violation[] = props[name]
violations.forEach(v => {
// They should always have a message
if (!v.message) {
throw new Error(
`A violation passed to Danger JS in ${name} did not include \`message\`.\n\n${JSON.stringify(v, null, " ")}`
)
}
// Warn if anything other than the initial API is on a violation
const officialAPI = ["message", "line", "file"]
const keys = Object.keys(v).filter(f => !officialAPI.includes(f))
if (keys.length) {
console.warn(`Received unexpected key in Violation, expected only ${officialAPI} but got ${Object.keys(v)}`)
}
})
})
}
/** Returns only the inline violations from Danger results */
export function inlineResults(results: DangerResults): DangerResults {
return {
fails: results.fails.filter(m => isInline(m)),
warnings: results.warnings.filter(m => isInline(m)),
messages: results.messages.filter(m => isInline(m)),
markdowns: results.markdowns.filter(m => isInline(m)),
}
}
/** Returns only the main-comment comments violations from Danger results */
export function regularResults(results: DangerResults): DangerResults {
return {
fails: results.fails.filter(m => !isInline(m)),
warnings: results.warnings.filter(m => !isInline(m)),
messages: results.messages.filter(m => !isInline(m)),
markdowns: results.markdowns.filter(m => !isInline(m)),
}
}
/** Concat all the violations into a new results */
export function mergeResults(results1: DangerResults, results2: DangerResults): DangerResults {
return {
fails: results1.fails.concat(results2.fails),
warnings: results1.warnings.concat(results2.warnings),
messages: results1.messages.concat(results2.messages),
markdowns: results1.markdowns.concat(results2.markdowns),
}
}
/** Sorts all of the results according to their files and lines */
export function sortInlineResults(inlineResults: DangerInlineResults[]): DangerInlineResults[] {
// First sort messages in every inline result
const sortedInlineResults = inlineResults.map(i => {
return {
file: i.file,
line: i.line,
fails: i.fails.sort(),
warnings: i.warnings.sort(),
messages: i.messages.sort(),
markdowns: i.markdowns.sort(),
}
})
// Then sort a whole array of inline results based on file/line
return sortedInlineResults.sort((a, b) => {
if (a.file < b.file) {
return -1
} else if (a.file > b.file) {
return 1
} else if (a.line < b.line) {
return -1
} else if (a.line > b.line) {
return 1
} else {
// both file & line are the same
return 0
}
})
}
export function sortResults(results: DangerResults): DangerResults {
const sortByFile = (a: Violation, b: Violation): number => {
if (a.file === undefined) {
return -1
}
if (b.file === undefined) {
return 1
}
if (a.file == b.file) {
if (a.line == undefined) {
return -1
}
if (b.line == undefined) {
return 1
}
if (a.line < b.line) {
return -1
} else if (a.line > b.line) {
return 1
} else {
return 0
}
}
if (a.file < b.file) {
return -1
} else {
return 1
}
}
return {
fails: results.fails.sort(sortByFile),
warnings: results.warnings.sort(sortByFile),
messages: results.messages.sort(sortByFile),
markdowns: results.markdowns.sort(sortByFile),
}
}
export const emptyResults = (): DangerResults => ({ fails: [], markdowns: [], warnings: [], messages: [] })
export const isEmptyResults = (results: DangerResults): boolean =>
[...results.fails, ...results.warnings, ...results.messages, ...results.markdowns].length === 0
export const isMarkdownOnlyResults = (results: DangerResults): boolean =>
results.markdowns.length > 0 && [...results.fails, ...results.warnings, ...results.messages].length === 0
export function resultsIntoInlineResults(results: DangerResults): DangerInlineResults[] {
// Here we iterate through all keys ("fails", "warnings", "messages", "markdowns") and for each violation
// in given kind we produce new DangerInlineResult or append a violation to existing result. This is all
// happening in a `violationsIntoInlineResults` function that mutates an out-of-scope variable `dangerInlineResults`.
const dangerInlineResults: DangerInlineResults[] = []
const violationsIntoInlineResults = (kind: string) => {
for (let violation of results[kind]) {
if (violation.file && violation.line) {
const findInlineResult = dangerInlineResults.find(r => r.file == violation.file && r.line == violation.line)
if (findInlineResult) {
findInlineResult[kind].push(violation.message)
} else {
const inlineResult = {
file: violation.file,
line: violation.line,
fails: [],
warnings: [],
messages: [],
markdowns: [],
}
inlineResult[kind].push(violation.message)
dangerInlineResults.push(inlineResult)
}
}
}
}
Object.keys(results).forEach(violationsIntoInlineResults)
return dangerInlineResults
}
export function inlineResultsIntoResults(inlineResults: DangerInlineResults): DangerResults {
const messageToViolation = (message: string): Violation => {
return { message: message, file: inlineResults.file, line: inlineResults.line }
}
return {
fails: inlineResults.fails.map(messageToViolation),
warnings: inlineResults.warnings.map(messageToViolation),
messages: inlineResults.messages.map(messageToViolation),
markdowns: inlineResults.markdowns.map(messageToViolation),
}
}