sbt-houserules

SBT plugin to share common settings for Scala projects at Faculty.

Features

Currently, this plugin automatically applies these settings:

• git versioning setup (links sbt artifact versions to git describe output)
• integration tests (enables integration tests under it/)
• sets options for scalac compiler (to e.g. print specific warnings)
• configures scalafmt rules and enables sbt tasks for autoformatting
• configures and enables scalastyle
• sets configuration for unit tests

Usage

This plugin requires sbt 1.0.0+

Add this to project/plugins.sbt:

addSbtPlugin("ai.faculty" % "sbt-houserules" % "<plugin version>")

Scalafmt sbt tasks

To check that all main, test, integration test and SBT sources are correctly formatted, run:

sbt -batch scalafmtSbtCheck scalafmtCheckAll test

Note: scalafmtCheckAll checks formatting of all .scala sources (including test/ and it/). Checking .sbt files is done separately by scalafmtSbtCheck.

Testing

Run sbt scripted for sbt scripted tests.

FAQ

Do the rules apply to this project (itself)?

No. While it would be possible and nice to apply the same rules (e.g. formatting) to this project, I believe it might lead to confusion and make it more difficult to debug.