XETO Extension for VSCode

Overview

The XETO Extension for VSCode provides language support and code editing features for the XETO language using the Language Server Protcol (LSP). It offers features as:

• syntax highlighting
• code completion
• diagnostics
• semantic tokens
• hover information
• go to definition
• rename symbols
• formatting

The extesion can be used both in:

• desktop environment (VisualCode)
• web environment, as a web extension (compatible with vscode.dev and github.dev)

Features

• Code editor features:

  • Syntax highlighting: Get syntax highlights for the XETO language
  • Folding: fold code around XETO constructs like { and <
  • Autoclosing: generate closing constructs for {, < and '
  • Sematic tokens support: change colors for tokens based on their semantics

  

• Diagnostics: Receive real-time errors regarding syntax problems

  

• Code completion proposals: Suggestions regarding properties on existing protos

  

• Hover information: Show available docs for symbols

  

• Show Definition of a Symbol: Peek the definition of a symbol defined either in the current workspace or in an external library

  

• Go to definition of a Symbol: Navigation to symbols, both in the current workspace and in the external libraries

  

• Formatting: Automatically format code according to language-specific rules.

  

• Rename symbol: Rename a symbol accross the entire workspace

  

• Document symbols: Quickly search for symbols defined in the current file

  

• Workspace symbols: Quickly search for symbols defined in the current workspace

  

• Document outline: Provides a fast way to see all the symbols defined in the current file and provides navigation the their definition

  

• Support for external libraries:

  • Define folders or files that are external to the workspace and use the symbols define there
  • Hover, Show Definition and Go to Definition work with these

• Support for sys libraries:

  • Load system libraries by specifiying a Git commit sha
  • this works similar to external libraries, but loading them via HTTP instead of local file system

• Support for data instances

Configuration

The XETO Extension supports configurations for

• external libraries
• sys libraries

To modify the extension's settings access the settings panel (Settings -> Settings or use the shortcut Ctrl+Shift+P or ⌘+Shift+P on Mac and search for Settings). Then search for xeto and update them as needed.

Note: some settings cannot be changed via the UI so you may need to edit the settings.json file by hand.

Usage

1. Open a xeto file that has the .xeto extension
2. The XETO Extension will automatically active and provide language-provided features
3. Use the provided Visual Studio Code keyboard actions and/or commands

Note: Some features (like go to definition) may take a few seconds to start, as we are reading sys libraries that are external to the host machine

Installation

Extension Marketplace

1. Launch Visual Studio Code
2. Open the Extensions tab using Ctrl+Shift+X or ⌘+Shift+X
3. Search by using xeto
4. Install the extension

GitHub Release

1. Go to the "Releases" section
2. Download the latest release package under extension.vsix
3. Launch Visual Studio Code
4. Open the Extensions tab using Ctrl+Shift+X or ⌘+Shift+X
5. Select Install from VSIX... from the Views and More Actions menu
6. Navigate to the downloaded file and select it

Note: more instructions on how to install extension from a VSIX here

License

This project is licensed under the BSD-3-Clause License. See the LICENSE for more info.