thoughtworksinc / sbt-example

Run Scaladoc as unit tests

GitHub

sbt-example

Build Status

sbt-example is an sbt plug-in for creating unit tests from examples in Scaladoc.

  • Documentation - sbt-example eats its own dog food. The tests of sbt-example is generated by sbt-example itself from Scaladoc, which is also the documentation for using sbt-example.

The previous version of this project is the macro annotation @example, which is deprecated and does not support Scala 2.12.5+ version.

Showcases

  • AsynchronousPool - an asynchronous resource pool, whose Scaladoc contains tests written in ScalaTest and ScalaMock
  • Factory - a dependent-type type class for dependency injection, whose Scaladoc contains a huge number of small usecases.
  • PartialApply - a dependent-type type class for partial applying a function, whose Scaladoc is written in Given-When-Then style.

(Feel free to add your Scaladoc here)

Requirements

  • Sbt 1.x

Documentation

addSbtPlugin("com.thoughtworks.example" % "sbt-example" % "6.0.0")
Ammonite REPL 
import $ivy.`com.thoughtworks.example::sbt-example:6.0.0`
<dependency>
  <groupId>com.thoughtworks.example</groupId>
  <artifactId>sbt-example</artifactId>
  <version>6.0.0</version>
</dependency>
compile group: 'com.thoughtworks.example', name: 'sbt-example', version: '6.0.0'
Try online with Scastie
Try on Scastie

Statistics

Contributors

License

6 Dependencies

Java Dependency