sbt-scalafmt docs: describe error handling params

scalameta · Dec 3, 2021 · d959d25 · d959d25
1 parent f0e94d5
commit d959d25
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/installation.md b/docs/installation.md
@@ -159,6 +159,11 @@ The latest version will be used by default.
   - otherwise if `project.git = true` (`.scalafmt.conf`): only files
     tracked by git (`git ls-tree`)
   - otherwise, no restrictions
+- [since v2.4.3] `scalafmtDetailedError`: if set, when handling a specific error
+  (whether logging or throwing an exception), include the stacktrace as well
+- [since v2.4.5] `scalafmtLogOnEachError`: if set, plugin will log errors
+- [since v2.4.5] `scalafmtFailOnErrors`: if set, plugin will fail on errors
+  - depending on `scalafmtLogOnEachError`, fail on the first error or only at the end
 
 ### Enable IntegrationTest