nwolverson / Vscode Ide Purescript
Programming Languages
ide-purescript package for VS Code
This package provides editor support for PureScript projects in Visual Studio Code, based on the PureScript language server.
This package provides:
- [x] Build and error reporting
- [x] Quick-fix support for certain warnings
- [x] Autocompletion
- [x] Type info tooltips
- [x] Go to symbol
- [x] Go to definition
- [x] Formatting (via
purty
)
The extension language-purescript provides basic syntax highlighting support - it is required but should be installed automatically as a dependency. This package will start on opening a .purs
file, and automatically trigger a rebuild on saving a .purs
file.
Installation and General Use
This package makes use of the purs ide server
(previously psc-ide
) for most functionality, with purs compile
(by default via spago
) for the explicit
build command. All this is via a Language Server Protocol implementation, purescript-language-server. Multi-root workspaces should be supported via a multiple language server approach.
This package will launch a purescript-language-server
process, which will automatically (but this is configurable) start purs ide server
in your project directory and kill it when closing. Start/stop and restart commands are provided for the IDE server in case required (eg after changing config or updating compiler version).
For all functions provided by the IDE server you will need to build your project first! This can either be via the built-in
build command, or via an external tool - but if you do build externally, you should be sure to Restart/Reconnect purs IDE server
(accessed through CTRL+SHIFT+P
/CMD+SHIFT+P
) afterwards, or the IDE server will not be able to pick up any changes.
You can configure building with pulp
(optionally with psc-package
) or spago
by following the below configuration steps, after which you should also Restart/Reconnect purs IDE server
.
With Spago (default)
PureScript: Build
command will build your project using the command line spago build --purs-args --json-errors
.
Note that prior to spago version 0.10.0.0
, --
was used to separate purs args at the end of the command line.
For spago
with psc-package
, add the following configuration to your settings.json
:
{
"purescript.addSpagoSources": true,
"purescript.addNpmPath": true,
"purescript.buildCommand": "spago build --purs-args --json-errors"
}
With Pulp
PureScript: Build
command will build your project using the command line pulp build -- --json-errors
.
Version 0.8.0+ of the PureScript compiler is required, as well as version 10.0.0 of pulp
(with earlier versions remove --
).
For pulp
with psc-package
, add the following configuration to your settings.json
:
{
"purescript.addNpmPath": true,
"purescript.buildCommand": "pulp --psc-package build -- --json-errors"
}
Suggested extensions
See input-assist for Unicode input assistance on autocomplete which is known to work with this extension, alternatively unicode-latex which offers similar LaTeX based input vi a lookup command.
Key bindings
The only key binding supplied out of the box is Shift+Ctrl+B (or Shift+Cmd+B) for the full "Build" command. Although this is only enabled inside PureScript-language text editors, it does conflict with the built-in Build command. This can be edited, and other keybinds added, in the VS Code Keyboard Shortcuts preferences.
The following default vscode bindings are helpful for processing build errors:
-
F8
cycles through errors. -
CTRL + .
orCMD + .
shows suggested fixes. The compiler sometimes provides these suggestions.
Autocomplete
Provided from purs ide server
. Make sure
your project is built first.
Completions will be sourced from modules imported in the current file.
Tooltips
Hovering over an identifier will show a tooltip with its type.
This is really stupid, and only cares that you hover over a word regardless of context, you will get some false positives (eg doesn't see local definitions, just the globals that should be visible in a given module).
Hovering over a qualifier of a qualified identifier will show the associated module name.
Pursuit lookup
Commands "Search Pursuit" and "Search Pursuit Modules" are available to search for identifiers or modules/packages on Pursuit.
PSCI
No particular support. Suggest you open a PSCI in the integrated terminal.
Development
To develop (rather than use) this extension, see the instructions in purescript-language-server
.