Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IWANABETHATGUY/tower-lsp-boilerplate
https://github.com/IWANABETHATGUY/tower-lsp-boilerplate
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/IWANABETHATGUY/tower-lsp-boilerplate
- Owner: IWANABETHATGUY
- License: mit
- Created: 2022-03-05T03:19:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-27T09:08:07.000Z (3 months ago)
- Last Synced: 2024-10-12T00:43:16.337Z (about 1 month ago)
- Language: Rust
- Size: 414 KB
- Stars: 203
- Watchers: 2
- Forks: 17
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# boilerplate for a rust language server powered by `tower-lsp`
## Introduction
This repo is a template for `tower-lsp`, a useful github project template which makes writing new language servers easier.
## Development using VSCode
1. `pnpm i`
2. `cargo build`
3. Open the project in VSCode: `code .`
4. In VSCode, press F5 or change to the Debug panel and click Launch Client.
5. In the newly launched VSCode instance, open the file `examples/test.nrs` from this project.
6. If the LSP is working correctly you should see syntax highlighting and the features described below should work.
> **Note**
>
> If encountered errors like `Cannot find module '/xxx/xxx/dist/extension.js'`
> please try run command `tsc -b` manually, you could refer https://github.com/IWANABETHATGUY/tower-lsp-boilerplate/issues/6 for more details
## A valid program in nano rust
```rust
fn factorial(x) {
// Conditionals are supported!
if x == 0 {
1
} else {
x * factorial(x - 1)
}
}
// The main function
fn main() {
let three = 3;
let meaning_of_life = three * 14 + 1;
print("Hello, world!");
print("The meaning of life is...");
if meaning_of_life == 42 {
print(meaning_of_life);
} else {
print("...something we cannot know");
print("However, I can tell you that the factorial of 10 is...");
// Function calling
print(factorial(10));
}
}
```
## Features
This repo use a language `nano rust` which first introduced by [ chumsky ](https://github.com/zesterer/chumsky/blob/master/examples/nano_rust.rs). Most common language feature has been implemented, you could preview via the video below.
- [x] InlayHint for LiteralType
- [x] semantic token
make sure your semantic token is enabled, you could enable your `semantic token` by
adding this line to your `settings.json`
```json
{
"editor.semanticHighlighting.enabled": true,
}
```
- [x] syntactic error diagnostic
https://user-images.githubusercontent.com/17974631/156926382-a1c4c911-7ea1-4d3a-8e08-3cf7271da170.mp4
- [x] code completion
https://user-images.githubusercontent.com/17974631/156926355-010ef2cd-1d04-435b-bd1e-8b0dab9f44f1.mp4
- [x] go to definition
https://user-images.githubusercontent.com/17974631/156926103-94d90bd3-f31c-44e7-a2ce-4ddfde89bc33.mp4
- [x] find reference
https://user-images.githubusercontent.com/17974631/157367235-7091a36c-631a-4347-9c1e-a3b78db81714.mp4
- [x] rename
https://user-images.githubusercontent.com/17974631/157367229-99903896-5583-4f67-a6da-1ae1cf206876.mp4