diff options
| author | Dan Loman <daniel.h.loman@gmail.com> | 2019-04-08 10:22:59 -0700 |
|---|---|---|
| committer | w0rp <w0rp@users.noreply.github.com> | 2019-04-08 18:22:59 +0100 |
| commit | abcefe7a6e2555db924d56e3d88f28cf5b6a55e8 (patch) | |
| tree | a17036726828aedb50c1b1737b3b6887c8cf7ebd | |
| parent | 864d0861e47568ca5e69c9cba82af655730ae0d7 (diff) | |
| download | ale-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
| -rw-r--r-- | doc/ale-supported-languages-and-tools.txt | 1 | ||||
| -rw-r--r-- | doc/ale-swift.txt | 21 | ||||
| -rw-r--r-- | doc/ale.txt | 2 | ||||
| -rw-r--r-- | supported-tools.md | 1 |
4 files changed, 25 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| diff --git a/supported-tools.md b/supported-tools.md index d2010e03..532fc1f8 100644 --- a/supported-tools.md +++ b/supported-tools.md @@ -419,6 +419,7 @@ formatting. * SugarSS * [stylelint](https://github.com/stylelint/stylelint) * Swift + * [sourcekit-lsp](https://github.com/apple/sourcekit-lsp) * [swiftformat](https://github.com/nicklockwood/SwiftFormat) * [swiftlint](https://github.com/realm/SwiftLint) * Tcl |