doomemacs/modules/lang/julia
Han ba0f791b05
lang/julia: improve lsp support (#4012)
* lang/julia: include lsp-julia w/o language server

Use nonrecursive clone to get lsp-julia without bundled
LanguageServer.jl (plus dependencies) and include instructions in the
README on how to install the language server (bundled or otherwise).

* lang/julia: add checks for julia +lsp in doctor

Add two checks, both only for when the +lsp feature is enabled:
- Check if (:tools lsp) is selected
- Check if LanguageServer.jl is installed

* lang/julia: indicate SymbolServer.jl as dependency

It is itself a dependency of LanguageServer.jl, but it's necessary to
add it separately in order to do `using SymbolServer`.

* tools/lsp: add julia language server to list

* lang/julia: add eglot support using eglot-jl

Forcing eglot-jl to not install its own LanguageServer.jl is a bit of a
hack though.

* lang/julia: make timeout increase buffer-local

Suggestion by @benneti to use `setq-local` instead of `setq` to prevent
a timeout increase in non-Julia eglot buffers.

* Fix issues

Co-authored-by: Henrik Lissner <henrik@lissner.net>
2021-03-01 22:25:35 -05:00
..
autoload.el Run julia-repl-use-emacsclient after opening a REPL 2020-04-23 23:56:18 -04:00
config.el lang/julia: improve lsp support (#4012) 2021-03-01 22:25:35 -05:00
doctor.el lang/julia: improve lsp support (#4012) 2021-03-01 22:25:35 -05:00
packages.el lang/julia: improve lsp support (#4012) 2021-03-01 22:25:35 -05:00
README.org lang/julia: improve lsp support (#4012) 2021-03-01 22:25:35 -05:00

lang/julia

Description

This module adds support for the Julia language to Doom Emacs.

  • Syntax highlighting and latex symbols from julia-mode
  • REPL integration from julia-repl
  • Code completion and syntax checking, requires :tools lsp and +lsp

Module Flags

  • +lsp Enable LSP server support.

Plugins

Prerequisites

This module requires julia and an language server if +lsp is enabled.

Language Server

+lsp requires LanguageServer.jl and SymbolServer.jl. The lsp-julia and eglot-jl packages both come bundled with their own versions of these servers, which is used by default. If you're happy with that, no further configuration is necessary.

However, to use your own installation you will need to install then configure them. To install them, execute these commands in a Julia REPL:

using Pkg
Pkg.add("LanguageServer")
Pkg.add("SymbolServer")

Then configure lsp-julia or eglot-jl depending on whether you have enabled :tools lsp or :tools (lsp +eglot), respectively:

lsp-julia

To instruct lsp-julia not to use the built-in package:

;; ~/.doom.d/config.el
(setq lsp-julia-package-dir nil)

To find your installation of LanguageServer.jl, eglot-jl needs to know the environment in which it is installed. This is set to v1.0 by default as it is the current LTS:

(setq lsp-julia-default-environment "~/.julia/environments/v1.0")

eglot-jl

To find your installation of LanguageServer.jl, eglot-jl must know the environment in which it is installed. This is set to v1.0 by default as it is the current LTS:

;; ~/.doom.d/config.el
(setq eglot-jl-language-server-project "~/.julia/environments/v1.0")

But to let eglot-jl use the environment bundled with it, set it to eglot-jl-base instead:

;; ~/.doom.d/config.el
(after! eglot-jl
  (setq eglot-jl-language-server-project eglot-jl-base))

Features

Language Server

+lsp adds code completion, syntax checking, formatting and other lsp-mode or eglot features. It requires LanguageServer.jl, the installation of which is described above.

Configuration

Change the default environment for the Julia language server

lsp-julia requires a variable be set for the Julia environment. This is set to v1.0 by default as it is the current LTS.

;; ~/.doom.d/config.el
(setq lsp-julia-default-environment "~/.julia/environments/v1.0")