diff --git a/docs/_posts/2022-04-24-use-vim-as-a-scala-ide.md b/docs/_posts/2022-04-24-use-vim-as-a-scala-ide.md index 5c4077211..0ae7aae25 100644 --- a/docs/_posts/2022-04-24-use-vim-as-a-scala-ide.md +++ b/docs/_posts/2022-04-24-use-vim-as-a-scala-ide.md @@ -9,9 +9,36 @@ commentsID: "Use Vim as a Scala IDE" # [Blogs](../blog/) >> Use Vim as a Scala IDE -This is a general guide for using SpaceVim as a Scala IDE, including layer configuration and usage. +This is a general guide for using SpaceVim as a Scala IDE, including layer configuration and usage. Each of the following sections will be covered: + + +- [Setup Scala development environment](#setup-scala-development-environment) +- [Enable language layer](#enable-language-layer) +- [code completion](#code-completion) +- [alternate file jumping](#alternate-file-jumping) +- [code running](#code-running) +- [REPL support](#repl-support) +- [code format](#code-format) + + + +### Setup Scala development environment + +Make sure you have scala installed in your os. +If you are using windows, you can install scala and coursier via: + +``` +scoop install scala coursier +``` + +If you want to use `lsp` layer, you need to install the language server for scala: + +``` +coursier install metals +``` + ### Enable language layer `lang#scala` layer provides scala language specific features for SpaceVim. @@ -31,7 +58,6 @@ for more info, you can read the [lang#scala](../layers/lang/scala/) layer docume By default the autocomplete layer has been enabled, so after loading `lang#scala` layer, the code completion for scala language should work well. - ### alternate file jumping To manage the alternate file for a project, you may need to create a `.project_alt.json` file in the root of your @@ -41,20 +67,18 @@ for example, add following content into the `.project_alt.json` file: ```json { - "src/*.scala": {"alternate": "test/{}.scala"}, - "test/*.scala": {"alternate": "src/{}.scala"} + "src/*.scala": { "alternate": "test/{}.scala" }, + "test/*.scala": { "alternate": "src/{}.scala" } } ``` with this configuration, you can jump between the source code and test file via command `:A` - ### code running The key binding for running current file is `SPC l r `, it will run `sbt run` asynchronously. And the stdout will be shown on a runner buffer. - ### REPL support Start a `scala` inferior REPL process with `SPC l s i`. After REPL process started, @@ -66,12 +90,18 @@ you can send code to `scala` process via key bindings: | `SPC l s l` | send line and keep code buffer focused | | `SPC l s s` | send selection text and keep code buffer focused | - ### code format + The code formation feature is provided by `format` layer, and this layer is enabled by default. The default format engine is `neoformat`, it will run `scalafmt` or `scalariform` asynchronously on current file. -To use scalariform, you need to install [`scalariform`](https://github.com/scala-ide/scalariform). +To use `scalafmt`, you need to install it via: + +``` +coursier install scalafmt +``` + +If you want to use scalariform, you need to install [`scalariform`](https://github.com/scala-ide/scalariform). and set `scalariform_jar` option to the path of the scalariform jar.