Interface CodeClimateRule

  • All Superinterfaces:
    PropertySource, Rule

    public interface CodeClimateRule
    extends Rule
    This interface tags a Rule specifying properties required for the Code Climate output format. Each rule implementing this interface must define the two code climate properties "categories" and "remediation multiplier".
    • Field Detail


        static final EnumeratedMultiProperty<String> CODECLIMATE_CATEGORIES
        Defines the code climate categories for which this rule will find violations. Possible categories are: Bug Risk, Clarity, Compatibility, Complexity, Duplication, Performance, Security, Style.
        See Also:
        Code Climate Spec

        static final BooleanProperty CODECLIMATE_BLOCK_HIGHLIGHTING
        Defines if the whole related block or just the first line of the issue should be highlighted at the Code Climate Platform. By default the block highlighting is disabled for reasons of clarity.