Violations

An artifact is said to violate a metric if it is rated amber or red for that metric. For each artifact, STAN shows you all metrics that are violated by the artifact itself or by contained artifacts.

To take further profit of our ratings, we can use them to rank metric violations. However, simply sorting by rating isn't good enough. What we need is a measure for relevance.

STAN assumes that violations at “big” artifacts are worse than violations at “small” ones: it should be more relevant if a package received a bad rating for some metric A than if one of its 42 classes received a similar rating for some metric B. Moreover, even if a package is rated amber for A, this might be more relevant than if one of its classes is rated red for B.

To take this into account, STAN prioritizes a metric violation by weighting its rating with the amount of the artifact's underlying code. The result is shown in the Violations View.

Violations View

Finally, for a given artifact, we might want to get a feeling for how metrics contribute to its violations and how badly the artifact is polluted by violations. STAN's Pollution Chart shows us exactly this.

Pollution Chart

Selecting a slice as shown above filters the Violations View to the corresponding metric.

The wider the ring, the higher the degree of pollution of the underlying code. On the application level, the ring's thickness can serve as a quick indicator for the overall structural quality of the code base.

 
< Prev
STAN 2.1.2

We are pleased to announce the 2.1.2 maintenance release of STAN, adding support for Java 8.

Read more...