Skip to content

Files

Latest commit

hlissnerhlissner
revert: fix(docs): set mode in file-local vars
Aug 7, 2022
1abcf91 · Aug 7, 2022

History

History
130 lines (107 loc) · 4.51 KB

README.org

File metadata and controls

130 lines (107 loc) · 4.51 KB

: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

Maintainers

This module has no dedicated maintainers. Become a maintainer?

Module flags

+lsp
Enable LSP support for julia-mode. Requires :tools lsp and a langserver (supports LanguageServer.jl).
+tree-sitter
Leverages tree-sitter for better syntax highlighting and structural text editing. Requires :tools tree-sitter.

Packages

  • julia-mode
  • julia-repl
  • if +lsp
    • if :tools lsp
      • lsp-julia
      • lsp
    • if :tools lsp +eglot
      • eglot-jl
      • eglot

Hacks

No hacks documented for this module.

Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

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:

;; in $DOOMDIR/config.el
(setq lsp-julia-package-dir nil)

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

;; in $DOOMDIR/config.el
(after! lsp-julia
  (setq lsp-julia-default-environment "~/.julia/environments/v1.6"))

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.6 by default as it is the current LTS:

;; in $DOOMDIR/config.el
(setq eglot-jl-language-server-project "~/.julia/environments/v1.6")

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

;; in $DOOMDIR/config.el
(after! eglot-jl
  (setq eglot-jl-language-server-project eglot-jl-base))

Usage

🔨 This module’s usage documentation is incomplete. Complete it?

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

🔨 This module’s configuration documentation is incomplete. Complete it?

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.6 by default as it is the current LTS:

;; in $DOOMDIR/config.el
(after! lsp-julia
  (setq lsp-julia-default-environment "~/.julia/environments/v1.6"))

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

Appendix

🔨 This module has no appendix yet. Write one?