Skip to content

Commit 8dc37ee

Browse files
youben11ccordoba12
authored andcommitted
Update docs about vscode-client (#633)
1 parent 9447bd7 commit 8dc37ee

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

vscode-client/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,27 @@ at once with minimal extra configuration per language.
66

77
## Using this extension
88

9-
1. Follow the [Getting Started instructions for this project](../README.md)
10-
1. Run `npm install`.
11-
1. Run `npm run vscode` to start a new VSCode instance. Use `npm run vscode -- /path/to/mydir` to open the editor to a specific directory.
12-
1. Open a `.go` file and hover over text to start using the Go language server.
9+
10+
1. Follow the [Develop against VS Code instructions](/../../#develop-against-vs-code)
11+
1. Open a `.py` file and hover over text to start using the Python language server.
1312

1413
To view a language server's stderr output in VSCode, select View → Output.
1514
To debug further, see the "Hacking on this extension" section below.
1615

17-
After updating the binary for a language server (during development or after an upgrade), just kill the process (e.g., `killall langserver-go`).
16+
After updating the binary for a language server (during development or after an upgrade), just kill the process (e.g., `killall pyls`).
1817
VSCode will automatically restart and reconnect to the language server process.
1918

2019
> **Note for those who use VSCode as their primary editor:** Because this extension's functionality conflicts with other VSCode extensions
21-
(e.g., showing Go hover information), the `npm run vscode` script launches an separate instance of VSCode and stores its config in `../.vscode-dev`.
20+
(e.g., showing Python hover information), the `yarn run vscode` script launches a separate instance of VSCode and stores its config in `../.vscode-dev`.
2221
It will still show your existing extensions in the panel (which seems to be a VSCode bug), but they won't be activated.
2322

2423
## Adding a language server
2524

26-
Register your language server at the bottom of [`extension.ts`](https://github.com/sourcegraph/langserver/blob/master/vscode-client/src/extension.ts).
25+
Register your language server at the bottom of [`extension.ts`](src/extension.ts).
2726

2827
## Hacking on this extension
2928

30-
1. Run `npm install` in this directory (`vscode-client`).
29+
1. Run `yarn install` in this directory (`vscode-client`).
3130
1. Open this directory by itself in Visual Studio Code.
3231
1. Hit F5 to open a new VSCode instance in a debugger running this extension. (This is equivalent to going to the Debug pane on the left and running the "Launch Extension" task.)
3332

0 commit comments

Comments
 (0)