From 8e3bf10592b52ba96ce94c5819a19ee8de6f0899 Mon Sep 17 00:00:00 2001
From: Ty Coghlan <Coghlan.Ty@gmail.com>
Date: Mon, 27 Aug 2018 01:12:56 -0400
Subject: added sbtserver linter

---
 doc/ale-scala.txt | 29 +++++++++++++++++++++++++++++
 doc/ale.txt       |  3 ++-
 2 files changed, 31 insertions(+), 1 deletion(-)

(limited to 'doc')

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
@@ -2,6 +2,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*
 
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`
-- 
cgit v1.2.3