-
Notifications
You must be signed in to change notification settings - Fork 16
Expand file tree
/
Copy pathtransform.ts
More file actions
117 lines (105 loc) · 2.79 KB
/
Copy pathtransform.ts
File metadata and controls
117 lines (105 loc) · 2.79 KB
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
import axe from 'axe-core';
import type {
AuditOutput,
AuditOutputs,
Issue,
IssueSeverity,
} from '@code-pushup/models';
import {
formatIssueSeverities,
pluralizeToken,
truncateIssueMessage,
} from '@code-pushup/utils';
/**
* Transforms Axe results into audit outputs.
* Priority: violations > incomplete > passes > inapplicable
*/
export function toAuditOutputs(
{ passes, violations, incomplete, inapplicable }: axe.AxeResults,
url: string,
): AuditOutputs {
const toEntries = (results: axe.Result[], score: number) =>
results.map(res => [res.id, toAuditOutput(res, url, score)] as const);
return [
...new Map<string, AuditOutput>([
...toEntries(inapplicable, 1),
...toEntries(passes, 1),
...toEntries(incomplete, 0),
...toEntries(violations, 0),
]).values(),
];
}
/**
* For failing audits (score 0), includes detailed issues with locations and severities.
* For passing audits (score 1), only includes element count.
*/
function toAuditOutput(
result: axe.Result,
url: string,
score: number,
): AuditOutput {
const base = {
slug: result.id,
score,
value: result.nodes.length,
};
if (score === 0 && result.nodes.length > 0) {
const issues = result.nodes.map(node => toIssue(node, result, url));
return {
...base,
displayValue: formatIssueSeverities(issues),
details: { issues },
};
}
return {
...base,
displayValue: pluralizeToken('element', result.nodes.length),
};
}
function formatSelector(selector: axe.CrossTreeSelector): string {
if (typeof selector === 'string') {
return selector;
}
return selector.join(' >> ');
}
/**
* Joins `none`/`all` check messages (each must be fixed).
* Falls back to first `any` check (OR-ed, one represents the group).
*/
function formatNodeMessage(node: axe.NodeResult, fallback: string): string {
const requiredMessages = [...node.none, ...node.all].map(
check => check.message,
);
if (requiredMessages.length > 0) {
return requiredMessages.join('. ');
}
return node.any[0]?.message ?? fallback;
}
function toIssue(node: axe.NodeResult, result: axe.Result, url: string): Issue {
const selector = node.target?.[0]
? formatSelector(node.target[0])
: undefined;
const message = formatNodeMessage(node, result.help);
return {
message: truncateIssueMessage(message),
severity: impactToSeverity(node.impact),
source: {
url,
...(node.html && { snippet: node.html }),
...(selector && { selector }),
},
};
}
function impactToSeverity(impact: axe.ImpactValue | undefined): IssueSeverity {
switch (impact) {
case 'critical':
case 'serious':
return 'error';
case 'moderate':
return 'warning';
case 'minor':
case null:
case undefined:
return 'info';
}
}