@a11yst/reporters 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +373 -0
- package/README.md +78 -0
- package/dist/assets.d.ts +3 -0
- package/dist/assets.d.ts.map +1 -0
- package/dist/assets.js +271 -0
- package/dist/assets.js.map +1 -0
- package/dist/baseline-report.d.ts +25 -0
- package/dist/baseline-report.d.ts.map +1 -0
- package/dist/baseline-report.js +426 -0
- package/dist/baseline-report.js.map +1 -0
- package/dist/finding-groups.d.ts +14 -0
- package/dist/finding-groups.d.ts.map +1 -0
- package/dist/finding-groups.js +77 -0
- package/dist/finding-groups.js.map +1 -0
- package/dist/finding-source-report.d.ts +21 -0
- package/dist/finding-source-report.d.ts.map +1 -0
- package/dist/finding-source-report.js +134 -0
- package/dist/finding-source-report.js.map +1 -0
- package/dist/github/escape.d.ts +13 -0
- package/dist/github/escape.d.ts.map +1 -0
- package/dist/github/escape.js +37 -0
- package/dist/github/escape.js.map +1 -0
- package/dist/github/generate.d.ts +3 -0
- package/dist/github/generate.d.ts.map +1 -0
- package/dist/github/generate.js +140 -0
- package/dist/github/generate.js.map +1 -0
- package/dist/github/source-location.d.ts +4 -0
- package/dist/github/source-location.d.ts.map +1 -0
- package/dist/github/source-location.js +69 -0
- package/dist/github/source-location.js.map +1 -0
- package/dist/github/types.d.ts +42 -0
- package/dist/github/types.d.ts.map +1 -0
- package/dist/github/types.js +18 -0
- package/dist/github/types.js.map +1 -0
- package/dist/html.d.ts +8 -0
- package/dist/html.d.ts.map +1 -0
- package/dist/html.js +562 -0
- package/dist/html.js.map +1 -0
- package/dist/index.d.ts +24 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +33 -0
- package/dist/index.js.map +1 -0
- package/dist/markdown/escape.d.ts +5 -0
- package/dist/markdown/escape.d.ts.map +1 -0
- package/dist/markdown/escape.js +27 -0
- package/dist/markdown/escape.js.map +1 -0
- package/dist/markdown/generate.d.ts +3 -0
- package/dist/markdown/generate.d.ts.map +1 -0
- package/dist/markdown/generate.js +498 -0
- package/dist/markdown/generate.js.map +1 -0
- package/dist/markdown/links.d.ts +4 -0
- package/dist/markdown/links.d.ts.map +1 -0
- package/dist/markdown/links.js +30 -0
- package/dist/markdown/links.js.map +1 -0
- package/dist/markdown/types.d.ts +71 -0
- package/dist/markdown/types.d.ts.map +1 -0
- package/dist/markdown/types.js +2 -0
- package/dist/markdown/types.js.map +1 -0
- package/dist/profile-evidence.d.ts +21 -0
- package/dist/profile-evidence.d.ts.map +1 -0
- package/dist/profile-evidence.js +211 -0
- package/dist/profile-evidence.js.map +1 -0
- package/dist/validation.d.ts +10 -0
- package/dist/validation.d.ts.map +1 -0
- package/dist/validation.js +96 -0
- package/dist/validation.js.map +1 -0
- package/package.json +43 -0
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
const MAX_ALTERNATIVES = 5;
|
|
2
|
+
function flatRegion(region) {
|
|
3
|
+
return {
|
|
4
|
+
startLine: region.start.line,
|
|
5
|
+
...(region.start.column !== undefined ? { startColumn: region.start.column } : {}),
|
|
6
|
+
};
|
|
7
|
+
}
|
|
8
|
+
function candidateLocationKey(location) {
|
|
9
|
+
const flat = flatRegion(location.region);
|
|
10
|
+
return `${location.uri}\0${flat.startLine}\0${flat.startColumn ?? ""}`;
|
|
11
|
+
}
|
|
12
|
+
function readLegacySourceLocation(finding) {
|
|
13
|
+
const extension = finding;
|
|
14
|
+
const legacy = extension.sourceLocation;
|
|
15
|
+
if (!legacy?.uri || !legacy.startLine) {
|
|
16
|
+
return undefined;
|
|
17
|
+
}
|
|
18
|
+
return {
|
|
19
|
+
uri: legacy.uri,
|
|
20
|
+
region: {
|
|
21
|
+
start: {
|
|
22
|
+
line: legacy.startLine,
|
|
23
|
+
...(legacy.startColumn !== undefined ? { column: legacy.startColumn } : {}),
|
|
24
|
+
},
|
|
25
|
+
...(legacy.endLine !== undefined
|
|
26
|
+
? {
|
|
27
|
+
end: {
|
|
28
|
+
line: legacy.endLine,
|
|
29
|
+
...(legacy.endColumn !== undefined ? { column: legacy.endColumn } : {}),
|
|
30
|
+
},
|
|
31
|
+
}
|
|
32
|
+
: {}),
|
|
33
|
+
},
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
function compareLocations(left, right) {
|
|
37
|
+
const uriOrder = left.uri.localeCompare(right.uri);
|
|
38
|
+
if (uriOrder !== 0) {
|
|
39
|
+
return uriOrder;
|
|
40
|
+
}
|
|
41
|
+
const leftFlat = flatRegion(left.region);
|
|
42
|
+
const rightFlat = flatRegion(right.region);
|
|
43
|
+
if (leftFlat.startLine !== rightFlat.startLine) {
|
|
44
|
+
return leftFlat.startLine - rightFlat.startLine;
|
|
45
|
+
}
|
|
46
|
+
return (leftFlat.startColumn ?? 0) - (rightFlat.startColumn ?? 0);
|
|
47
|
+
}
|
|
48
|
+
function dedupeAlternatives(locations) {
|
|
49
|
+
const seen = new Set();
|
|
50
|
+
const result = [];
|
|
51
|
+
for (const location of [...locations].sort(compareLocations)) {
|
|
52
|
+
const key = candidateLocationKey(location);
|
|
53
|
+
if (!seen.has(key)) {
|
|
54
|
+
seen.add(key);
|
|
55
|
+
result.push(location);
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
return result.slice(0, MAX_ALTERNATIVES);
|
|
59
|
+
}
|
|
60
|
+
export function resolveFindingReportSource(finding) {
|
|
61
|
+
const mapping = finding.sourceMapping;
|
|
62
|
+
if (mapping?.status === "mapped" && mapping.selected) {
|
|
63
|
+
return {
|
|
64
|
+
status: "mapped",
|
|
65
|
+
location: mapping.selected.location,
|
|
66
|
+
confidence: mapping.selected.confidence,
|
|
67
|
+
provenance: mapping.selected.provenance,
|
|
68
|
+
};
|
|
69
|
+
}
|
|
70
|
+
if (mapping?.status === "invalid") {
|
|
71
|
+
return { status: "invalid" };
|
|
72
|
+
}
|
|
73
|
+
if (mapping?.status === "ambiguous") {
|
|
74
|
+
return {
|
|
75
|
+
status: "ambiguous",
|
|
76
|
+
alternatives: dedupeAlternatives(mapping.candidates.map((candidate) => candidate.location)),
|
|
77
|
+
};
|
|
78
|
+
}
|
|
79
|
+
const legacy = readLegacySourceLocation(finding);
|
|
80
|
+
if (legacy) {
|
|
81
|
+
return {
|
|
82
|
+
status: "mapped",
|
|
83
|
+
location: legacy,
|
|
84
|
+
confidence: "exact",
|
|
85
|
+
provenance: "existing-source-location",
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
if (mapping?.status === "unmapped") {
|
|
89
|
+
return { status: "unmapped" };
|
|
90
|
+
}
|
|
91
|
+
return { status: "unmapped" };
|
|
92
|
+
}
|
|
93
|
+
export function formatReportSourceLocation(location) {
|
|
94
|
+
const flat = flatRegion(location.region);
|
|
95
|
+
const column = flat.startColumn !== undefined ? `:${flat.startColumn}` : "";
|
|
96
|
+
return `${location.uri}:${flat.startLine}${column}`;
|
|
97
|
+
}
|
|
98
|
+
const UNIX_ABSOLUTE = /^\//;
|
|
99
|
+
const WINDOWS_ABSOLUTE = /^[A-Za-z]:[\\/]/;
|
|
100
|
+
/** Strip absolute or home-like paths from source URIs for human-facing reports. */
|
|
101
|
+
export function sanitizeSourceUriForReport(uri) {
|
|
102
|
+
const normalized = uri.replace(/\\/g, "/");
|
|
103
|
+
if (!UNIX_ABSOLUTE.test(normalized) && !WINDOWS_ABSOLUTE.test(normalized)) {
|
|
104
|
+
return normalized;
|
|
105
|
+
}
|
|
106
|
+
const segments = normalized.split("/").filter(Boolean);
|
|
107
|
+
if (segments.length >= 2) {
|
|
108
|
+
return segments.slice(-2).join("/");
|
|
109
|
+
}
|
|
110
|
+
return segments[segments.length - 1] ?? "source";
|
|
111
|
+
}
|
|
112
|
+
export function formatSafeReportSourceLocation(location) {
|
|
113
|
+
return formatReportSourceLocation({
|
|
114
|
+
...location,
|
|
115
|
+
uri: sanitizeSourceUriForReport(location.uri),
|
|
116
|
+
});
|
|
117
|
+
}
|
|
118
|
+
export function resolveFindingRecommendationSummary(finding) {
|
|
119
|
+
const recommendations = finding.recommendations;
|
|
120
|
+
if (!recommendations || recommendations.recommendations.length === 0) {
|
|
121
|
+
return undefined;
|
|
122
|
+
}
|
|
123
|
+
const primary = recommendations.recommendations[0];
|
|
124
|
+
if (!primary) {
|
|
125
|
+
return undefined;
|
|
126
|
+
}
|
|
127
|
+
return {
|
|
128
|
+
status: recommendations.status,
|
|
129
|
+
applicability: primary.applicability,
|
|
130
|
+
title: primary.title,
|
|
131
|
+
summary: primary.summary,
|
|
132
|
+
};
|
|
133
|
+
}
|
|
134
|
+
//# sourceMappingURL=finding-source-report.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"finding-source-report.js","sourceRoot":"","sources":["../src/finding-source-report.ts"],"names":[],"mappings":"AAsBA,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAE3B,SAAS,UAAU,CAAC,MAAgC;IAIlD,OAAO;QACL,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI;QAC5B,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACnF,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,QAAwB;IACpD,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACzC,OAAO,GAAG,QAAQ,CAAC,GAAG,KAAK,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,WAAW,IAAI,EAAE,EAAE,CAAC;AACzE,CAAC;AAED,SAAS,wBAAwB,CAAC,OAAgB;IAChD,MAAM,SAAS,GAAG,OAQjB,CAAC;IACF,MAAM,MAAM,GAAG,SAAS,CAAC,cAAc,CAAC;IACxC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;QACtC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO;QACL,GAAG,EAAE,MAAM,CAAC,GAAG;QACf,MAAM,EAAE;YACN,KAAK,EAAE;gBACL,IAAI,EAAE,MAAM,CAAC,SAAS;gBACtB,GAAG,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC5E;YACD,GAAG,CAAC,MAAM,CAAC,OAAO,KAAK,SAAS;gBAC9B,CAAC,CAAC;oBACE,GAAG,EAAE;wBACH,IAAI,EAAE,MAAM,CAAC,OAAO;wBACpB,GAAG,CAAC,MAAM,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;qBACxE;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;SACR;KACF,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAoB,EAAE,KAAqB;IACnE,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnD,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC3C,IAAI,QAAQ,CAAC,SAAS,KAAK,SAAS,CAAC,SAAS,EAAE,CAAC;QAC/C,OAAO,QAAQ,CAAC,SAAS,GAAG,SAAS,CAAC,SAAS,CAAC;IAClD,CAAC;IACD,OAAO,CAAC,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC;AACpE,CAAC;AAED,SAAS,kBAAkB,CAAC,SAA2B;IACrD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,MAAM,GAAqB,EAAE,CAAC;IACpC,KAAK,MAAM,QAAQ,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC7D,MAAM,GAAG,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAC3C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACnB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,OAAgB;IACzD,MAAM,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;IACtC,IAAI,OAAO,EAAE,MAAM,KAAK,QAAQ,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrD,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ;YACnC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,UAAU;YACvC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,UAAU;SACxC,CAAC;IACJ,CAAC;IAED,IAAI,OAAO,EAAE,MAAM,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IAC/B,CAAC;IAED,IAAI,OAAO,EAAE,MAAM,KAAK,WAAW,EAAE,CAAC;QACpC,OAAO;YACL,MAAM,EAAE,WAAW;YACnB,YAAY,EAAE,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;SAC5F,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;IACjD,IAAI,MAAM,EAAE,CAAC;QACX,OAAO;YACL,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,MAAM;YAChB,UAAU,EAAE,OAAO;YACnB,UAAU,EAAE,0BAA0B;SACvC,CAAC;IACJ,CAAC;IAED,IAAI,OAAO,EAAE,MAAM,KAAK,UAAU,EAAE,CAAC;QACnC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;IAChC,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,QAAwB;IACjE,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5E,OAAO,GAAG,QAAQ,CAAC,GAAG,IAAI,IAAI,CAAC,SAAS,GAAG,MAAM,EAAE,CAAC;AACtD,CAAC;AAED,MAAM,aAAa,GAAG,KAAK,CAAC;AAC5B,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAE3C,mFAAmF;AACnF,MAAM,UAAU,0BAA0B,CAAC,GAAW;IACpD,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;QAC1E,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACvD,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QACzB,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IACD,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,QAAQ,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,QAAwB;IACrE,OAAO,0BAA0B,CAAC;QAChC,GAAG,QAAQ;QACX,GAAG,EAAE,0BAA0B,CAAC,QAAQ,CAAC,GAAG,CAAC;KAC9C,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,mCAAmC,CACjD,OAAgB;IAEhB,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAChD,IAAI,CAAC,eAAe,IAAI,eAAe,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrE,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,OAAO,GAAG,eAAe,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IACnD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO;QACL,MAAM,EAAE,eAAe,CAAC,MAAM;QAC9B,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,OAAO,EAAE,OAAO,CAAC,OAAO;KACzB,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export declare function escapeGitHubCommandProperty(value: string): string;
|
|
2
|
+
export declare function escapeGitHubCommandMessage(value: string): string;
|
|
3
|
+
export declare function serializeGitHubAnnotationCommand(input: {
|
|
4
|
+
level: "error" | "warning" | "notice";
|
|
5
|
+
title: string;
|
|
6
|
+
message: string;
|
|
7
|
+
file?: string;
|
|
8
|
+
line?: number;
|
|
9
|
+
column?: number;
|
|
10
|
+
endLine?: number;
|
|
11
|
+
endColumn?: number;
|
|
12
|
+
}): string;
|
|
13
|
+
//# sourceMappingURL=escape.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"escape.d.ts","sourceRoot":"","sources":["../../src/github/escape.ts"],"names":[],"mappings":"AAAA,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAOjE;AAED,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAMhE;AAED,wBAAgB,gCAAgC,CAAC,KAAK,EAAE;IACtD,KAAK,EAAE,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,GAAG,MAAM,CAoBT"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
export function escapeGitHubCommandProperty(value) {
|
|
2
|
+
return value
|
|
3
|
+
.replace(/%/g, "%25")
|
|
4
|
+
.replace(/\r/g, "%0D")
|
|
5
|
+
.replace(/\n/g, "%0A")
|
|
6
|
+
.replace(/:/g, "%3A")
|
|
7
|
+
.replace(/,/g, "%2C");
|
|
8
|
+
}
|
|
9
|
+
export function escapeGitHubCommandMessage(value) {
|
|
10
|
+
return value
|
|
11
|
+
.replace(/%/g, "%25")
|
|
12
|
+
.replace(/\r/g, "%0D")
|
|
13
|
+
.replace(/\n/g, "%0A")
|
|
14
|
+
.replace(/:/g, "%3A");
|
|
15
|
+
}
|
|
16
|
+
export function serializeGitHubAnnotationCommand(input) {
|
|
17
|
+
const properties = [];
|
|
18
|
+
if (input.file) {
|
|
19
|
+
properties.push(`file=${escapeGitHubCommandProperty(input.file)}`);
|
|
20
|
+
}
|
|
21
|
+
if (input.line !== undefined) {
|
|
22
|
+
properties.push(`line=${input.line}`);
|
|
23
|
+
}
|
|
24
|
+
if (input.column !== undefined) {
|
|
25
|
+
properties.push(`col=${input.column}`);
|
|
26
|
+
}
|
|
27
|
+
if (input.endLine !== undefined) {
|
|
28
|
+
properties.push(`endLine=${input.endLine}`);
|
|
29
|
+
}
|
|
30
|
+
if (input.endColumn !== undefined) {
|
|
31
|
+
properties.push(`endColumn=${input.endColumn}`);
|
|
32
|
+
}
|
|
33
|
+
properties.push(`title=${escapeGitHubCommandProperty(input.title)}`);
|
|
34
|
+
const prefix = properties.length > 0 ? `${properties.join(",")}::` : "";
|
|
35
|
+
return `::${input.level} ${prefix}${escapeGitHubCommandMessage(input.message)}::`;
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=escape.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"escape.js","sourceRoot":"","sources":["../../src/github/escape.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,2BAA2B,CAAC,KAAa;IACvD,OAAO,KAAK;SACT,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,KAAa;IACtD,OAAO,KAAK;SACT,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;SACpB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,gCAAgC,CAAC,KAShD;IACC,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;QACf,UAAU,CAAC,IAAI,CAAC,QAAQ,2BAA2B,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC7B,UAAU,CAAC,IAAI,CAAC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IACxC,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/B,UAAU,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAChC,UAAU,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IAC9C,CAAC;IACD,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QAClC,UAAU,CAAC,IAAI,CAAC,aAAa,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;IAClD,CAAC;IACD,UAAU,CAAC,IAAI,CAAC,SAAS,2BAA2B,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACrE,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IACxE,OAAO,KAAK,KAAK,CAAC,KAAK,IAAI,MAAM,GAAG,0BAA0B,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;AACpF,CAAC"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import type { GitHubAnnotationGenerationResult, GitHubAnnotationInput, GitHubAnnotationOptions } from "./types.js";
|
|
2
|
+
export declare function generateGitHubAnnotations(input: GitHubAnnotationInput, options?: GitHubAnnotationOptions): GitHubAnnotationGenerationResult;
|
|
3
|
+
//# sourceMappingURL=generate.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/github/generate.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAGV,gCAAgC,EAChC,qBAAqB,EACrB,uBAAuB,EACxB,MAAM,YAAY,CAAC;AAiEpB,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,qBAAqB,EAC5B,OAAO,GAAE,uBAA4B,GACpC,gCAAgC,CAgGlC"}
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
import { serializeGitHubAnnotationCommand } from "./escape.js";
|
|
2
|
+
import { annotationFromFinding } from "./source-location.js";
|
|
3
|
+
import { breachMessage as formatBreachMessage, findingByFingerprint } from "./types.js";
|
|
4
|
+
const SEVERITY_ORDER = ["critical", "high", "medium", "minor"];
|
|
5
|
+
const DEFAULT_MAX_ANNOTATIONS = 50;
|
|
6
|
+
function breachPriority(breach) {
|
|
7
|
+
const severityBase = SEVERITY_ORDER.indexOf(breach.severity) * 10;
|
|
8
|
+
switch (breach.kind) {
|
|
9
|
+
case "new-finding":
|
|
10
|
+
return 100 + severityBase;
|
|
11
|
+
case "regressed-finding":
|
|
12
|
+
return 200 + severityBase;
|
|
13
|
+
case "expired-classification":
|
|
14
|
+
return 300 + severityBase;
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
function sortCandidates(candidates) {
|
|
18
|
+
return [...candidates].sort((a, b) => {
|
|
19
|
+
if (a.priority !== b.priority)
|
|
20
|
+
return a.priority - b.priority;
|
|
21
|
+
const title = a.annotation.title.localeCompare(b.annotation.title);
|
|
22
|
+
if (title !== 0)
|
|
23
|
+
return title;
|
|
24
|
+
return (a.annotation.fingerprint ?? "").localeCompare(b.annotation.fingerprint ?? "");
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
function operationalCandidates(runs, diagnostics) {
|
|
28
|
+
if (!runs)
|
|
29
|
+
return [];
|
|
30
|
+
const candidates = [];
|
|
31
|
+
for (const run of runs) {
|
|
32
|
+
if (run.status !== "failed")
|
|
33
|
+
continue;
|
|
34
|
+
const message = run.diagnostics.find((entry) => entry.severity === "error")?.message ??
|
|
35
|
+
run.skipReason ??
|
|
36
|
+
"Audit run failed.";
|
|
37
|
+
const route = run.route ?? run.flowId ?? "run";
|
|
38
|
+
candidates.push({
|
|
39
|
+
priority: 0,
|
|
40
|
+
annotation: {
|
|
41
|
+
level: "error",
|
|
42
|
+
title: `a11yst: ${route}`,
|
|
43
|
+
message: message.replace(/\s+/g, " ").trim(),
|
|
44
|
+
fingerprint: run.runId,
|
|
45
|
+
},
|
|
46
|
+
});
|
|
47
|
+
if (/password|token|authorization|cookie/i.test(message)) {
|
|
48
|
+
diagnostics.push({
|
|
49
|
+
code: "redacted-content",
|
|
50
|
+
level: "info",
|
|
51
|
+
message: "Operational annotation message may contain sensitive content.",
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
return candidates;
|
|
56
|
+
}
|
|
57
|
+
export function generateGitHubAnnotations(input, options = {}) {
|
|
58
|
+
const diagnostics = [];
|
|
59
|
+
const maxAnnotations = options.maxAnnotations ?? DEFAULT_MAX_ANNOTATIONS;
|
|
60
|
+
const candidates = operationalCandidates(input.runs, diagnostics);
|
|
61
|
+
const evaluation = input.policyEvaluation;
|
|
62
|
+
if (evaluation?.policyEnabled && evaluation.status === "not-evaluated") {
|
|
63
|
+
const message = evaluation.diagnostics.find((entry) => entry.level === "error")?.message ??
|
|
64
|
+
evaluation.diagnostics[0]?.message ??
|
|
65
|
+
"The enabled CI policy requires a baseline comparison.";
|
|
66
|
+
candidates.push({
|
|
67
|
+
priority: 1,
|
|
68
|
+
annotation: {
|
|
69
|
+
level: "error",
|
|
70
|
+
title: "a11yst CI policy was not evaluated",
|
|
71
|
+
message,
|
|
72
|
+
},
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
else if (evaluation?.policyEnabled && evaluation.status === "failed") {
|
|
76
|
+
for (const breach of evaluation.breaches) {
|
|
77
|
+
const finding = findingByFingerprint(input.findings, breach.fingerprint);
|
|
78
|
+
candidates.push({
|
|
79
|
+
priority: breachPriority(breach),
|
|
80
|
+
annotation: annotationFromFinding(finding, "error", `a11yst: ${breach.ruleId}`, formatBreachMessage(breach), breach.fingerprint, diagnostics),
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
const sorted = sortCandidates(candidates);
|
|
85
|
+
const truncated = Math.max(0, sorted.length - maxAnnotations);
|
|
86
|
+
let selected = sorted.slice(0, maxAnnotations);
|
|
87
|
+
if (truncated > 0) {
|
|
88
|
+
diagnostics.push({
|
|
89
|
+
code: "truncated-annotations",
|
|
90
|
+
level: "info",
|
|
91
|
+
message: `GitHub annotations truncated to ${maxAnnotations}.`,
|
|
92
|
+
});
|
|
93
|
+
if (selected.length < maxAnnotations) {
|
|
94
|
+
selected = sorted.slice(0, maxAnnotations);
|
|
95
|
+
}
|
|
96
|
+
else {
|
|
97
|
+
selected = sorted.slice(0, maxAnnotations - 1);
|
|
98
|
+
selected.push({
|
|
99
|
+
priority: 9999,
|
|
100
|
+
annotation: {
|
|
101
|
+
level: "notice",
|
|
102
|
+
title: "a11yst annotations truncated",
|
|
103
|
+
message: `${truncated} additional annotations were not emitted.`,
|
|
104
|
+
},
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
const annotations = selected.map((candidate) => candidate.annotation);
|
|
109
|
+
const commands = annotations.length === 0
|
|
110
|
+
? ""
|
|
111
|
+
: `${annotations
|
|
112
|
+
.map((annotation) => serializeGitHubAnnotationCommand({
|
|
113
|
+
level: annotation.level,
|
|
114
|
+
title: annotation.title,
|
|
115
|
+
message: annotation.message,
|
|
116
|
+
...(annotation.file ? { file: annotation.file } : {}),
|
|
117
|
+
...(annotation.line !== undefined ? { line: annotation.line } : {}),
|
|
118
|
+
...(annotation.column !== undefined ? { column: annotation.column } : {}),
|
|
119
|
+
...(annotation.endLine !== undefined ? { endLine: annotation.endLine } : {}),
|
|
120
|
+
...(annotation.endColumn !== undefined ? { endColumn: annotation.endColumn } : {}),
|
|
121
|
+
}))
|
|
122
|
+
.join("\n")}\n`;
|
|
123
|
+
const summary = {
|
|
124
|
+
annotations: annotations.length,
|
|
125
|
+
errors: annotations.filter((annotation) => annotation.level === "error").length,
|
|
126
|
+
warnings: annotations.filter((annotation) => annotation.level === "warning").length,
|
|
127
|
+
notices: annotations.filter((annotation) => annotation.level === "notice").length,
|
|
128
|
+
truncated,
|
|
129
|
+
};
|
|
130
|
+
return {
|
|
131
|
+
annotations,
|
|
132
|
+
commands,
|
|
133
|
+
summary,
|
|
134
|
+
diagnostics: [...diagnostics].sort((a, b) => {
|
|
135
|
+
const byCode = a.code.localeCompare(b.code);
|
|
136
|
+
return byCode !== 0 ? byCode : a.message.localeCompare(b.message);
|
|
137
|
+
}),
|
|
138
|
+
};
|
|
139
|
+
}
|
|
140
|
+
//# sourceMappingURL=generate.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/github/generate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gCAAgC,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAQ7D,OAAO,EAAE,aAAa,IAAI,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAExF,MAAM,cAAc,GAAe,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;AAC3E,MAAM,uBAAuB,GAAG,EAAE,CAAC;AAOnC,SAAS,cAAc,CAAC,MAAoB;IAC1C,MAAM,YAAY,GAAG,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;IAClE,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,aAAa;YAChB,OAAO,GAAG,GAAG,YAAY,CAAC;QAC5B,KAAK,mBAAmB;YACtB,OAAO,GAAG,GAAG,YAAY,CAAC;QAC5B,KAAK,wBAAwB;YAC3B,OAAO,GAAG,GAAG,YAAY,CAAC;IAC9B,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,UAAuB;IAC7C,OAAO,CAAC,GAAG,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACnC,IAAI,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,QAAQ;YAAE,OAAO,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;QAC9D,MAAM,KAAK,GAAG,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QACnE,IAAI,KAAK,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QAC9B,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;IACxF,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,qBAAqB,CAC5B,IAAkC,EAClC,WAAyC;IAEzC,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IACrB,MAAM,UAAU,GAAgB,EAAE,CAAC;IACnC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,CAAC,MAAM,KAAK,QAAQ;YAAE,SAAS;QACtC,MAAM,OAAO,GACX,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,OAAO,CAAC,EAAE,OAAO;YACpE,GAAG,CAAC,UAAU;YACd,mBAAmB,CAAC;QACtB,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,MAAM,IAAI,KAAK,CAAC;QAC/C,UAAU,CAAC,IAAI,CAAC;YACd,QAAQ,EAAE,CAAC;YACX,UAAU,EAAE;gBACV,KAAK,EAAE,OAAO;gBACd,KAAK,EAAE,WAAW,KAAK,EAAE;gBACzB,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE;gBAC5C,WAAW,EAAE,GAAG,CAAC,KAAK;aACvB;SACF,CAAC,CAAC;QACH,IAAI,sCAAsC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACzD,WAAW,CAAC,IAAI,CAAC;gBACf,IAAI,EAAE,kBAAkB;gBACxB,KAAK,EAAE,MAAM;gBACb,OAAO,EAAE,+DAA+D;aACzE,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,KAA4B,EAC5B,UAAmC,EAAE;IAErC,MAAM,WAAW,GAAiC,EAAE,CAAC;IACrD,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,uBAAuB,CAAC;IACzE,MAAM,UAAU,GAAgB,qBAAqB,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAE/E,MAAM,UAAU,GAAG,KAAK,CAAC,gBAAgB,CAAC;IAC1C,IAAI,UAAU,EAAE,aAAa,IAAI,UAAU,CAAC,MAAM,KAAK,eAAe,EAAE,CAAC;QACvE,MAAM,OAAO,GACX,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,OAAO,CAAC,EAAE,OAAO;YACxE,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,OAAO;YAClC,uDAAuD,CAAC;QAC1D,UAAU,CAAC,IAAI,CAAC;YACd,QAAQ,EAAE,CAAC;YACX,UAAU,EAAE;gBACV,KAAK,EAAE,OAAO;gBACd,KAAK,EAAE,oCAAoC;gBAC3C,OAAO;aACR;SACF,CAAC,CAAC;IACL,CAAC;SAAM,IAAI,UAAU,EAAE,aAAa,IAAI,UAAU,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QACvE,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;YACzC,MAAM,OAAO,GAAG,oBAAoB,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;YACzE,UAAU,CAAC,IAAI,CAAC;gBACd,QAAQ,EAAE,cAAc,CAAC,MAAM,CAAC;gBAChC,UAAU,EAAE,qBAAqB,CAC/B,OAAO,EACP,OAAO,EACP,WAAW,MAAM,CAAC,MAAM,EAAE,EAC1B,mBAAmB,CAAC,MAAM,CAAC,EAC3B,MAAM,CAAC,WAAW,EAClB,WAAW,CACZ;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;IAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,cAAc,CAAC,CAAC;IAC9D,IAAI,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;IAC/C,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;QAClB,WAAW,CAAC,IAAI,CAAC;YACf,IAAI,EAAE,uBAAuB;YAC7B,KAAK,EAAE,MAAM;YACb,OAAO,EAAE,mCAAmC,cAAc,GAAG;SAC9D,CAAC,CAAC;QACH,IAAI,QAAQ,CAAC,MAAM,GAAG,cAAc,EAAE,CAAC;YACrC,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;QAC7C,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,GAAG,CAAC,CAAC,CAAC;YAC/C,QAAQ,CAAC,IAAI,CAAC;gBACZ,QAAQ,EAAE,IAAI;gBACd,UAAU,EAAE;oBACV,KAAK,EAAE,QAAQ;oBACf,KAAK,EAAE,8BAA8B;oBACrC,OAAO,EAAE,GAAG,SAAS,2CAA2C;iBACjE;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACtE,MAAM,QAAQ,GACZ,WAAW,CAAC,MAAM,KAAK,CAAC;QACtB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,GAAG,WAAW;aACX,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAClB,gCAAgC,CAAC;YAC/B,KAAK,EAAE,UAAU,CAAC,KAAK;YACvB,KAAK,EAAE,UAAU,CAAC,KAAK;YACvB,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,GAAG,CAAC,UAAU,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACnE,GAAG,CAAC,UAAU,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACzE,GAAG,CAAC,UAAU,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5E,GAAG,CAAC,UAAU,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACnF,CAAC,CACH;aACA,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IAExB,MAAM,OAAO,GAAG;QACd,WAAW,EAAE,WAAW,CAAC,MAAM;QAC/B,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC,MAAM;QAC/E,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,MAAM;QACnF,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,MAAM;QACjF,SAAS;KACV,CAAC;IAEF,OAAO;QACL,WAAW;QACX,QAAQ;QACR,OAAO;QACP,WAAW,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAC1C,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC5C,OAAO,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACpE,CAAC,CAAC;KACH,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { Finding } from "@a11yst/types";
|
|
2
|
+
import type { GitHubAnnotation, GitHubAnnotationDiagnostic } from "./types.js";
|
|
3
|
+
export declare function annotationFromFinding(finding: Finding | undefined, level: GitHubAnnotation["level"], title: string, message: string, fingerprint: string, diagnostics: GitHubAnnotationDiagnostic[]): GitHubAnnotation;
|
|
4
|
+
//# sourceMappingURL=source-location.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"source-location.d.ts","sourceRoot":"","sources":["../../src/github/source-location.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAC;AAgB/E,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,OAAO,GAAG,SAAS,EAC5B,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,EAChC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,0BAA0B,EAAE,GACxC,gBAAgB,CA+DlB"}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
import { validateSourceLocation } from "@a11yst/sarif";
|
|
2
|
+
import { formatReportSourceLocation, resolveFindingRecommendationSummary, resolveFindingReportSource, } from "../finding-source-report.js";
|
|
3
|
+
function flatLegacyRegion(location) {
|
|
4
|
+
return {
|
|
5
|
+
startLine: location.region.start.line,
|
|
6
|
+
startColumn: location.region.start.column,
|
|
7
|
+
endLine: location.region.end?.line,
|
|
8
|
+
endColumn: location.region.end?.column,
|
|
9
|
+
};
|
|
10
|
+
}
|
|
11
|
+
export function annotationFromFinding(finding, level, title, message, fingerprint, diagnostics) {
|
|
12
|
+
let composedMessage = message;
|
|
13
|
+
const recommendation = finding ? resolveFindingRecommendationSummary(finding) : undefined;
|
|
14
|
+
if (recommendation?.title) {
|
|
15
|
+
composedMessage = `${composedMessage} Suggested review: ${recommendation.title}.`;
|
|
16
|
+
}
|
|
17
|
+
if (!finding) {
|
|
18
|
+
return { level, title, message: composedMessage, fingerprint };
|
|
19
|
+
}
|
|
20
|
+
const source = resolveFindingReportSource(finding);
|
|
21
|
+
if (source.status === "ambiguous") {
|
|
22
|
+
const count = source.alternatives?.length ?? 0;
|
|
23
|
+
return {
|
|
24
|
+
level,
|
|
25
|
+
title,
|
|
26
|
+
message: `${composedMessage} Source location is ambiguous${count > 0 ? ` (${count} alternatives)` : ""}.`,
|
|
27
|
+
fingerprint,
|
|
28
|
+
};
|
|
29
|
+
}
|
|
30
|
+
if (source.status !== "mapped" || !source.location) {
|
|
31
|
+
return { level, title, message: composedMessage, fingerprint };
|
|
32
|
+
}
|
|
33
|
+
const confidence = source.confidence ?? "medium";
|
|
34
|
+
if (confidence === "medium" || confidence === "low") {
|
|
35
|
+
const locationText = formatReportSourceLocation(source.location);
|
|
36
|
+
return {
|
|
37
|
+
level,
|
|
38
|
+
title,
|
|
39
|
+
message: `${composedMessage} Probable source ${locationText} (${confidence} confidence).`,
|
|
40
|
+
fingerprint,
|
|
41
|
+
};
|
|
42
|
+
}
|
|
43
|
+
const validated = validateSourceLocation({
|
|
44
|
+
uri: source.location.uri,
|
|
45
|
+
...flatLegacyRegion(source.location),
|
|
46
|
+
});
|
|
47
|
+
if (!validated) {
|
|
48
|
+
diagnostics.push({
|
|
49
|
+
code: "invalid-source-location",
|
|
50
|
+
level: "warning",
|
|
51
|
+
message: `Omitted invalid source location for fingerprint ${fingerprint.slice(0, 8)}.`,
|
|
52
|
+
});
|
|
53
|
+
return { level, title, message: composedMessage, fingerprint };
|
|
54
|
+
}
|
|
55
|
+
return {
|
|
56
|
+
level,
|
|
57
|
+
title,
|
|
58
|
+
message: composedMessage,
|
|
59
|
+
file: validated.uri,
|
|
60
|
+
line: validated.region.startLine,
|
|
61
|
+
...(validated.region.startColumn !== undefined
|
|
62
|
+
? { column: validated.region.startColumn }
|
|
63
|
+
: {}),
|
|
64
|
+
...(validated.region.endLine !== undefined ? { endLine: validated.region.endLine } : {}),
|
|
65
|
+
...(validated.region.endColumn !== undefined ? { endColumn: validated.region.endColumn } : {}),
|
|
66
|
+
fingerprint,
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
//# sourceMappingURL=source-location.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"source-location.js","sourceRoot":"","sources":["../../src/github/source-location.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAGvD,OAAO,EACL,0BAA0B,EAC1B,mCAAmC,EACnC,0BAA0B,GAC3B,MAAM,6BAA6B,CAAC;AAErC,SAAS,gBAAgB,CAAC,QAAgF;IACxG,OAAO;QACL,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI;QACrC,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM;QACzC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI;QAClC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM;KACvC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,OAA4B,EAC5B,KAAgC,EAChC,KAAa,EACb,OAAe,EACf,WAAmB,EACnB,WAAyC;IAEzC,IAAI,eAAe,GAAG,OAAO,CAAC;IAC9B,MAAM,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC,mCAAmC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1F,IAAI,cAAc,EAAE,KAAK,EAAE,CAAC;QAC1B,eAAe,GAAG,GAAG,eAAe,sBAAsB,cAAc,CAAC,KAAK,GAAG,CAAC;IACpF,CAAC;IAED,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,CAAC;IACjE,CAAC;IAED,MAAM,MAAM,GAAG,0BAA0B,CAAC,OAAO,CAAC,CAAC;IACnD,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,MAAM,CAAC,YAAY,EAAE,MAAM,IAAI,CAAC,CAAC;QAC/C,OAAO;YACL,KAAK;YACL,KAAK;YACL,OAAO,EAAE,GAAG,eAAe,gCAAgC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,gBAAgB,CAAC,CAAC,CAAC,EAAE,GAAG;YACzG,WAAW;SACZ,CAAC;IACJ,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;QACnD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,CAAC;IACjE,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,QAAQ,CAAC;IACjD,IAAI,UAAU,KAAK,QAAQ,IAAI,UAAU,KAAK,KAAK,EAAE,CAAC;QACpD,MAAM,YAAY,GAAG,0BAA0B,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjE,OAAO;YACL,KAAK;YACL,KAAK;YACL,OAAO,EAAE,GAAG,eAAe,oBAAoB,YAAY,KAAK,UAAU,eAAe;YACzF,WAAW;SACZ,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAG,sBAAsB,CAAC;QACvC,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG;QACxB,GAAG,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC;KACrC,CAAC,CAAC;IACH,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,WAAW,CAAC,IAAI,CAAC;YACf,IAAI,EAAE,yBAAyB;YAC/B,KAAK,EAAE,SAAS;YAChB,OAAO,EAAE,mDAAmD,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;SACvF,CAAC,CAAC;QACH,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,CAAC;IACjE,CAAC;IAED,OAAO;QACL,KAAK;QACL,KAAK;QACL,OAAO,EAAE,eAAe;QACxB,IAAI,EAAE,SAAS,CAAC,GAAG;QACnB,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,SAAS;QAChC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS;YAC5C,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE;YAC1C,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxF,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9F,WAAW;KACZ,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import type { AuditRunResult, Finding, FindingLocation, PolicyBreach } from "@a11yst/types";
|
|
2
|
+
import type { MarkdownReportInput } from "../markdown/types.js";
|
|
3
|
+
export type GitHubAnnotationLevel = "error" | "warning" | "notice";
|
|
4
|
+
export type GitHubAnnotation = {
|
|
5
|
+
level: GitHubAnnotationLevel;
|
|
6
|
+
title: string;
|
|
7
|
+
message: string;
|
|
8
|
+
file?: string;
|
|
9
|
+
line?: number;
|
|
10
|
+
column?: number;
|
|
11
|
+
endLine?: number;
|
|
12
|
+
endColumn?: number;
|
|
13
|
+
fingerprint?: string;
|
|
14
|
+
};
|
|
15
|
+
export type GitHubAnnotationInput = MarkdownReportInput & {
|
|
16
|
+
runs?: AuditRunResult[];
|
|
17
|
+
};
|
|
18
|
+
export type GitHubAnnotationOptions = {
|
|
19
|
+
maxAnnotations?: number;
|
|
20
|
+
};
|
|
21
|
+
export type GitHubAnnotationDiagnosticCode = "truncated-annotations" | "invalid-source-location" | "redacted-content";
|
|
22
|
+
export type GitHubAnnotationDiagnostic = {
|
|
23
|
+
code: GitHubAnnotationDiagnosticCode;
|
|
24
|
+
level: "info" | "warning" | "error";
|
|
25
|
+
message: string;
|
|
26
|
+
};
|
|
27
|
+
export type GitHubAnnotationGenerationResult = {
|
|
28
|
+
annotations: GitHubAnnotation[];
|
|
29
|
+
commands: string;
|
|
30
|
+
summary: {
|
|
31
|
+
annotations: number;
|
|
32
|
+
errors: number;
|
|
33
|
+
warnings: number;
|
|
34
|
+
notices: number;
|
|
35
|
+
truncated: number;
|
|
36
|
+
};
|
|
37
|
+
diagnostics: GitHubAnnotationDiagnostic[];
|
|
38
|
+
};
|
|
39
|
+
export declare function formatBreachLocation(location: FindingLocation): string;
|
|
40
|
+
export declare function breachMessage(breach: PolicyBreach): string;
|
|
41
|
+
export declare function findingByFingerprint(findings: Finding[], fingerprint: string): Finding | undefined;
|
|
42
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/github/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC5F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAEhE,MAAM,MAAM,qBAAqB,GAAG,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEnE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,qBAAqB,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,mBAAmB,GAAG;IACxD,IAAI,CAAC,EAAE,cAAc,EAAE,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,8BAA8B,GACtC,uBAAuB,GACvB,yBAAyB,GACzB,kBAAkB,CAAC;AAEvB,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,8BAA8B,CAAC;IACrC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;IACpC,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,WAAW,EAAE,gBAAgB,EAAE,CAAC;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE;QACP,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,WAAW,EAAE,0BAA0B,EAAE,CAAC;CAC3C,CAAC;AAEF,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,CAKtE;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAQ1D;AAED,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,OAAO,EAAE,EACnB,WAAW,EAAE,MAAM,GAClB,OAAO,GAAG,SAAS,CAErB"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export function formatBreachLocation(location) {
|
|
2
|
+
if (location.kind === "route") {
|
|
3
|
+
return `route ${location.route}`;
|
|
4
|
+
}
|
|
5
|
+
return `flow ${location.flowId} / ${location.checkpointId}`;
|
|
6
|
+
}
|
|
7
|
+
export function breachMessage(breach) {
|
|
8
|
+
const prefix = breach.kind === "new-finding"
|
|
9
|
+
? "New"
|
|
10
|
+
: breach.kind === "regressed-finding"
|
|
11
|
+
? "Regressed"
|
|
12
|
+
: "Expired classification breach for";
|
|
13
|
+
return `${prefix} ${breach.severity} accessibility finding in ${breach.projectName} at ${formatBreachLocation(breach.location)}. Fingerprint: ${breach.fingerprint.slice(0, 8)}.`;
|
|
14
|
+
}
|
|
15
|
+
export function findingByFingerprint(findings, fingerprint) {
|
|
16
|
+
return findings.find((finding) => finding.fingerprint === fingerprint);
|
|
17
|
+
}
|
|
18
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/github/types.ts"],"names":[],"mappings":"AAiDA,MAAM,UAAU,oBAAoB,CAAC,QAAyB;IAC5D,IAAI,QAAQ,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC9B,OAAO,SAAS,QAAQ,CAAC,KAAK,EAAE,CAAC;IACnC,CAAC;IACD,OAAO,QAAQ,QAAQ,CAAC,MAAM,MAAM,QAAQ,CAAC,YAAY,EAAE,CAAC;AAC9D,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAoB;IAChD,MAAM,MAAM,GACV,MAAM,CAAC,IAAI,KAAK,aAAa;QAC3B,CAAC,CAAC,KAAK;QACP,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,mBAAmB;YACnC,CAAC,CAAC,WAAW;YACb,CAAC,CAAC,mCAAmC,CAAC;IAC5C,OAAO,GAAG,MAAM,IAAI,MAAM,CAAC,QAAQ,6BAA6B,MAAM,CAAC,WAAW,OAAO,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC;AACpL,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,QAAmB,EACnB,WAAmB;IAEnB,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,WAAW,KAAK,WAAW,CAAC,CAAC;AACzE,CAAC"}
|
package/dist/html.d.ts
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { AuditExecutionResult } from "@a11yst/types";
|
|
2
|
+
import { type LoadedProfileEvidence } from "./profile-evidence.js";
|
|
3
|
+
export interface RenderHtmlReportOptions {
|
|
4
|
+
auditId?: string;
|
|
5
|
+
loadedProfileEvidence?: Map<string, LoadedProfileEvidence>;
|
|
6
|
+
}
|
|
7
|
+
export declare function renderHtmlReport(auditResult: AuditExecutionResult, options?: RenderHtmlReportOptions): string;
|
|
8
|
+
//# sourceMappingURL=html.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"html.d.ts","sourceRoot":"","sources":["../src/html.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EAMrB,MAAM,eAAe,CAAC;AAevB,OAAO,EACL,KAAK,qBAAqB,EAE3B,MAAM,uBAAuB,CAAC;AAwe/B,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qBAAqB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;CAC5D;AA4DD,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,oBAAoB,EACjC,OAAO,GAAE,uBAA4B,GACpC,MAAM,CA0KR"}
|