Gradle WartRemover Plugin

Gradle plugin to apply WartRemover, the Scala linting tool.

It applies the WartRemover plugin with same settings to all ScalaCompile tasks, so even the test code is checked.

“Keep your tests clean. Treat them as first-class citizens of the system.” Robert C. Martin (Uncle Bob)

If you want to have different settings for tests then you can use the test block as shown below. If you don’t use test block then all the settings is applied to all the Scala code.

Please note that since 0.15.0 version at least Gradle 6.4 is required (because the plugin uses scalaCompilerPlugins configuration).

Usage

The plugin is published to Gradle Plugins portal

plugins {
  id 'cz.augi.gradle.wartremover' version 'putCurrentVersionHere'
}

wartremover {
    errorWarts.add('Product') // set of warts to use - violation causes error; default is empty set
    warningWarts.add('Product') // set of warts to use - violation causes warning; default is set of all stable warts
    excludedFiles.add('src/main/scala/me/project/Main.scala') // set of file to be excluded; default is empty
    classPaths.add(new File("path/to/yourWarts").toURI().toURL().toString()) // set of files or directories to be added to the classpath if using custom warts; default is empty
    test {
        errorWarts.add('Serializable') // set of warts to use - violation causes error; default settings from the block above
        warningWarts.add('Serializable') // set of warts to use - violation causes warning; default settings from the block above
        excludedFiles.add('src/test/scala/me/project/Test.scala') // set of file to be excluded; default settings from the block above
        classPaths.add(new File("path/to/yourTestWarts").toURI().toURL().toString()) // set of files or directories to be added to the classpath if using custom warts; default settings from the block above
    }
}