If you are new to JArchitect reporting, before digging into report customization, it is recommended to:
On the main page, the report contains a section titled Summary of CQLinq Rules violated.
For each CQLinq rule you can choose whether you want to display violation in report (Active tickbox). In case of violation you can choose if you want to display list of items selected in report, statistics about this list of items, and a selection view of items selected. The fourth check button is related to making a CQLinq rule critical or not.
Here is what a CQLinq rule violated looks like in report:
On a large legacy code base, JArchitect will likely report thousands of code violations. JArchitect proposes the possibility to focus only on recent code rules violations. Only violations that occur on code elements added or refactored since the baseline for comparison will be reported.
Hence this feature represents a way to prioritize the rules violations be reducing significantly the number of violations reported to focus only on recent ones. To activate this feature, both on rules violations reported in the interactive UI and in the report, just tick the box Recent Violations Only on the Dashboard. A baseline for comparison needs to be defined to get this feature working.
Reporting the set of rules violated is useful, but it is also interesting to report some result sets of a few CQLinq queries. For example, you might want to write CQLinq queries to ask for methods and types added or refactored since the last release. And you might want to list these methods and types added or refactored in the report.
To do so, JArchitect make possible to append extra report sections that lists these CQLinq queries. In the CQLinq Query Explorer panel, a particular CQLinq group reported is bordered with an orange rectangle.
And here are the extra report sections:
It is recommended to de-activate the Type Metrics and Type Dependencies sections since they can become pretty large if you have more than a thousand types in your application. Typically, browsing type metrics and dependencies is a scenario better addressed through the interactive UI.
By default, JArchitect sets a few flags on Project Properties to avoid too large reports: