Skip to content
This repository has been archived by the owner on Feb 1, 2019. It is now read-only.

Commit

Permalink
README.md: Add setting up dev env and known bugs
Browse files Browse the repository at this point in the history
  • Loading branch information
gaocegege committed Feb 10, 2017
1 parent 8d38d1a commit 9fa0946
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,30 @@

A visual studio code plugin working via [Language Server Protocol (LSP)](https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md).Python versions 3.x is supported.

**Note: this language server is currently in the early stages of active development and only supports to be run in debug mode now.**
## Feature preview

![](./docs/images/demo.gif)

## Getting started
## Setting up your dev environment, coding, and debugging

You'll need python version 3.5 or greater.
You'll need python version 3.5 or greater, run `pip3 install -r requirements.txt` to install the requirements, and run `python3 langserver-python.py --mode=tcp --addr=2087` to start a local languager server listening at port 2087.

1. `pip3 install -r requirements.txt`
1. `python3 langserver-python.py --mode=tcp --addr=2087`
Then you should update the `./vscode-client/src/extension.ts` to make client in TCP mode.

```diff
export function activate(context: ExtensionContext) {
- context.subscriptions.push(startLangServer
- (require("path").resolve(__dirname, '../coala-langserver.sh'), ["python"]));
+ context.subscriptions.push(startLangServerTCP(2087, ["python"]));
console.log("coala language server is running.");
}
```

To try it in [Visual Studio Code](https://code.visualstudio.com), open ./vscode-client in VS Code and turn to debug view, launch the extension.

## Feature preview
## Known bugs

![](./docs/images/demo.gif)
* [Language server restarts when `didSave` requests come](https://github.com/coala/coala-vs-code/issues/7)

## Reference

Expand Down

0 comments on commit 9fa0946

Please sign in to comment.