Files
vscode-extension-samples/lsp-sample/README.md
Niklas Mollenhauer 945d6c8ecb Change client folder to lsp-sample
There is no `.vscode` folder inside the `client` folder that holds some launch configration. The parent directory contains a `.vscode` with a `launch.json` which defines 'Launch Client'.
2018-04-14 17:17:00 +02:00

22 lines
1.0 KiB
Markdown

# README
## This is the README for the "languageprovider-sample"
-------------------
This folder contains a sample VS code extension that demonstrates an extension that runs a language server
The extension observes all 'plaintext' documents (documents from all editors not associated with a language)
and uses the server to provide validation and completion proposals.
The code for the extension is in the 'client' folder. It uses the 'vscode-languageclient' node module to launch the language server.
The language server is located in the 'server' folder.
# How to run locally
* `npm install` to initialize the extension and the server
* `npm run compile` to compile the extension and the server
* open the `lsp-sample` folder in VS Code. In the Debug viewlet, run 'Launch Client' from drop-down to launch the extension and attach to the extension.
* create a file `test.txt`, and type `typescript`. You should see a validation error.
* to debug the server use the 'Attach to Server' launch config.
* set breakpoints in the client or the server.