Xronos VS Code
System Requirements
- A Linux-based operating system. We recommend
Ubuntu 22.04 or newer.
node.js needs to be installed. We recommend version 23.1.0, and versions
older than 16.0.0 will not work. We recommend using nvm to manage your
node version, as described
here.
Features
Rendering Diagrams
Open the VS Code Command Palette using
Ctrl+Shift+P. Type Xronos: Diagram and select
the corresponding entry using ⏎. This will open the Xronos Diagram
view.
Initially, no diagram is shown. The diagram view automatically renders a diagram
for the program that was last executed.
Code Navigation
You can also use the diagram to navigate your code. Select an element in the
diagram and press F12, or click on an element while holding down the
Ctrl key (Cmd/⌘ key on Mac). This will bring
you to the location in the Python code that created the element.
Viewing Diagram Server Logs
To view the diagram server logs, open the VS Code integrated terminal using
Ctrl+` and navigate to the terminal titled Xronos Diagram Server.
Interoperability with WSL or Visual Studio Code Remote - SSH
We recommend Microsoft's WSL or Visual Studio Code Remote - SSH extensions
for users who prefer to use an unsupported operating system or who are doing
on-target development on a headless machine.
The diagram viewer requires port forwarding in order to work with the Visual Studio Code Remote - SSH extension. WSL does not require port forwarding.
The first time you start a new VS Code session using the Visual Studio Code Remote - SSH extension and open the diagram viewer, you may receive a
notification stating, "Your application running on port [some port number] is
available."
If you do not receive this notification, it could be because automatic port
forwarding is not enabled in your VS Code settings. Therefore, you will need to
forward a port manually by following the directions in VS Code's official
documentation or by
executing the command VS Code: Forward a Port in the VS Code command palette.
The port you will need to forward will be specified in the logs as some port
number between 3001 and 3020.
