path: root/examples/scalafmt-example/README.md

This example shows integration with scalafmt plugin.

Reformat executed on every `cbt compile` call, and affects only *.scala source files.

You can provide your custom scalfmt preferences in build via `scalafmtConfig`.

To see formatting in action: execute `cbt breakFormatting` to break formatting and then execute`cbt scalafmt` to get formatting back.

To check if your code is properly formatted(for example as part of CI validation), you can execute:

```
cbt scalafmt
git diff --exit-code
```

Last command will return non-zero code, if your code isn't properly formatted.