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

   1 ===============================================================================
   2 ALE Scala Integration                                       *ale-scala-options*
   3
   4
   5 ===============================================================================
   6 cspell                                                       *ale-scala-cspell*
   7
   8 See |ale-cspell-options|
   9
  10
  11 ===============================================================================
  12 metals                                                       *ale-scala-metals*
  13
  14 `metals` requires either an SBT project, a Mill project, or a running Bloop
  15 server.
  16
  17                                           *ale-options.scala_metals_executable*
  18                                                 *g:ale_scala_metals_executable*
  19                                                  *b:ale_scala_metals_executable*
  20 scala_metals_executable
  21 g:ale_scala_metals_executable
  22   Type: |String|
  23   Default: `'metals-vim'`
  24
  25   Override the invoked `metals` binary.
  26
  27                                         *ale-options.scala_metals_project_root*
  28                                               *g:ale_scala_metals_project_root*
  29                                                *b:ale_scala_metals_project_root*
  30 scala_metals_project_root
  31 g:ale_scala_metals_project_root
  32   Type: |String|
  33   Default: `''`
  34
  35   By default the project root is found by searching upwards for `build.sbt`,
  36   `build.sc`, `.bloop` or `.metals`. If the project root is elsewhere, you
  37   can override the project root directory.
  38
  39
  40 ===============================================================================
  41 sbtserver                                                 *ale-scala-sbtserver*
  42
  43 `sbtserver` requires a running ^1.1.x sbt shell to connect to. It will attempt
  44 to connect via TCP to the address defined in `g:ale_scala_sbtserver_address`.
  45 As `sbt` defaults to listening via unix sockets, place these settings into
  46 your `~/.sbt/1.0/global.sbt` to ensure that ale will always attempt to connect
  47 to the right socket:
  48
  49 `serverConnectionType := ConnectionType.Tcp` and `serverPort := 4273`
  50
  51                                           *ale-options.scala_sbtserver_address*
  52                                                 *g:ale_scala_sbtserver_address*
  53                                                 *b:ale_scala_sbtserver_address*
  54 scala_sbtserver_address
  55 g:ale_scala_sbtserver_address
  56   Type: |String|
  57   Default: `'127.0.0.1:4273'`
  58
  59   By default the address is found by parsing `active.json`, however, reading a
  60   file is a blocking operation which should be avoided in ale. The easy way
  61   around this is to configure sbt to always connect to the same port, which
  62   the instructions above describe.
  63
  64                                      *ale-options.scala_sbtserver_project_root*
  65                                            *g:ale_scala_sbtserver_project_root*
  66                                            *b:ale_scala_sbtserver_project_root*
  67 scala_sbtserver_project_root
  68 g:ale_scala_sbtserver_project_root
  69   Type: |String|
  70   Default: `''`
  71
  72   By default the project root is found by searching upwards for `build.sbt`.
  73   If the project root is elsewhere, you can override the project root
  74   directory.
  75
  76
  77 ===============================================================================
  78 scalafmt                                                   *ale-scala-scalafmt*
  79
  80 If Nailgun is used, override `g:ale_scala_scalafmt_executable` like so: >
  81
  82   let g:ale_scala_scalafmt_executable = 'ng'
  83 <
  84                                         *ale-options.scala_scalafmt_executable*
  85                                               *g:ale_scala_scalafmt_executable*
  86                                               *b:ale_scala_scalafmt_executable*
  87 scala_scalafmt_executable
  88 g:ale_scala_scalafmt_executable
  89   Type: |String|
  90   Default: `'scalafmt'`
  91
  92   Override the invoked `scalafmt` binary. This is useful for running `scalafmt`
  93   with Nailgun.
  94
  95                                            *ale-options.scala_scalafmt_options*
  96                                                  *g:ale_scala_scalafmt_options*
  97                                                  *b:ale_scala_scalafmt_options*
  98 scala_scalafmt_options
  99 g:ale_scala_scalafmt_options
 100   Type: |String|
 101   Default: `''`
 102
 103   A string containing additional options to pass to `'scalafmt'`, or
 104   `'ng scalafmt'` if Nailgun is used.
 105
 106
 107 ===============================================================================
 108 scalastyle                                               *ale-scala-scalastyle*
 109
 110 `scalastyle` requires a configuration file for a project to run. When no
 111 configuration file can be found, ALE will report a problem saying that a
 112 configuration file is required at line 1.
 113
 114 To disable `scalastyle` globally, use |g:ale_linters| like so: >
 115
 116   let g:ale_linters = {'scala': ['scalac']} " Enable only scalac instead
 117 <
 118 See |g:ale_linters| for more information on disabling linters.
 119
 120                                           *ale-options.scala_scalastyle_config*
 121                                                 *g:ale_scala_scalastyle_config*
 122                                                 *b:ale_scala_scalastyle_config*
 123 scala_scalastyle_config
 124 g:ale_scala_scalastyle_config
 125   Type: |String|
 126   Default: `''`
 127
 128   A string containing the location of a global fallback configuration file.
 129
 130   By default, ALE will look for a configuration file named
 131   `scalastyle_config.xml` or `scalastyle-config.xml` in the current file's
 132   directory or parent directories.
 133
 134                                          *ale-options.scala_scalastyle_options*
 135                                                *g:ale_scala_scalastyle_options*
 136                                                *b:ale_scala_scalastyle_options*
 137 scala_scalastyle_options
 138 g:ale_scala_scalastyle_options
 139   Type: |String|
 140   Default: `''`
 141
 142   A string containing additional options to pass to scalastyle.
 143
 144
 145 ===============================================================================
 146   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: