SimpleOne API Extension for Visual Studio Code

The SimpleOne API extension for Visual Studio Code provides hover tooltips, auto-completion, and syntax highlighting for SimpleOne client and server API classes and methods when editing JavaScript files.

Associating Scripts with API Types

To use the extension, you must associate scripts with a specific API type (client or server). To do this, simply open any JS file after installing the extension and select the association for the folder containing the file in the pop-up window. Associations are applied to all files in the folder, so we recommend storing scripts of different types in separate folders.

image

You can change the association later using the Associate Folder option in the folder’s context menu.

You can also add a comment //server or //client in the first line of an individual JS file to link it to the corresponding API type. This setting takes precedence over the folder-level association.

Syntax Highlighting and Tooltips

The extension adds syntax highlighting for SimpleOne API classes and methods in JS files.

You can override highlight styles in the settings.json file:

You can also completely disable syntax highlighting in the IDE settings:

When hovering over an API method or object, a tooltip appears with brief information and a link to the corresponding documentation article:

Auto-Completion

While writing scripts, the extension suggests SimpleOne API classes and methods in the auto-completion list and displays a tooltip with a brief description:

You can find the extension directly within the IDE by searching for keywords, or download it from the marketplace.

5 Likes