PMD Reports

Overview

PMDReports is a wrapper around the popular open-source Java code analysis and bug detection tool, PMD. Whereas PMD generates and displays code quality statistics at a source code level, PMDReports persists and aggregates these statistics so that code quality can be viewed from a more macro, component level. From this "elevated" perspective, development team members can begin to better understand:
  1. Which components in a project have the best or worst code quality?
  2. As development continues, is code quality improving? Or getting worse?
  3. How does code quality in this project compare to other projects?

Sample Reports

Below is a sample Component Comparison Report generated from PMDReports. It shows PMD code quality violations for each component in a project, organized by PMD ruleset (note: violation numbers are per thousand lines of code). To highlight which components best adhere to code quality standards, those components with violations that are below a minimum pre-defined benchmark are displayed in green, and similarly those with violations above a pre-defined maximum benchmark are displayed in red.



By contrast, a Component History Report shows code quality violations for components over time rather than at a snapshot view. To help the user visualize trends in code quality, if violations for a specific component have gotten worse, these violations will be displayed in red, and vice-versa if violations have gotten better, they will be displayed in green. Note that, again, violations are scaled per thousand lines of code.