summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDan Loman <daniel.h.loman@gmail.com>2019-04-08 10:22:59 -0700
committerw0rp <w0rp@users.noreply.github.com>2019-04-08 18:22:59 +0100
commitabcefe7a6e2555db924d56e3d88f28cf5b6a55e8 (patch)
treea17036726828aedb50c1b1737b3b6887c8cf7ebd /doc
parent864d0861e47568ca5e69c9cba82af655730ae0d7 (diff)
downloadale-abcefe7a6e2555db924d56e3d88f28cf5b6a55e8.zip
[doc] Add swift support documentation (#2426)
* [doc] Add swift support documentation * [doc] Add swift bullets in main help file * [doc] Add to supported languages and tools txt file as well * Ensure same name styling for help/readme files
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-supported-languages-and-tools.txt1
-rw-r--r--doc/ale-swift.txt21
-rw-r--r--doc/ale.txt2
3 files changed, 24 insertions, 0 deletions
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index b3908289..3f329ba2 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -410,6 +410,7 @@ Notes:
* SugarSS
* `stylelint`
* Swift
+ * `sourcekit-lsp`
* `swiftformat`
* `swiftlint`
* Tcl
diff --git a/doc/ale-swift.txt b/doc/ale-swift.txt
new file mode 100644
index 00000000..8fa0c06c
--- /dev/null
+++ b/doc/ale-swift.txt
@@ -0,0 +1,21 @@
+===============================================================================
+ALE Swift Integration *ale-swift-options*
+
+
+===============================================================================
+sourcekitlsp *ale-swift-sourcekitlsp*
+
+To enable the SourceKit-LSP you need to install and build the executable as
+described here: https://github.com/apple/sourcekit-lsp#building-sourcekit-lsp
+
+
+g:ale_sourcekit_lsp_executable *g:ale_sourcekit_lsp_executable*
+ *b:ale_sourcekit_lsp_executable*
+ Type: |String|
+ Default: `'sourcekit-lsp'`
+
+ See |ale-integrations-local-executables|
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+
diff --git a/doc/ale.txt b/doc/ale.txt
index 25d30250..6155dc37 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2151,6 +2151,8 @@ documented in additional help files.
stylelint.............................|ale-stylus-stylelint|
sugarss.................................|ale-sugarss-options|
stylelint.............................|ale-sugarss-stylelint|
+ swift...................................|ale-swift-options|
+ sourcekitlsp..........................|ale-swift-sourcekitlsp|
tcl.....................................|ale-tcl-options|
nagelfar..............................|ale-tcl-nagelfar|
terraform...............................|ale-terraform-options|