Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
koliyo committed Oct 27, 2023
1 parent f135ac1 commit 71b00ab
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
# Hylo LSP

Proof of concept LSP server for the [Hylo](https://github.com/hylo-lang/hylo) programming language, including VS Code extension.

The Hylo [Hylo VSCode extension](https://github.com/koliyo/hylo-vscode-extension) dynamically downloads the LSP binaries for the current machine OS/architecture.

This is currently very early in development!

## Features

The Hylo LSP currently support the following LSP features:

- Semantic token
- Syntax highlighting
- Document symbols
- Document outline and navigate to local symbol
- Definition
- Jump to definition
- Diagnostics
- Errors and warnings reported by the compiler

## Developer

To build and install a local dev version of the LSP + VSCode extension:

```sh
./build-and-install-vscode-extension.sh
```

### Command line tool

There is also a command line tool for interacting with the LSP backend. The command line tool is useful for debugging and testing new functionality. The LSP server is embedded in the client, which simplify debug launching and breakpoints.

Example usage:

```sh
swift run hylo-lsp-client semantic-token hylo/Examples/factorial.hylo
```
2 changes: 1 addition & 1 deletion hylo-vscode-extension

0 comments on commit 71b00ab

Please sign in to comment.