[jira] [Commented] (OFBIZ-11251) Use ‘checkstyle’ linting tool

[Nicolas Malin (Jira)]

    [ https://issues.apache.org/jira/browse/OFBIZ-11251?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17158958#comment-17158958 ]

Aditya Sharma commented on OFBIZ-11251:
---------------------------------------

Not sure about that, maybe we can have Gradle system in place with just checkstyle plugin. I am not sure how feasible will that be. I will dig more.
Though I did found some existing solution on GitHub Action [marketplace
|https://github.com/marketplace]
Java
[Google Java Format|https://github.com/marketplace/actions/google-java-format]
[Run java checkstyle|https://github.com/marketplace/actions/run-java-checkstyle]
[Prettier Java Action

|https://github.com/marketplace/actions/prettier-java-action]XML
[xmllint problem matcher
|https://github.com/marketplace/actions/xmllint-problem-matcher]
XML, JavaScript, Groovy
[Super-Linter

|https://github.com/marketplace/actions/super-linter]These can solve the problem for the PRs but commits done directly may remain unaffected.

> Use ‘checkstyle’ linting tool
> -----------------------------
>
>                 Key: OFBIZ-11251
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-11251
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: framework
>    Affects Versions: Trunk
>            Reporter: Mathieu Lirzin
>            Assignee: Aditya Sharma
>            Priority: Minor
>             Fix For: Upcoming Branch
>
>         Attachments: OFBIZ-11251-Use-checkstyle-linting-tool.patch
>
>
> 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

--
This message was sent by Atlassian Jira
(v8.3.4#803005)