.vim/bundle/ale/doc/ale-swift.txt

   1 ===============================================================================
   2 ALE Swift Integration                                       *ale-swift-options*
   3
   4
   5 ===============================================================================
   6 apple-swift-format                               *ale-swift-apple-swift-format*
   7
   8 There are 3 options to enable linting and fixing with Apple's swift-format:
   9
  10 1. Install the local executable in your path, as described here:
  11    https://github.com/apple/swift-format
  12 2. Install the executable via your OS package manager, for instance via
  13    Homebrew with `brew install swift-format`
  14 3. Your Swift project has a dependency on the swift-format package, so it can
  15    be run with `swift run swift-format lint ...` In this case, you need to set
  16    a variable, see |g:ale_swift_appleswiftformat_use_swiftpm|.
  17
  18 Additionally, ALE tries to locate and use the nearest existing `.swift-format`
  19 configuration file.
  20
  21                                 *ale-options.swift_appleswiftformat_executable*
  22                                       *g:ale_swift_appleswiftformat_executable*
  23                                       *b:ale_swift_appleswiftformat_executable*
  24 swift_appleswiftformat_executable
  25 g:ale_swift_appleswiftformat_executable
  26   Type: |String|
  27   Default: `'swift-format'`
  28
  29   This variable can be modified to change the executable path for
  30   `swift-format`.
  31
  32                                *ale-options.swift_appleswiftformat_use_swiftpm*
  33                                      *g:ale_swift_appleswiftformat_use_swiftpm*
  34                                      *b:ale_swift_appleswiftformat_use_swiftpm*
  35 swift_appleswiftformat_use_swiftpm
  36 g:ale_swift_appleswiftformat_use_swiftpm
  37   Type: |Number|
  38   Default: `0`
  39
  40   When set to `1`, this option will cause ALE to use
  41   `swift run swift-format lint ...` instead of the global executable. Use this
  42   option if your Swift project has a dependency on the swift-format package.
  43
  44   See |ale-integrations-local-executables|
  45
  46
  47 ===============================================================================
  48 cspell                                                       *ale-swift-cspell*
  49
  50 See |ale-cspell-options|
  51
  52
  53 ===============================================================================
  54 sourcekitlsp                                           *ale-swift-sourcekitlsp*
  55
  56 To enable the SourceKit-LSP you need to install and build the executable as
  57 described here: https://github.com/apple/sourcekit-lsp#building-sourcekit-lsp
  58
  59                                          *ale-options.sourcekit_lsp_executable*
  60                                                *g:ale_sourcekit_lsp_executable*
  61                                                *b:ale_sourcekit_lsp_executable*
  62 sourcekit_lsp_executable
  63 g:ale_sourcekit_lsp_executable
  64   Type: |String|
  65   Default: `'sourcekit-lsp'`
  66
  67   See |ale-integrations-local-executables|
  68
  69
  70 ===============================================================================
  71   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: