Plugin

Quality Checkstyle

Plugin ID
com.helixframework.quality-checkstyle
Plugin Type
Project

Applies Checkstyle with the Helix default rule set and reporting defaults.

  • Applies the Gradle checkstyle plugin.
  • Uses .helix/checkstyle/checkstyle.xml when it exists, otherwise falls back to the embedded default rules.
  • Enables XML and HTML reports and increases Checkstyle task heap settings.

Usage

build.gradle

Groovy DSL

plugins {
    id 'com.helixframework.quality-checkstyle'
}

build.gradle.kts

Kotlin DSL

plugins {
    id("com.helixframework.quality-checkstyle")
}

Configuration

No Helix-specific extension is added by this plugin.

Default Behavior

  • No Helix-specific extension is added.
  • The underlying checkstyle extension is preconfigured with toolVersion 10.1.
  • To override the ruleset without editing the build, place a custom file at .helix/checkstyle/checkstyle.xml.