Skip to content

Changed Sarif descriptions to be more useful #26

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
ptzianos merged 1 commit into from
Sep 15, 2025
Merged

Changed Sarif descriptions to be more useful #26

Show file tree
Hide file tree
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
19 changes: 5 additions & 14 deletions sarif/sarif.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,26 +573,17 @@ func (s *SarifTransformer) mapTitleDesc(res *sarif.Result, ruleToTools map[strin
}
}
if s.richDescription {
backUPDescription := descr
richInfoAdded := false
descr = fmt.Sprintf("Original Description: %s", descr)
if rule.Help != nil {
if rule.Help.Text != "" {
richInfoAdded = true
descr = fmt.Sprintf("%s\n Help: %s", descr, rule.Help.Text)
if rule.Help.Text != "" && rule.Help.Text != descr {
descr = fmt.Sprintf("%s\n\n Help: %s", descr, rule.Help.Text)
} else if rule.Help.Markdown != nil && *rule.Help.Markdown != "" {
richInfoAdded = true
descr = fmt.Sprintf("%s\n Help: %s", descr, *rule.Help.Markdown)
descr = fmt.Sprintf("%s\n\n Help: %s", descr, *rule.Help.Markdown)
}
}
if rule.HelpUri != nil && *rule.HelpUri != "" {
richInfoAdded = true
descr = fmt.Sprintf("%s\n HelpUri: %s", descr, *rule.HelpUri)
}
if !richInfoAdded {
// remove the "Original Description:" part since the whole description is the original
descr = backUPDescription
descr = fmt.Sprintf("%s\n\n More info: %s", descr, *rule.HelpUri)
}

}
return
}
Expand Down
Loading
Loading