A Scala compiler plugin that replaces the default
toString implementation of case classes with a more verbose one.
Without the plugin:
final case class User(name: String, age: Int) User("Joe", 18).toString() // "User(Joe, 18)"
With the plugin:
User("Joe", 18).toString() // "User(name = Joe, age = 18)"
libraryDependencies += compilerPlugin("org.polyvariant" % "better-tostring" % version cross CrossVersion.full)
(note: versions before
0.3.8 were published under the
com.kubukoz organization instead of
The plugin is currently published for the following Scala versions:
- 2.12.13, 2.12.14, 2.12.15
- 2.13.5, 2.13.6, 2.13.7, 2.13.8
- 3.0.0, 3.0.1, 3.0.2
- 3.1.0, 3.1.1-RC1, 3.1.1-RC2
As a rule of thumb, active support will include at least 3 latest stable versions of 2.12, 2.13 and 3.0 for the foreseeable future.
What does the plugin actually do?
- Only case classes located directly in
objects are changed. Nested classes and classes local to functions are currently ignored.
- Only the fields in the first parameter list are shown.
- If the class is nested in an object (but not a package object), the object's name and a dot are prepended.
- If the class already overrides
toStringdirectly, it's not replaced.
- Ignore classes that inherit
toStringfrom a type that isn't
- Potentially ignore value classes (#19)
If you have ideas for improving the plugin, feel free to create an issue and we'll consider making it happen :)
tl;dr there is none.
The plugin makes certain assumptions about what is a better
toString. We aim for a useful and reasonably verbose description of the data type,
which could make it easier to find certain issues with your tests (mismatching values in a field) or see the labels in debug logs.
We also want the plugin to become minimal in the implementation and easy to use (plug & play), without lots of configuration options, so the representation of the data types will not be customizable. The format may change over time without prior notice, so you shouldn't rely on the exact representation (as is the case with any
toString methods), but any changes in behavior will be communicated in the release notes.
If you need a different
toString, we suggest that you implement one yourself. You may also want to look at pprint.
If you want to add a new feature, check if it's already been discussed in the issues list.
Before you start working on an existing feature / bugfix, let us know you're taking it on in its comments :)
To add a new Scala version:
- Add it to
- Commit and open a pull request.
The maintainers of this project (people who can merge PRs and make releases) are:
This project supports the Scala code of conduct and wants communication on all its channels (GitHub etc.) to be inclusive environments.
If you have any concerns about someone's behavior on these channels, contact Jakub Kozłowski.