Merge commit '76265755a1add77121c8f9dabb3e9bb70fe9a972' as '.vim/bundle/ale'

[etc/vim.git] / .vim / bundle / ale / doc / ale-swift.txt

diff --git a/.vim/bundle/ale/doc/ale-swift.txt b/.vim/bundle/ale/doc/ale-swift.txt
new file mode 100644 (file)
index 0000000..d1b615c
--- /dev/null
+++ b/.vim/bundle/ale/doc/ale-swift.txt
@@ -0,0 +1,71 @@
+===============================================================================
+ALE Swift Integration                                       *ale-swift-options*
+
+
+===============================================================================
+apple-swift-format                               *ale-swift-apple-swift-format*
+
+There are 3 options to enable linting and fixing with Apple's swift-format:
+
+1. Install the local executable in your path, as described here:
+   https://github.com/apple/swift-format
+2. Install the executable via your OS package manager, for instance via
+   Homebrew with `brew install swift-format`
+3. Your Swift project has a dependency on the swift-format package, so it can
+   be run with `swift run swift-format lint ...` In this case, you need to set
+   a variable, see |g:ale_swift_appleswiftformat_use_swiftpm|.
+
+Additionally, ALE tries to locate and use the nearest existing `.swift-format`
+configuration file.
+
+                                *ale-options.swift_appleswiftformat_executable*
+                                      *g:ale_swift_appleswiftformat_executable*
+                                      *b:ale_swift_appleswiftformat_executable*
+swift_appleswiftformat_executable
+g:ale_swift_appleswiftformat_executable
+  Type: |String|
+  Default: `'swift-format'`
+
+  This variable can be modified to change the executable path for
+  `swift-format`.
+
+                               *ale-options.swift_appleswiftformat_use_swiftpm*
+                                     *g:ale_swift_appleswiftformat_use_swiftpm*
+                                     *b:ale_swift_appleswiftformat_use_swiftpm*
+swift_appleswiftformat_use_swiftpm
+g:ale_swift_appleswiftformat_use_swiftpm
+  Type: |Number|
+  Default: `0`
+
+  When set to `1`, this option will cause ALE to use
+  `swift run swift-format lint ...` instead of the global executable. Use this
+  option if your Swift project has a dependency on the swift-format package.
+
+  See |ale-integrations-local-executables|
+
+
+===============================================================================
+cspell                                                       *ale-swift-cspell*
+
+See |ale-cspell-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
+
+                                         *ale-options.sourcekit_lsp_executable*
+                                               *g:ale_sourcekit_lsp_executable*
+                                               *b:ale_sourcekit_lsp_executable*
+sourcekit_lsp_executable
+g: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: