This repository has been archived on 2024-07-19. You can view files and clone it, but cannot push or open issues or pull requests.
ale/doc/ale-scala.txt

95 lines
3.6 KiB
Text
Raw Normal View History

===============================================================================
ALE Scala Integration *ale-scala-options*
2018-08-27 05:12:56 +00:00
===============================================================================
sbtserver *ale-scala-sbtserver*
`sbtserver` requires a running ^1.1.x sbt shell to connect to. It will look
for this shell by searching upwards from the current working directory for
the `project/target/active.json` file. This will only work when `sbtserver` is
configured to listen via tcp. An easy way to accomplish that is to put
`serverConnectionType := ConnectionType.Tcp` in `~/.sbt/1.0/global.sbt`.
g:ale_scala_sbtserver_address *g:ale_scala_sbtserver_address*
*b:ale_scala_sbtserver_address*
Type: |String|
Default: `''`
By default the address is found by parsing `active.json`. If the server is
running elsewhere, you can override the address here to `host:port`.
g:ale_scala_sbtserver_project_root *g:ale_scala_sbtserver_project_root*
*b:ale_scala_sbtserver_project_root*
Type: |String|
Default: `''`
By default the project root is found by searching upwards for `active.json`.
If the project root is elsewhere, you can override the project root
directory.
===============================================================================
scalafmt *ale-scala-scalafmt*
If Nailgun is used, override `g:ale_scala_scalafmt_executable` like so: >
let g:ale_scala_scalafmt_executable = 'ng'
g:ale_scala_scalafmt_executable *g:ale_scala_scalafmt_executable*
*b:ale_scala_scalafmt_executable*
Type: |String|
Default: `'scalafmt'`
Override the invoked `scalafmt` binary. This is useful for running `scalafmt`
with Nailgun.
g:ale_scala_scalafmt_options *g:ale_scala_scalafmt_options*
*b:ale_scala_scalafmt_options*
Type: |String|
Default: `''`
A string containing additional options to pass to `'scalafmt'`, or
`'ng scalafmt'` if Nailgun is used.
===============================================================================
scalastyle *ale-scala-scalastyle*
`scalastyle` requires a configuration file for a project to run. When no
configuration file can be found, ALE will report a problem saying that a
configuration file is required at line 1.
To disable `scalastyle` globally, use |g:ale_linters| like so: >
let g:ale_linters = {'scala': ['scalac']} " Enable only scalac instead
<
See |g:ale_linters| for more information on disabling linters.
g:ale_scala_scalastyle_config *g:ale_scala_scalastyle_config*
*b:ale_scala_scalastyle_config*
Type: |String|
Default: `''`
A string containing the location of a global fallback configuration file.
By default, ALE will look for a configuration file named
`scalastyle_config.xml` or `scalastyle-config.xml` in the current file's
directory or parent directories.
g:ale_scala_scalastyle_options *g:ale_scala_scalastyle_options*
*b:ale_scala_scalastyle_options*
Type: |String|
Default: `''`
A string containing additional options to pass to scalastyle.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: