Soundness is an ecosystem of libraries for writing direct-style code with Scala 3, in a number of broad domains:

• cli, for building commandline applications
• data, for working with data in various forms
• sci, for scientific and mathematical operations
• test, for testing
• tool, for building developer tools
• web, for developing web applications

The Soundness website includes more details about developing software using Soundness, and should be the primary source of documentation about Soundness for users.

Using Soundness

Soundness is composed of over one hundred modules. Each module has its own unique name and purpose, and may be used alone (with its dependencies) or in combination with other modules in the ecosystem. Most modules have a core component, but many have additional components for optional functionality. Modules are distributed in bundles, one for each of the domains above.

Binary dependencies

Releases are published on Maven Central as bundles, each of which packages the modules for one domain, and can be specified as follows:

• To include a bundle of modules, use dev.propensive:soundness-<bundle>:<version> where <bundle> is one of:

  • base, the core abstractions every other bundle builds on
  • cli, data, sci, test, tool or web, for the domains above
  • wasi, the WASI backends for the platform-abstraction modules
  • staged, the expansion-time variants of the data-format modules
  • android, the Android dexing and packaging stages

  for example, dev.propensive:soundness-sci:0.65.0. A bundle depends on the other bundles it needs, so soundness-sci brings in soundness-base automatically.

• To include everything in Soundness, use dev.propensive:soundness:<version>. This covers every bundle except the two opt-in ones, staged and android, whose dependencies (the staging compiler and R8) are heavyweight enough that they should only ever be asked for by name.

• The compiler plugins are published separately, since they are used with -Xplugin: rather than on the classpath: dev.propensive:larceny-plugin, dev.propensive:umbrageous-plugin and dev.propensive:beneficence-plugin.

Individual modules do not have coordinates of their own: Maven Central limits how many files a single deployment may contain, and Soundness has too many modules to publish each one separately.

Version numbers are synchronized across all bundles, and the latest release version is shown at the top of this page. Binary compatibility is not guaranteed between modules with different version numbers.

Releases

New versions of Soundness are usually released weekly.

Building Soundness

Soundness is currently built using Mill, with GNU Make providing some convenient shortcuts.

• make test will compile everything and run the full test suite with fume
• make test.<module> will compile and run the tests for the module <module>
• make dev will compile all source files continuously, watching for changes
• make publishLocal will publish a version of Soundness locally

Requirements

Soundness requires Scala 3.7. Java 17 should be assumed as a minimum requirement for most modules, however Mandible (which uses the new classfile API) requires Java 24 or later.