[OFBIZ-11251] Use ‘checkstyle’ linting tool

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Implemented
• Affects Version/s: Trunk
• Fix Version/s: Upcoming Branch
• Component/s: framework
• Assignee: Mathieu Lirzin
• Reporter: Mathieu Lirzin
• Created: 14/Oct/19 16:40
• Updated: 22/Oct/19 08:56
• Resolved: 19/Oct/19 13:26

Description

Linting [1] is a software engineering practice which make the code
more readable and maintainable by improving its consistency and
avoiding potential programming mistakes.

Gradle provides a core plugin for the ‘checkstyle’ tool [2][3] which
provides such facility. The lint actions are triggered when running
‘gradle check’.

There are a lot reported errors that will need to be fixed
incrementally in the future. We ensure that new errors will not be
introduced by defining a global threshold of “allowed” errors
corresponding to the sum of errors currently found in the framework
and in the official plugins.

[1] https://en.wikipedia.org/wiki/Lint_(software)
[2] https://checkstyle.org/
[3] https://docs.gradle.org/current/userguide/checkstyle_plugin.html