View on GitHub

Scalastyle - Scala style checker

Scalastyle examines your Scala code and indicates potential problems with it. If you have come across Checkstyle for Java, then you’ll have a good idea what scalastyle is. Except that it’s for Scala obviously.

Scalastyle was recently used as part of the grading framework for the course Functional Programming Principles in Scala by Martin Odersky on Coursera.

How do I use scalastyle?

The latest stable version of Scalastyle is 0.6.0 for Scala 2.10 and 2.11. See the Release Notes

There are several ways of using it:

And you’ll need a configuration.

Download

To download Scalastyle, the jar is available from Sonatype 2.11. There is also a version for 2.10.
For the maven plugin, see Scalastyle Maven Plugin
For the SBT plugin, see Scalastyle SBT Plugin
Eclipse plugin (for 4.2 Juno / 4.3 Kepler): Update site http://www.scalastyle.org/downloads/kepler-0.6.0/site

The latest development snapshots are available from Sonatype snapshots

Rules

For a list of actual rules, see Implemented Rules.

For a list of (planned) rules, see the Scalastyle WIKI. If you want to add a rule, then please raise an Issue (or even better a pull request)

For a list of rules in the latest development version, see Development Implemented Rules.

For the version 0.6.0 rules, see 0.6.0 Implemented Rules.

For the version 0.5.0 rules, see 0.5.0 Implemented Rules.

For the version 0.4.0 rules, see 0.4.0 Implemented Rules.

For the version 0.3.0 rules, see 0.3.0 Implemented Rules.

For the version 0.2.0 rules, see 0.2.0 Implemented Rules.

For the version 0.1.0 rules, see 0.1.0 Implemented Rules.

Questions and comments

If you have any questions or comments, please see Scalastyle users Google groups

Github repositories