summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJeffrey Lau <who.else.at.jlau.tk>2018-06-03 02:59:53 +0800
committerJeffrey Lau <who.else.at.jlau.tk>2018-06-03 04:40:52 +0800
commit77d0ac58ed3171c0753f8e9cf7fa56db51d88f11 (patch)
tree1e712b1baffeea0d87e1fc5b4b5a4c167327f808 /doc
parent786fc0a62f2d45b88967aad6d59bb9c483a576ae (diff)
downloadale-77d0ac58ed3171c0753f8e9cf7fa56db51d88f11.zip
Add 'scalafmt' fixer for Scala files
closes https://github.com/w0rp/ale/issues/1299
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-scala.txt31
-rw-r--r--doc/ale.txt3
2 files changed, 33 insertions, 1 deletions
diff --git a/doc/ale-scala.txt b/doc/ale-scala.txt
index 9c9472f6..15add7db 100644
--- a/doc/ale-scala.txt
+++ b/doc/ale-scala.txt
@@ -3,6 +3,37 @@ ALE Scala Integration *ale-scala-options*
===============================================================================
+scalafmt *ale-scala-scalafmt*
+
+If Nailgun is used, override `g:ale_scala_scalafmt_executable` like so: >
+ let g:ale_scala_scalafmt_executable = 'ng'
+
+To disable `scalafmt` globally, use |g:ale_fixers| like so: >
+ let g:ale_fixers = {'scala': []}
+<
+
+See |g:ale_fixers| for more information on disabling fixers.
+
+
+g:ale_scala_scalafmt_executable *g:ale_scala_scalafmt_executable*
+ *b:ale_scala_scalafmt_executable*
+ Type: |String|
+ Default: `'scalafmt'`
+
+ Override the invoked `scalafmt` binary. This is useful for running `scalafmt`
+ with Nailgun.
+
+
+g:ale_scala_scalafmt_options *g:ale_scala_scalafmt_options*
+ *b:ale_scala_scalafmt_options*
+ Type: |String|
+ Default: `''`
+
+ A string containing additional options to pass to `'scalafmt'`, or
+ `'ng scalafmt'` if Nailgun is used.
+
+
+===============================================================================
scalastyle *ale-scala-scalastyle*
`scalastyle` requires a configuration file for a project to run. When no
diff --git a/doc/ale.txt b/doc/ale.txt
index 2b4452d9..2d7a5935 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -218,6 +218,7 @@ CONTENTS *ale-contents*
sass..................................|ale-sass-options|
stylelint...........................|ale-sass-stylelint|
scala.................................|ale-scala-options|
+ scalafmt............................|ale-scala-scalafmt|
scalastyle..........................|ale-scala-scalastyle|
scss..................................|ale-scss-options|
prettier............................|ale-scss-prettier|
@@ -388,7 +389,7 @@ Notes:
* Rust: `cargo`!!, `rls`, `rustc` (see |ale-integration-rust|), `rustfmt`
* SASS: `sass-lint`, `stylelint`
* SCSS: `prettier`, `sass-lint`, `scss-lint`, `stylelint`
-* Scala: `fsc`, `scalac`, `scalastyle`
+* Scala: `fsc`, `scalac`, `scalafmt`, `scalastyle`
* Slim: `slim-lint`
* SML: `smlnj`
* Solidity: `solhint`, `solium`