sarifReport function
SARIF 2.1.0 report, for GitHub code scanning and other viewers.
Implementation
String sarifReport(CheckResult result) {
String level(Severity s) => switch (s) {
Severity.error => 'error',
Severity.warning => 'warning',
Severity.info => 'note',
};
final ruleIndex = {
for (var i = 0; i < allRules.length; i++) allRules[i].id: i,
};
final data = {
r'$schema': 'https://json.schemastore.org/sarif-2.1.0.json',
'version': '2.1.0',
'runs': [
{
'tool': {
'driver': {
'name': 'tarpit',
'version': packageVersion,
'informationUri': 'https://github.com/saimskywalker/tarpit',
'rules': [
for (final rule in allRules)
{
'id': rule.id,
'name': rule.id,
'shortDescription': {'text': rule.title},
'fullDescription': {'text': rule.why},
'help': {'text': rule.fix},
'helpUri': '$_rulesDoc#${rule.id}',
'defaultConfiguration': {'level': level(rule.severity)},
},
],
},
},
'results': [
for (final Finding f in result.findings)
{
'ruleId': f.rule.id,
'ruleIndex': ruleIndex[f.rule.id],
'level': level(f.severity),
'message': {'text': '${f.message} Fix: ${f.rule.fix}'},
'locations': [
{
'physicalLocation': {
'artifactLocation': {'uri': f.path.replaceAll(r'\', '/')},
'region': {'startLine': f.line, 'startColumn': f.column},
},
},
],
},
],
},
],
};
return '${const JsonEncoder.withIndent(' ').convert(data)}\n';
}