- Documentation
- Getting Started
- XClarify Analysis
- Code Rule and Query
- XClarify Features
- Build Process Integration
- Code Metrics Definitions
- Trend Monitoring
Validating CQLinq Code Rules
- Checking if there are Rules Violations
- Rules Explorer and Rules Edition
- Focusing on Recent Code Rules Violations
- Rules Execution Options
One popular aspect of the tool XClarify is the integration of the tool into the Continuous Integration build process. Every morning the team leader gets an up-to-date report telling if some coding rules written with CQLinq have been violated within the last 24h.
Checking if there are Rules Violations
The developer gets permanently informed of CQLinq rules validation status thanks to a XClarify progress circle located in the bottom-right corner of the XClarify.
means that all CQLinq rules are validated,
means some activated CQLinq rules are violated,
means:
- some critical CQLinq rules are violated or
- some activated CQLinq rules or queries don't compile or
- some activated CQLinq rules or queries have an execution problem (exception thrown or time-out)
animated icon + progressing, means that the code is currently analyzed by XClarify,-
means that no XClarify project is currently loaded.
On the XClarify top bar, you can see the number of rules violated and the number of rules violations.
Rules Explorer and Rules Edition
The CQLinq Explorer lists all rules grouped by categories…
... and by clicking a rule you can jump to the CQLinq edition panel, where you can edit the rule and see culprit methods or classes that violate the rule.
Of course double clicking a culprit method or class lets jump to its source code declaration.
Focusing on Recent Code Rules Violations
On a large legacy code base, XClarify will likely report thousands of code violations. XClarify 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.