Skip to content

mdanilov/automate-vscode-extension

Repository files navigation

Automate VSCode Extension

Visual Studio Marketplace Version Visual Studio Marketplace Rating (Stars) Visual Studio Marketplace Downloads Visual Studio Marketplace Installs

This is the ESR Automate Textual Language support plugin for Visual Studio Code. ESR Labs Automate - a lightweight yet powerful approach to AUTOSAR software development.

Getting Started

Syntax highlighting works out-of-the-box. For other features ESR Automate RText service is required. How to configure the RText service see the ESR Automate User Manual, Chapter Editor Back-End Service. Basically you have to create the .rtext configuration file with the command for the *.atm file extension.

*.atm:
automate-rtext-service <args...>

IMPORTANT: The .rtext file must be located in the opened workspace folder together with *.atm files. Otherwise, the RText service will not be started.

Features

  • Automate Textual syntax highlighting.
  • Auto-completion of language commands and command attributes.
  • Improved navigation, developers can follow references across files and jump backward to source elements.
  • Navigate symbols in workspace.
  • Manage RText service connections.

Syntax Highlighting

The ESR Automate VSCode extension add a new language identifier Automate and associate it with .atm files to support the syntax highlighting. However, you may try to use it with another RText based language, to do this run the the Change Language Mode command (Ctrl+K M) and select the Automate language for the file.

Macro

Connection Management

The extension provides a status bar indicator to show the number of the running RText service instances. Click on the indicator to see the list of the connections. Use the item Restart button to restart a connection.

Connection Manager

Navigation

Link References

Use Ctrl+click on link references to navigate between model elements. This feature does not work with short references, but you can use the Go to References instead.

Link

Find All References

Execute Find All References (Alt+Shift+F12) or a Go to References search (via Shift+F12) to see the result inline.

Find all references

Open Symbol By Name

Support jumping to a symbol across files with Ctrl+T. Type the first letter of a type you want to navigate to, regardless of which file contains it, and press Enter.

Open symbol by name

Auto-completion

Use Ctrl+space to show the completion list.

Auto completion

Requirements

  • RText service is part of the ESR Labs Automate product and it's required for some features. Get Automate.

Extension Settings

This extension contributes the following settings:

  • automate.enable: enable/disable this extension
  • automate.useRTextServer: enable/disable Automate RText service

Visual Studio Marketplace

This extension is available on the Visual Studio Marketplace for Visual Studio Code.

Questions, issues and contributions

  • If you come across a problem with the extension, please file an issue
  • If you have a question about how to work with the extension, please contact Maksim Danilov