This repo provides the RLS client for vscode built using the Language Server protocol.
This file contains information for building, running, and debugging the plugin. If you just want to use it, you can download it from the VSCode marketplace. See README.md for more info.
Building and Running
Git clone or download the files and use
npm install in the directory to
download and install the required modules.
Next, without installing the client as a regular VSCode extension, open the client folder in VSCode. Go to the debugger and run "Launch Extension". This opens a new instance of VSCode with the plugin installed.
This is the default, if you don't set any of the environment variables below, the extension will run (and install) the RLS via rustup. You can install rustup from https://www.rustup.rs/.
Check out the RLS source code, following the directions.
rust-client.rlsPath setting at the RLS executable (e.g.,
/rls/target/release/rls). Note that you must include the name of the
executable, not just the path.
Note that this used to be possible via
rls.path which is deprecated and
which has been removed.
You can log to the output panel in VSCode by setting
info. You can log to a file in the project directory by setting
true. You won't see much logging unless you modify your RLS.
Installing in VSCode
If you'd like to test on multiple projects and already have the extension working properly, you can manually install the extension so that it's loaded into VSCode by default. To do so, run the following:
npm run installDevExtension
See the defenition of
package.json and VSCode docs
Error messages containing
tsc -watch -p ./ or
> npm ERR! Failed at the firstname.lastname@example.org compile script 'tsc -watch -p ./'. > npm ERR! Make sure you have the latest version of node.js and npm installed. > npm ERR! If you do, this is most likely a problem with the rls_vscode package, > npm ERR! not with npm itself.
> npm dedupe
see http://stackoverflow.com/a/31926452/1103681 for an explanation
if that doesn't work, run
> echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p