Page MenuHomePhabricator
Create Task
Maniphest T9886

Add Java linters, checkstyle and PMD
Open, Needs TriagePublic
Actions

Description

The checkstyle utility (http://checkstyle.sourceforge.net/) is a common tool for linting coding standards. It comes with configurations to support two coding standards (Sun's and Google's), however customized coding standards can be configured through XML file. The CLI supports a basic XML report over stdout which fits nicely with arcanist's lint engine structure.

The PMD utility (https://pmd.github.io/) is another tool for linting general java errors, as well as having the ability to detect copy/pasted code. The CLI also supports basic XML report over stdout which can feed into arcanist's lint engine.

Revisions and Commits

rARC Arcanist
AbandonedD14632 Add Java linters, checkstyle and PMD

Related Objects

Event Timeline

cspeckmim created this task.Dec 2 2015, 5:36 AM
cspeckmim claimed this task.
cspeckmim updated the task description. (Show Details)
cspeckmim added projects: Lint, Arcanist.
cspeckmim added a subscriber: cspeckmim.
cspeckmim added a revision: D14632: Add Java linters, checkstyle and PMD.Dec 2 2015, 5:53 AM
joshuaspence added a subscriber: joshuaspence.Dec 2 2015, 6:03 AM
cspeckmim renamed this task from Add checkstyle for Java linting to Add linters for Java.Dec 8 2015, 7:23 AM
cspeckmim updated the task description. (Show Details)
epriestley moved this task from Backlog to Bindings on the Lint board.Dec 22 2015, 12:45 PM
epriestley mentioned this in T10038: Plan the mid-term pathway for unit-test/linter bindings.Dec 22 2015, 12:59 PM
cspeckmim renamed this task from Add linters for Java to Add Java linters, checkstyle and PMD.Jan 2 2016, 1:23 AM
cspeckmim added a comment.Jan 2 2016, 1:39 AM

I renamed the task to indicate specifically which linters are being asked for, so as not to just request generic "Java" ones. Initially this task was just for checkstyle, but after I got it working in D14632 I decided to give PMD a shot as well. In hindsight it probably would have been beneficial to keep them separate, though there is a dependency on some changes in order to get a java jar to run as a linter. Let me know if you prefer them to be separated to different revisions/tasks.

eadler added a project: Restricted Project.Jan 11 2016, 9:39 PM
eadler moved this task from Restricted Project Column to Restricted Project Column on the Restricted Project board.Jan 11 2016, 9:42 PM
kaya added a subscriber: kaya.Jan 15 2016, 1:18 AM
avivey added a subscriber: avivey.Feb 14 2016, 10:45 PM

Findbugs produces HTML, so I've made it into remarkup at https://github.com/avivey/remarkup-java (In Community Resources).

cspeckmim added a comment.Feb 22 2016, 9:34 PM

I thought FindBugs required analysis of the .class files which I didn't think would make useful for linting, but perhaps as UT or something?

avivey added a comment.Feb 23 2016, 2:01 AM

It does require .class files - I run it in the CI along with the tests (And PMD).

A lot of Java tools require .class files :-/

cspeckmim added a comment.Feb 23 2016, 2:38 AM

I've been avoiding those tools as compiling our project for .class files requires a lengthy amount of time, which would be better integrated into our jenkins test runners.

ralph.van.etten added a subscriber: ralph.van.etten.May 18 2016, 10:44 AM
Herald added a subscriber: eadler. · View Herald TranscriptMay 18 2016, 10:44 AM
eadler moved this task from Restricted Project Column to Restricted Project Column on the Restricted Project board.Jul 4 2016, 9:10 PM
cspeckmim removed cspeckmim as the assignee of this task.Nov 2 2016, 4:26 AM
epriestley moved this task from Backlog to Unit/Lint Bindings on the Arcanist board.Nov 14 2016, 5:49 PM
mtsgrd added a subscriber: mtsgrd.Feb 22 2017, 1:44 PM
kszatan added a subscriber: kszatan.Aug 15 2017, 9:16 PM
Phabricator · Built by Phacility