You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-6
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,10 @@
10
10
-[Profiling](#profiling)
11
11
-[Contributing](#contributing)
12
12
-[Development Process](#development-process)
13
-
-[Build and Install VSCode Extension](#build-and-install-vscode-extension)
14
-
-[Build the Language Server](#build-the-language-server)
13
+
-[Building and Installing the VSCode Extension](#building-and-installing-the-vscode-extension)
14
+
-[Building the Rhai CLI](#building-the-rhai-cli)
15
15
-[Debugging the Language Server](#debugging-the-language-server)
16
+
-[Building the VSCode Extension](#building-the-vscode-extension)
16
17
17
18
# Rhai LSP
18
19
@@ -23,7 +24,7 @@ It's incomplete and not recommended for general use yet, everything can be subje
23
24
## Requirements
24
25
25
26
- Stable Rust toolchain (e.g. via [rustup](https://rustup.rs/))
26
-
- yarn (for VS Code)
27
+
- yarn 2 (for VS Code)
27
28
-[vsce](https://www.npmjs.com/package/vsce) for VS Code extensions
28
29
29
30
## Project Structure
@@ -82,7 +83,7 @@ The documentation is still pretty much WIP (as everything else). All contributio
82
83
83
84
Currently the following steps are used to develop the project via vscode:
84
85
85
-
#### Build and Install VSCode Extension
86
+
#### Building and Installing the VSCode Extension
86
87
87
88
Install the extension with the following:
88
89
```sh
@@ -91,10 +92,10 @@ Install the extension with the following:
91
92
92
93
You only have to do this at the beginning or whenever you update the extension.
93
94
94
-
#### Build the Language Server
95
+
#### Building the Rhai CLI
95
96
96
97
```sh
97
-
cargo install --path crates/lsp --debug
98
+
cargo install --path crates/rhai-cli --debug
98
99
```
99
100
100
101
This will build and install the `rhai` executable globally that the vscode extension looks for.
@@ -104,3 +105,17 @@ After this step right now you have to manually kill the old running `rhai` execu
104
105
#### Debugging the Language Server
105
106
106
107
The debugging process can consist of either strategically placed `tracing::info` statements that are visible in the VSCode debug console under `Rhai LSP`, or attaching a debugger to the running `rhai` process via [LLDB VSCode](https://marketplace.visualstudio.com/items?itemName=lanza.lldb-vscode). Both approaches deemed sufficient so far.
108
+
109
+
#### Building the VSCode Extension
110
+
111
+
The vscode extension relies on rhai-lsp compiled to WebAssembly via [`rhai-wasm`](./crates/rhai-wasm). There are several related [js libraries](./js) that are built on top of it.
112
+
113
+
Generally all you should need is `yarn` (2), and `vsce`, and the following single command:
0 commit comments