diff options
author | Nikolay Tatarinov <5min4eq.unity@gmail.com> | 2016-06-24 02:48:45 +0300 |
---|---|---|
committer | Jan Christopher Vogt <oss.nsp@cvogt.org> | 2016-06-23 19:48:45 -0400 |
commit | 2cbc42fd0809b60b1ee2116657d18b3f44f8aef1 (patch) | |
tree | e894a040137e591c4a7664b7353d709298a44f65 /examples/scalafmt-example/README.md | |
parent | 75c32537cd8f29f9d12db37bf06ad942806f0239 (diff) | |
download | cbt-2cbc42fd0809b60b1ee2116657d18b3f44f8aef1.tar.gz cbt-2cbc42fd0809b60b1ee2116657d18b3f44f8aef1.tar.bz2 cbt-2cbc42fd0809b60b1ee2116657d18b3f44f8aef1.zip |
Scalafmt plugin implementation (#156)
* scalariform: improve logging, declare tasks final
* scalafmt plugin implementation
* add scalafmt and scalariform plugins and examples to tests
* fix logging guarded logging behaviour
* add notes about formatting check to README
* fix compilation error in examples
Diffstat (limited to 'examples/scalafmt-example/README.md')
-rw-r--r-- | examples/scalafmt-example/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/examples/scalafmt-example/README.md b/examples/scalafmt-example/README.md new file mode 100644 index 0000000..0a59f96 --- /dev/null +++ b/examples/scalafmt-example/README.md @@ -0,0 +1,16 @@ +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. |