Skip to content

frankaemika/ride-vscode

Repository files navigation

ride

App development tools for Visual Studio Code.

Features

The following features have been implemented:

  • Syntax highlighting for .lf files, including Lua and context menu HTML blocks.
  • Language Server support for .lf files
    • Diagnostics (lf syntax errors)
    • Jump to definition
    • List references
    • Show type definition of linked state machines
    • Auto completion
    • Integrated lua language server
  • Show a LF state machine visualization.

Requirements

  • Visual Studio Code 1.80.1.
  • ride-cli >= 0.9.0 for Language Server and >= 1.0.0 for LF state machine visualization support.

Install instructions for VSCode on Windows

At present, we do not offer a ride-cli package that directly runs on Windows. To use the language server which is built into the ride-cli executable you can leverage the WSL (Windows Subsystem for Linux).

  1. Start with installing WSL and the ride-cli package by following the ride-cli documentation provided in the Franka World Hub.
  2. Install the Microsoft WSL extension
  3. Connect to WSL: Press F1 to open the command palette and enter Connect to WSL
  4. Install the RIDE plugin in the WSL environment.
  5. Open your state machines / bundles in the WSL file system. Now you're ready to use the full features of this plugin on Windows.

Further information about developing in WSL can be found here.

License

ride is licensed under the Apache 2.0 license. The icons in the images/icons folder are from the Google Material Icons Library and are licensed under the Apache 2.0 license.