Skip to content

Library for commenting things with violations from static code analysis.

License

Notifications You must be signed in to change notification settings

bonzani/violation-comments-lib

 
 

Repository files navigation

Violation Comments Lib Build Status Maven Central Bintray

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:

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:

  • violation that 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}}

About

Library for commenting things with violations from static code analysis.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 99.7%
  • Shell 0.3%