haskell-actions/hlint-scan

Fill out `rules` object for better GitHub code scanning entries

chungyc opened this issue · 0 comments

GitHub uses the rules object to select the title of entries. Including it will make it nicer to display entries in the code scanning dashboard, instead of the long lines we currently have which is basically the entire message for an issue. This would also be more consistent with other systems such as CodeQL and OSSF Scorecard.

SARIF does not require that tools fill the rules object, and given that we cannot fill it properly and would only be doing this for a better interface on GitHub, we should be adding the rules object and not HLint.

The following should be done:

  • Use the rule ID as the ID, name, and descriptions.
  • Consider filling in properties.

Rules are supposed to be agnostic to the code being diagnosed, so it should include any content which only applies to one code location.