-
Notifications
You must be signed in to change notification settings - Fork 323
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Downloadable VSCode extension (#7861)
- Loading branch information
1 parent
15b1989
commit 7a31dcd
Showing
6 changed files
with
139 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| { | ||
| "version": "0.2.0", | ||
| "configurations": [ | ||
| { | ||
| "name": "Listen to 5005", | ||
| "type": "java+", | ||
| "request": "attach", | ||
| "listen": "true", | ||
| "hostName": "localhost", | ||
| "port": "5005" | ||
| }, | ||
| { | ||
| "name": "Debug Adapter Protocol", | ||
| "type": "node", | ||
| "debugServer": 4711, | ||
| "request": "attach" | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| # Enso Language Support for VSCode | ||
|
|
||
| [](https://github.com/enso-org/enso/actions/workflows/enso4igv.yml) | ||
|
|
||
| ## Downloading | ||
|
|
||
| **Download** _"VSCode Extension" artifact_ from the | ||
| [latest actions run](https://github.com/enso-org/enso/actions/workflows/enso4igv.yml), | ||
| unzip, install into VSCode: | ||
|
|
||
|  | ||
|
|
||
| Your Enso files will get proper **syntax coloring**. You'll be able to **debug** | ||
| Java/Enso code interchangeably. | ||
|
|
||
| After installing the Enso `.vsix` file (and reloading window) we can find | ||
| following two extensions in the system: | ||
|
|
||
|  | ||
|
|
||
| ## Using & Debugging | ||
|
|
||
| Once installation is over let's continue with choosing _File/Open Folder..._ and | ||
| opening root of [Enso Git Repository](http://github.com/enso-org/enso) | ||
| (presumably already built with | ||
| [sbt buildEngineDistribution](../../docs/CONTRIBUTING.md#running-enso)). | ||
| Following set of projects is opened and ready for use: | ||
|
|
||
|  | ||
|
|
||
| With the workspace opened, you can open any Enso or Java file. Let's open for | ||
| example `Vector_Spec.enso` - a set of unit tests for `Vector` - a core class of | ||
| Enso standard library: | ||
|
|
||
|  | ||
|
|
||
| It is now possible to place breakpoints into the `Vector_Spec.enso` file. Let's | ||
| place one on line 120: | ||
|
|
||
|  | ||
|
|
||
| Let's do a bit of debugging. Select _"Listen to 5005"_ debug configuration: | ||
|
|
||
|  | ||
|
|
||
| And then just | ||
| [execute the engine distribution](../../docs/CONTRIBUTING.md#running-enso) in | ||
| debug mode: | ||
|
|
||
| ```bash | ||
| sbt:enso> runEngineDistribution --debug --run test/Tests/src/Data/Vector_Spec.enso | ||
| ``` | ||
|
|
||
| After a while the breakpoint is hit and one can inspect variables, step over the | ||
| statements and more... | ||
|
|
||
|  | ||
|
|
||
| ...as one can seamlessly switch to debugging on the Enso interpreter itself! One | ||
| can place breakpoint into Java class like `PanicException.java` and continue | ||
| debugging with `F5`: | ||
|
|
||
|  | ||
|
|
||
| Should one ever want to jump back from Java to Enso one can use the _"Pause in | ||
| GraalVM Script"_ action. Select it and continue with `F5` - as soon as the code | ||
| reaches a statement in Enso, it stops: | ||
|
|
||
|  | ||
|
|
||
| ## Building VSCode Extension | ||
|
|
||
| To build thisVSCode extension and obtain _Enso_ syntax coloring as well as | ||
| support for editing and debugging of `engine/runtime` sources in **VSCode**: | ||
|
|
||
| ``` | ||
| enso/tools/enso4igv$ mvn clean install -Pvsix | ||
| enso/tools/enso4igv$ ls *.vsix | ||
| enso4vscode-*.vsix | ||
| ``` | ||
|
|
||
| one needs to have `npm`, Java and `mvn` available to successfully build the | ||
| VSCode extension. | ||
|
|
||
|  | ||
|
|
||
| Once the `.vsix` file is created, it can be installed into VSCode. Select | ||
| _Extension perspective_ and choose _Install from VSIX..._ menu item. |