Community Plugins

The GitHub sbt Organization

The sbt organization is available for use by any sbt plugin. Developers who contribute their plugins into the community organization will still retain control over their repository and its access. The goal of the sbt organization is to organize sbt software into one central location.

A side benefit to using the sbt organization for projects is that you can use gh-pages to host websites under the https://www.scala-sbt.org domain.

The sbt autoplugin giter8 template is a good place to start. This sets up a new sbt plugin project appropriately. The generated README includes a summary of the steps for publishing a new community plugin.

Plugins available for sbt 2.x

[Edit] this page to submit a pull request that adds your plugin to the list.

### Code formatter plugins

One jar plugins

Verification plugins

Language support plugins

  • sbt-frege: build Frege code with sbt.
  • sbt-cc: compile C and C++ source files with sbt.

Release plugins

Deployment integration plugins

  • sbt-heroku: deploy applications directly to Heroku.
  • sbt-docker-compose: launch Docker images using docker compose.
  • sbt-appengine deploy your webapp to Google App Engine.
  • sbt-marathon: deploy applications on Apache Mesos using the Marathon framework.
  • sbt-riotctl: deploy applications as systemd services directly to a Raspberry Pi, ensuring dependencies (e.g. wiringpi) are met.
  • sbt-kind: load built docker images into a kind cluster.

IDE integration plugins

  • sbt-structure: extract project structure in XML for IntelliJ Scala plugin.

Test plugins

  • scripted: integration testing for sbt plugins.
  • sbt-jmh: run Java Microbenchmark Harness (JMH) benchmarks from sbt.
  • gatling-sbt: performance and load-testing using Gatling.
  • sbt-multi-jvm: run tests using multiple JVMs.
  • sbt-scalaprops: scalaprops property-based testing integration.
  • sbt-testng: TestNG framework integration.
  • sbt-jcstress: Java Concurrency Stress Test (jcstress) integration.
  • sbt-cached-ci: Incremental sbt builds for CI environments.

Library dependency plugins

Web and frontend development plugins

  • sbt-war: package and run WAR files
  • sbt-web: library for building sbt plugins for the web.

Database plugins

Code generator plugins

  • sbt-scalaxb: generate model classes from XML schemas and WSDL.

  • sbt-header: auto-generate source code file headers (such as copyright notices).

  • sbt-boilerplate: TupleX and FunctionX boilerplate code generator.

  • sbt-avro: Apache Avro schema and protocol generator.

  • sbt-aspectj: AspectJ weaving for sbt.

  • sbt-protoc: protobuf code generator using protoc.

  • sbt-contraband (docs): generate pseudo-case classes from GraphQL schemas.

  • sbt-antlr4: run ANTLR v4 from sbt.

  • sbt-sql: generate model classes from SQL.

  • sbt-partial-unification: enable partial unification support in Scala (SI-2712).

  • sbt-i18n: transform your i18n bundles into Scala code.

  • sbt-lit: build literate code with sbt.

  • sbt-embedded-files: generate Scala objects containing the contents of glob-specified files as strings or byte-arrays.

  • sbt-scala-ts: generate TypeScript code according compiled Scala types (case class, trait, object, ...).

Static code analysis plugins

Utility and system plugins

- [sbt-revolver](https://github.com/spray/sbt-revolver): auto-restart forked JVMs on update. - [sbt-conscript](https://github.com/foundweekends/conscript) ([docs](https://www.foundweekends.org/conscript/)): distribute apps using GitHub and Maven Central. - [sbt-errors-summary](https://github.com/Duhemm/sbt-errors-summary): show a summary of compilation errors. - [MiMa](https://github.com/lightbend/mima): binary compatibility management for Scala libraries. - [sbt-groll](https://github.com/sbt/sbt-groll): navigate git history inside sbt. - [sbt-prompt](https://github.com/agemooij/sbt-prompt): add promptlets and themes to your sbt prompt. - [sbt-crossproject](https://github.com/portable-scala/sbt-crossproject): cross-build Scala, Scala.js and Scala Native. - [sbt-proguard](https://github.com/sbt/sbt-proguard): run ProGuard on compiled sources. - [sbt-jni](https://github.com/sbt/sbt-jni): helpers for working with projects that use JNI. - [sbt-jol](https://github.com/ktoso/sbt-jol): inspect OpenJDK Java Object Layout from sbt. - [sbt-musical](https://github.com/tototoshi/sbt-musical): control iTunes from sbt (Mac only). - [sbt-travisci](https://github.com/dwijnand/sbt-travisci): integration with Travis CI. - [horder](https://github.com/romanowski/hoarder): cache compilation artefacts for future builds. - [sbt-javaagent](https://github.com/sbt/sbt-javaagent): add Java agents to projects.

Documentation plugins

  • tut: documentation and tutorial generator.

  • Laika: Transform Markdown or reStructuredText into HTML or PDF with Templating.

  • sbt-site: site generator.

  • sbt-microsites: generate and publish microsites using Jekyll.

  • sbt-ghpages: publish generated sites to GitHub pages.

  • sbt-api-mappings: generate Scaladoc apiMappings for common Scala libraries.

  • literator: generate literate-style markdown docs from your sources.

  • sbt-example: generate ScalaTest test suites from examples in Scaladoc.

  • sbt-delombok: delombok Java sources files that contain Lombok annotations to make Javadoc contain Lombok-generated classes and methods.

  • sbt-alldocs: collect all the docs for a project and dependencies into a single folder.

  • sbt-apidoc: A port of apidocjs to sbt, to document REST Api.

  • sbt-github-pages (docs): publish a website to GitHub Pages with minimal effort - works well with GitHub Actions.

  • sbt-docusaur (docs): build a website using Docusaurus and publish to GitHub Pages with minimal effort - works well with GitHub Actions.

  • sbt-hl-compiler: compile the code snippets from documentation (to keep it consistent).

  • sbt-scaladoc-compiler: compile the code snippets included in Scaladoc comments.

### Code coverage plugins

Create new project plugins

  • sbt-fresh: create an opinionated fresh sbt project.

Framework-specific plugins

  • sbt-newrelic: NewRelic support for artefacts built with sbt-native-packager.
  • sbt-spark: Spark application configurator.
  • sbt-api-builder: support for ApiBuilder from within sbt's shell.