diff options
Diffstat (limited to 'examples/scalariform-example/README.md')
| -rw-r--r-- | examples/scalariform-example/README.md | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/examples/scalariform-example/README.md b/examples/scalariform-example/README.md index e599b5b..28ad226 100644 --- a/examples/scalariform-example/README.md +++ b/examples/scalariform-example/README.md @@ -1,5 +1,16 @@ This example shows integration with scalariform plugin. + Reformat executed on every `cbt compile` call, and affects only *.scala source files. + You can provide your custom scalariform preferences in build via `scalariformPreferences`. -To test formatting in action you can execute: `cbt breakFormatting` to break formatting -and `cbt scalariformReformat` to get formatting back. + +To see formatting in action: execute `cbt breakFormatting` to break formatting and then execute `cbt scalariformFormat` to get formatting back. + +To check if your code is properly formatted(for example as part of CI validation), you can execute: + +``` +cbt scalariformFormat +git diff --exit-code +``` + +Last command will return non-zero code, if your code isn't properly formatted. |