Skip to content
This repository has been archived by the owner on Nov 18, 2022. It is now read-only.

Latest commit

 

History

History
81 lines (53 loc) · 2.54 KB

contributing.md

File metadata and controls

81 lines (53 loc) · 2.54 KB
Raw

Contributing

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.

Via Rustup

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/.

Via Source

Check out the RLS source code, following the directions. Point the 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 rls.root which has been removed.

Logging

You can log to the output panel in VSCode by setting rust-client.revealOutputChannelOn to info. You can log to a file in the project directory by setting rust-client.logToFile to 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 installDevExtension in package.json and VSCode docs for more.

Troubleshooting

Error messages containing tsc -watch -p ./ or ENOSPC

> npm ERR! Failed at the rls_vscode@0.0.1 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.

run

> 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