Visual Studio Code Extension

Information

This page contains information about an extension that can be installed in Visual Studio Code and used for developing IXP exercise definitions. Visual Studio Code is an enhanced text editor featuring extensive language support, along with options for extensions that can add additional support for specific languages and settings files, such as exercise definitions. The extension provides syntax checking and multiple commands to enhance your design experience and minimize the number of mistakes made during exercise definition editing.

Features

• Multiple templates (snippets) for parts of the exercise definition:

full-config
basic-email
template-email
info-inject
email-inject
objective
activity
questionnaire
q-radio
q-multiple-choice
q-free-form
q-auto-free-form
basic-tool
multi-tool

• Instant syntax check for definition version 0.23.3.
• Upgrade of definition syntax from version 0.18.1 to 0.23.3.
• Ignoring of hidden files during definiton zipping.
• Support for repository-like definition structure (multiple subdirectories).
• Validates definition through deployed instance of IXP in version 4.0.X.
• Removes previously stored credentials and URL for IXP instance.

Commands

• Creates a new definition folder with the selected name and prepopulated files like config.yml and channels.yml

Command: Create New Definition Folder

• Zips selected definition to be uploaded to IXP.

Command: Zip Definition

• Upgrades definition from version 0.18.1 (Citadel) to 0.23.3 (Dux)

Command: Upgrade Definition 0.18.1 to 0.23.3

• Validates definition through deployed instance of IXP.

Command: Validate Definition

• Removes stored credentials and URL for IXP instance used for validation.

Command: Delete Saved IXP Credentials

Keybindings

• Zip command - Windows: Ctrl + Alt + g, MacOS: Control + Option + g
• Open command palette - Windows: Ctrl + Shift + p, MacOS: Command + Shift + p

Dependencies

• https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml

ext install redhat.vscode-yaml

License

MIT license