diff options
| author | Ty Coghlan <Coghlan.Ty@gmail.com> | 2018-08-27 01:12:56 -0400 |
|---|---|---|
| committer | Ty Coghlan <Coghlan.Ty@gmail.com> | 2018-08-30 22:10:38 -0400 |
| commit | 8e3bf10592b52ba96ce94c5819a19ee8de6f0899 (patch) | |
| tree | 86f17f793726520f886211466c18fd53fb3182d7 /doc | |
| parent | ea01cc708b4beed3831a10065664c84dba68b5dc (diff) | |
| download | ale-8e3bf10592b52ba96ce94c5819a19ee8de6f0899.zip | |
added sbtserver linter
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-scala.txt | 29 | ||||
| -rw-r--r-- | doc/ale.txt | 3 |
2 files changed, 31 insertions, 1 deletions
diff --git a/doc/ale-scala.txt b/doc/ale-scala.txt index b992d428..a50f6267 100644 --- a/doc/ale-scala.txt +++ b/doc/ale-scala.txt @@ -3,6 +3,35 @@ ALE Scala Integration *ale-scala-options* =============================================================================== +sbtserver *ale-scala-sbtserver* + +`sbtserver` requires a running ^1.1.x sbt shell to connect to. It will look +for this shell by searching upwards from the current working directory for +the `project/target/active.json` file. This will only work when `sbtserver` is +configured to listen via tcp. An easy way to accomplish that is to put +`serverConnectionType := ConnectionType.Tcp` in `~/.sbt/1.0/global.sbt`. + + +g:ale_scala_sbtserver_address *g:ale_scala_sbtserver_address* + *b:ale_scala_sbtserver_address* + Type: |String| + Default: `''` + + By default the address is found by parsing `active.json`. If the server is + running elsewhere, you can override the address here to `host:port`. + + +g:ale_scala_sbtserver_project_root *g:ale_scala_sbtserver_project_root* + *b:ale_scala_sbtserver_project_root* + Type: |String| + Default: `''` + + By default the project root is found by searching upwards for `active.json`. + If the project root is elsewhere, you can override the project root + directory. + + +=============================================================================== scalafmt *ale-scala-scalafmt* If Nailgun is used, override `g:ale_scala_scalafmt_executable` like so: > diff --git a/doc/ale.txt b/doc/ale.txt index 2c018a10..4334510f 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -249,6 +249,7 @@ CONTENTS *ale-contents* sass..................................|ale-sass-options| stylelint...........................|ale-sass-stylelint| scala.................................|ale-scala-options| + sbtserver...........................|ale-scala-sbtserver| scalafmt............................|ale-scala-scalafmt| scalastyle..........................|ale-scala-scalastyle| scss..................................|ale-scss-options| @@ -430,7 +431,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`, `scalafmt`, `scalastyle` +* Scala: `fsc`, `sbtserver`, `scalac`, `scalafmt`, `scalastyle` * Slim: `slim-lint` * SML: `smlnj` * Solidity: `solhint`, `solium` |