README.md

Scala Style Gradle Plugin

Instructions

maven repo: http://jcenter.bintray.com/
groupId: org.github.ngbinh.scalastyle
artifactId:  gradle-scalastyle-plugin_2.11
version: 1.0.1

Use artifactId: gradle-scalastyle-plugin_2.10 if you want to use with Scala 2.10

  apply plugin: 'scalaStyle'

Add following dependencies to your buildScript

  classpath "org.github.ngbinh.scalastyle:gradle-scalastyle-plugin_2.11:1.0.1"

Configure the plugin

  scalaStyle {
    configLocation = "/path/to/scalaStyle.xml"
    includeTestSourceDirectory = true
    source = "src/main/scala"
    testSource = "src/test/scala"
  }

Other optional properties are

  outputFile  //Default => $buildDir/scala_style_result.xml
  outputEncoding //Default => UTF-8
  failOnViolation //Default => true
  failOnWarning //Default => false
  skip  //Default => false
  verbose //Default => false
  quiet //Default => false
  includeTestSourceDirectory //Default => false
  testConfigLocation //Separate configuration file to be used for test sources
  inputEncoding //Default => UTF-8

Full Buildscript Example

  apply plugin: 'scalaStyle'

  buildscript {
    repositories {
      jcenter() // only work after gradle 1.7
    }

    dependencies {
      classpath 'org.github.ngbinh.scalastyle:gradle-scalastyle-plugin_2.11:1.0.1'
    }
  }

  scalaStyle {
    configLocation = "mega-project/sub-project/scalastyle_config.xml"
    includeTestSourceDirectory = true
    source = "src/main/scala"
    testSource = "src/test/scala"
  }