This is a library that helps working with comments from static code analysis.
It supports the same formats as Violations Lib.
It is used by these libraries:
- Violation Comments to GitHub Lib.
- Violation Comments to GitLab Lib.
- Violation Comments to Bitbucket Server Lib.
It uses a template to render each violation comment. There is a default that can be replaced with a custom template.
The context available when the template is rendered is:
violationthat is an instance of Violation.
A template may look like:
**Reporter**: {{violation.reporter}}{{#violation.rule}}
**Rule**: {{violation.rule}}{{/violation.rule}}
**Severity**: {{violation.severity}}
**File**: {{violation.file}} L{{violation.startLine}}{{#violation.source}}
**Source**: {{violation.source}}{{/violation.source}}
{{violation.message}}