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

Commit

Permalink
README: Update README.md and assets
Browse files Browse the repository at this point in the history
This updates the README text and updates the
demo assets.
  • Loading branch information
ksdme committed Jun 8, 2018
1 parent a8baa6d commit 68aa293
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 23 deletions.
31 changes: 8 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,20 @@
# coala-vs-code
# coala-ls

[![Build Status](https://travis-ci.org/coala/coala-vs-code.svg?branch=master)](https://travis-ci.org/coala/coala-vs-code)
[![codecov](https://codecov.io/gh/coala/coala-vs-code/branch/master/graph/badge.svg)](https://codecov.io/gh/coala/coala-vs-code)
[![Build Status](https://travis-ci.org/coala/coala-ls.svg?branch=master)](https://travis-ci.org/coala/coala-ls)
[![codecov](https://codecov.io/gh/coala/coala-ls/branch/master/graph/badge.svg)](https://codecov.io/gh/coala/coala-ls)

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.
A coala language server based on [Language Server Protocol (LSP)](https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md). Python versions 3.x is supported.

## Feature preview

![](./docs/images/demo.gif)
![coala-ls demo](./docs/images/demo.gif)
Watch full video on [YouTube](https://www.youtube.com/watch?v=MeybdlCB96U)

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

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.

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.

## Known bugs

* [Language server restarts when `didSave` requests come](https://github.com/coala/coala-vs-code/issues/7)
You'll need python version 3.5 or greater, run `pip3 install -r requirements.txt` to install the requirements, and run `python3 -m coalals --mode=tcp --addr=2087` to start a local language server listening at port 2087. Currently stdio mode is also supported and can be used by invoking coalals with `--mode=stdio`.

## Reference

* [python-langserver](https://github.com/sourcegraph/python-langserver)
* [python-language-server](http://github.com/palantir/python-language-server)
Binary file modified docs/images/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 68aa293

Please sign in to comment.