Getting Started

sbt-config is an sbt plugin that allows you to configure your Scala projects using HOCON configuration files instead of build.sbt.

Currently, sbt-config is designed for single-module projects. Support for multi-module builds (defining distinct sub-projects and dependencies within a single `build.conf`) is not yet supported, but is planned for a future release.

Installation

Add the plugin to your project/plugins.sbt:

addSbtPlugin("io.github.matejcerny" % "sbt-config" % "0.5.0")

Quick Start

After adding the plugin, run any sbt command (e.g., sbt compile). The plugin will automatically create a build.conf template file with all supported fields commented out.

Edit build.conf to configure your project:

name = "my-project"
organization = "com.example"
version = "0.1.0-SNAPSHOT"

scalaVersion = "3.3.4"

scalacOptions = [
  "-deprecation",
  "-feature",
  "-unchecked"
]

dependencies = [
  "org.typelevel:cats-core:2.13.0",
  "io.circe:circe-core:0.14.10"
]

testDependencies = [
  "org.scalatest:scalatest:3.2.19"
]

Your build.sbt can be minimal or even empty - all settings come from build.conf.

Features

Project metadata - Configure name, organization, and version
Scala settings - Set Scala version and compiler options
Dependencies - Declare dependencies in a simple organization:artifact:version format
Cross-versioning - Automatic handling of Scala cross-version dependencies
Publishing - Configure homepage, licenses, and developers for Maven Central (requires sbt-ci-release)
Template generation - Creates a commented build.conf template if one doesn't exist
sbt 1.x and 2.x - Cross-built to support both sbt generations

In this article

Generated with