dee9e079d4
Outline view and completions for Enso code in VSCode. # Important Notes This PR provides the necessary infrastructure for building VSCode extension that includes `enso_parser` library compiled for all supported platforms. VSCode extension can now use libraries from `sbt` that are `publishM2`-ready. To make that possible a documentation must have been provided and fixed for those modules - hence so many changes in `.scala` classes. <img width="862" alt="image" src="https://github.com/enso-org/enso/assets/26887752/7374bf41-bdc6-4322-b562-85a2e761de2a"> Last, but not least. The outline view and completions display something.
5.5 KiB
Enso Language Support for VSCode
Downloading
Enso Tools for VSCode is available from VSCode marketplace. Simply install it from there.
It is possible to download the latest development version of the "VSCode
Extension" artifact from the
latest actions run.
After downloading the ZIP file unzip a .vsix from it and install the .vsix
file 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:
Outline View
Since version 1.40 the extension fills content of Outline View on supported platforms (Linux amd64, Mac, Windows):
Debugging a Single Enso File
Open any .enso files. Click left editor gutter to place breakpoints. Then
choose Run/Start Debugging. If asked, choose debug with Java+ (Enso is
Java virtual machine friendly). A prompt appears asking for path to bin/enso
binary:
Locate bin/enso executable in the Enso engine download. If binding from source
code, the executable is located at root of
Enso repository in
./built-distribution/enso-engine-*/enso-*/bin/enso. The .enso file gets
executed and output is printed in the area below editor:
Workspace Debugging
To work with all Enso code base continue with choosing File/Open Folder... and opening root of Enso Git Repository (presumably already built with sbt buildEngineDistribution). 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:
To debug the test/Base_Tests/src/Data/Vector_Spec.enso file with the root of
Enso repository opened in the VSCode workspace, choose preconfigured Launch
Enso File debug configuration before Run/Start Debugging.:
The rest of the workflow remains the same as in case of individual (without any
project ).enso file case.
Attach Debugger to a Process
Let's do a bit of debugging. Select "Listen to 5005" debug configuration:
And then just execute the engine distribution in debug mode:
sbt:enso> runEngineDistribution --debug --run test/Base_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:
Read more on Enso & Java Debugging
Building VSCode Extension
To build this VSCode 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.
Reference
There are extensions for NetBeans and also for IGV. Read more here.