GEMscript for Visual Studio Code

The GEMscript extension for Visual Studio Code provides launguage support for GEMstudio Pro projects.

GEMstudio Pro is the easiest, fastest and most flexible graphical user interface design software in the embedded space. GEMstudio enables anyone to easily design, customize, test and implement a high-end user interface into any embedded product. Download it for free here.

Quick Start

Install the extension
- The GEMstudio installer will install a matching version of this extension if Visual Studio Code is already installed
If you do not have GEMstudio installed, install the latest version here
- This extension requires GEMstudio version 4.0.0 and later
The extension is activated when accessing a valid GEMscript workspace:
- The GEMstudio project must be saved as a Version Control Project (VCP) format
- The GEMscript workspace is automatically opened in Visual Studio Code when launching from GEMstudio
- To open a workspace manually, In Visual Studio Code File -> Open Folder.. and open the pages folder at /ProjectDirectory/.GEMPName/pages/

Features

The GEMscript language support extension for Visual Studio Code adds the following language features for GEMscript projects:

Syntax Highlighting

GEMscript syntax highlighting support for *.gsf files
Supports Visual Studio Code color themes

Code Completion

Auto-Completion for the following:
- GEMscript API methods
- Page widgets & methods
- Local page functions
- Macros defined in *.macro file

Code Completion in GEMscript

Hover tooltip to show expanded macros from *.macro file

Requirements

GEMstudio must be installed on the system for this extension to work. To download the latest version of GEMstudio, visit Amulet's website.

 Required Version: GEMstudio v4.0.0 and up

Usage

This extension is designed to be used with GEMstudio. The extension activates when the full GEMscript folder is opened in the Visual Studio Code workspace. The extension does not support editing single *.gsf files. GEMstudio automatically opens the GEMscript folder when configured to use Visual Studio Code as the default editor. To use this extension with a GEMstudio project, the project must be saved in the Version Control Project (VCP) format.

To open a GEMscript folder manually, the pages folder of a GEMstudio project must be opened in Visual Studio Code. This folder can be found within your GEMstudio project folder: GEMPDirectory/.GEMPName/pages/and can be opened within Visual Studio Code by using File -> Open Folder...

GEMstudio Setup

To configure Visual Studio Code as the default editor in GEMstudio:

Go to the Tools -> Options menu and use the dropdown box for Editor to select the default editor.
- You can also toggle *.gpf file visibility for Visual Studio Code. When checked, page fles (*.gpf) will be hidden within the file directory of Visual Studio Code.
If not already done, save the GEMstudio project in the Version Control Project (VCP) format. For new projects, this is the default. For existing projects, you can choose File -> Save As to convert the project to the VCP format.
When Visual Studio Code is selected as the editor, GEMstudio will launch Visual Studio Code and open the GEMscript folder. To do this in GEMstudio, right click on a page you wish to edit in Visual Studio Code and select Edit Page Functions. This opens the whole GEMscript workspace folder with the page you clicked as the default file to view first.
- Alternatively, you can launch Visual Studio Code from Project -> Page Functions. This opens the whole GEMscript workspace folder without a default file to view first.