Skip to content

Keep the rule's explanation in the report #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
satsura merged 1 commit into from
Jul 13, 2026
Merged

Keep the rule's explanation in the report #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions src/merge.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,17 @@ interface SarifRun {
[key: string]: unknown;
}

/** Rule fields the backend uses (severity, docs) or that stay cheap. Everything
* else — `help`, `fullDescription`, `relationships` — is prose we would ship
* by the megabyte. */
const KEPT_RULE_FIELDS = ["id", "name", "shortDescription", "helpUri", "properties", "defaultConfiguration"];
/**
* Rule fields worth their weight: severity (`properties`), the human title
* (`shortDescription`), the explanation (`fullDescription`) and the docs link.
*
* `help` is dropped — scanners repeat the whole advisory there, which is what
* made these reports weigh tens of megabytes. `fullDescription` is a sentence
* or two and is what a reader actually needs.
*/
const KEPT_RULE_FIELDS = [
"id", "name", "shortDescription", "fullDescription", "helpUri", "properties", "defaultConfiguration",
];

function slimRule(rule: SarifRule): SarifRule {
const out: SarifRule = {};
Expand Down
Loading