JarCastingViolation Comments Lib
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.
- Violation Comments to Bitbucket Cloud Lib
Template
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.changedFilethat is an instance of ChangedFile.
The templating language is Mustache and may look like:
**Reporter**: {{violation.reporter}}{{#violation.rule}}
**Rule**: {{violation.rule}}{{/violation.rule}}
**Severity**: {{violation.severity}}
**File**: {{changedFile.filename}} L{{violation.startLine}}{{#violation.source}}
**Source**: {{violation.source}}{{/violation.source}}
{{violation.message}}
You can avoid escaping (replaces new lines with ) by using triple { like this:
{{{violation.message}}}
When using command line tools you may have problems with the ` (accent) character. You can do:
...
-comment-template "
message:
\\\`\\\`\\\`
{{{violation.message}}}
\\\`\\\`\\\`
"
And it will surround the message with triple ```.