Added code-quality assurance tools to pom.xml #16
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Added CheckStyle to perform static analysis on the Recaf codebase. * View output on the console with "mvn checkstyle:check". * Added FindBugs to check for common anti-patterns that tend to cause bugs. * View the output on the console with "mvn clean compile; mvn findbugs:check". * View the output in the GUI with "mvn clean compile; mvn findbugs:gui". * "mvn site" should now include HTML versions of the CheckStyle and FindBugs reports. Note that for the FindBugs one to show up, you might need to run "mvn clean compile" before "mvn site". * In the future, the project should be configured to refuse to compile if any CheckStyle or FindBugs issues are present (i.e. after the standing issues are fixed). * For CheckStyle: http://maven.apache.org/plugins/maven-checkstyle-plugin/usage.html * For FindBugs: http://memorynotfound.com/findbugs-maven-plugin-fail-build/
…pile. There were lots of method where JavaDoc was throwing errors due to description fields not being filled out. I have filled all of them in, and done my best to make my descriptions accurate. There were a few places where I was insufficiently familiar with the code and simply left TODOS. More work needs to be done to get the JavaDoc for this project into a useful state, but it (the JavaDoc) at least actually compiles now.
Closed
This reduced the number of checkstyle warnings by about 400, and should provide a good starting point for ongoing code style and quality improvement.
* Added CheckStyle to perform static analysis on the Recaf codebase. * View output on the console with "mvn checkstyle:check". * Added FindBugs to check for common anti-patterns that tend to cause bugs. * View the output on the console with "mvn clean compile; mvn findbugs:check". * View the output in the GUI with "mvn clean compile; mvn findbugs:gui". * "mvn site" should now include HTML versions of the CheckStyle and FindBugs reports. Note that for the FindBugs one to show up, you might need to run "mvn clean compile" before "mvn site". * In the future, the project should be configured to refuse to compile if any CheckStyle or FindBugs issues are present (i.e. after the standing issues are fixed). * For CheckStyle: http://maven.apache.org/plugins/maven-checkstyle-plugin/usage.html * For FindBugs: http://memorynotfound.com/findbugs-maven-plugin-fail-build/
Col-E
added a commit
that referenced
this pull request
Oct 15, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added CheckStyle to perform static analysis on the Recaf codebase.
Added FindBugs to check for common anti-patterns that tend to cause
bugs.
View the output on the console with "mvn clean compile; mvn
findbugs:check".
View the output in the GUI with "mvn clean compile; mvn
findbugs:gui".
"mvn site" should now include HTML versions of the CheckStyle and
FindBugs reports. Note that for the FindBugs one to show up, you might
need to run "mvn clean compile" before "mvn site".
In the future, the project should be configured to refuse to compile
if any CheckStyle or FindBugs issues are present (i.e. after the
standing issues are fixed).
For CheckStyle: http://maven.apache.org/plugins/maven-checkstyle-plugin/usage.html
For FindBugs: http://memorynotfound.com/findbugs-maven-plugin-fail-build/