LSP-julia

A plugin for the LSP client in Sublime Text with support for the Julia language server.

Requirements & Installation

• Julia must be installed on your machine. If the julia executable is not in your PATH, you need to provide the full path to the executable in the LSP-julia package settings.
• The Julia package from Package Control should be installed for syntax highlighting and allows the language server to start for Julia source files.
• Install the LSP package and LSP-julia from Package Control. When a Julia file is opened for the first time after installing this package, the language server will automatically be installed via the Julia package manager (this can take 1-2 minutes).
• Optionally install the Terminus package from Package Control for a simple Julia REPL integration and some functionality to run code (see below).

Features

Most of the standard LSP features like auto-completion, documentation on hover, or goto definition are supported by the Julia language server. Some features like diagnostics require that a folder was opened in Sublime Text, and will not work in single file mode.

LSP-julia provides additional commands which are available from the command palette:

Commands marked with a ¹ are only available if you have the Terminus package installed.

To add or adjust key bindings for the commands, edit the .sublime-keymap file for your OS in your Packages/User folder. For an example refer to the Default.sublime-keymap file in this repository, and for the command names from this package see LSP-julia.sublime-commands.

Run individual test items

LSP-julia has a custom feature, similar to the Julia extension for VS Code, which allows to run individual testsets from a Julia package directly from the editor UI.

For this to work, the tests must be contained within a @testitem block, which is basically a replacement for @testset. For an example see the screenshot below or read the detailed description at https://github.com/julia-vscode/TestItemRunner.jl#writing-tests.

Note The @testitem has an isolated scope. The package to be tested is loaded implicitly through using. To access unexported symbols, either export them or call them by prepending the module name. (i.e. MyPackage.foo())

A @testitem can be run via the “Run Test” link shown in an annotation on the righthand side of the editor, or via the “LSP-julia: Run Testitem” command from the command palette. Possible test failures or errors will be shown as annotations at the position in the code where they occured.

Note The @testitem feature only works in project environments, i.e. you must have opened a folder in the sidebar which contains a Project.toml file with a name and uuid field.

To completely disable this feature, you can toggle off the following entry in the LSP-julia.sublime-settings file:

{
  "initializationOptions": {
    "julialangTestItemIdentification": false
  }
}

Frequently Asked Questions

I have deleted or cleaned up my .julia directory. Now the language server doesn't start anymore.

Delete the LSP-julia folder at the following location: * on Windows: %LocalAppData%/Sublime Text/Package Storage/LSP-julia * on Linux: ~/.cache/sublime-text/Package Storage/LSP-julia * on macOS: ~/Library/Application Support/Sublime Text/Package Storage/LSP-julia

Then restart Sublime Text and open a Julia file to re-install the language server.

The embedded Julia REPL doesn't start if Julia was installed via juliaup.

This seems to be a bug/limitation in the Python 3.3 API environment, which is used by the Terminus package, when resolving symlinks.

As a workaround, you can manually specify the full path (without symlink) to the Julia executable in the LSP-julia package settings (Preferences: LSP-julia Settings from the command palette). Here is an example on Windows:

{
    "julia_executable_path": "C:\\Users\\<username>\\.julia\\juliaup\\julia-1.9.0+0.x64.w64.mingw32\\bin\\julia.exe",
}