Skip to content

Latest commit

 

History

History
79 lines (63 loc) · 4.03 KB

README.md

File metadata and controls

79 lines (63 loc) · 4.03 KB
Raw

xOpera SaaS plugin for VS Code/Eclipse Che Theia

This repository allows you to set up VS Code/Eclipse Che Theia xOpera SaaS plugin. If you are totally unfamiliar with xOpera you can take a look at the xOpera documentation.

Aspect Information
Documentation xOpera SaaS plugin documentation
Open VSX Registry Open VSX Registry plugin link
Visual Studio Marketplace VS Marketplace plugin link
Video xOpera SaaS with Eclipse Che

Table of Contents

Installation and publishing

This is originally a Visual Studio Code extension/plugin, so the best way to test it locally is to through VS Code's extension development host. RADON IDE is represented by Eclipse Che which uses an open-source cloud and desktop IDE framework called Eclipse Theia within the workspaces. Eclipse Theia is very similar to VS Code and therefore VS Code extensions can be also used in Theia.

VS Code installation

The plugin can be installed through Visual Studio Marketplace here: VS Marketplace plugin link.

To install the plugin without the VS Marketplace to your VS Code editor you will need the latest vsix plugin package, which you can download get here: VS Marketplace plugin link (or check Releases). Then you just have to import the vsix file to the VS Code plugins and after that you will be able to use the plugin in any VS Code window.

Eclipse Che Theia installation

TPS plugin was primarily meant for usage in Eclipse Theia which is the main editor in the Eclipse Che/RADON IDE. THe plugin is available in the Open VSX Registry here: Open VSX Registry plugin link.

To install the plugin manually to Eclipse Che you will need the prepared YAML devfile (which also uses the prepared meta.yaml file). The files to try this can be found in publishing-samples.

Publishing

Here's what you need to do to test the plugin and to package/publish it:

# install Node JS from https://nodejs.org/en/download/
# and test it with node -v and npm -v command

# install prerequisite packages
npm install

# test the plugin in VS Code (this will open a new window with your extension loaded)
press F5 (Run Extension)

# package and publish the extension
# if you don't have npx install it with: npm install npx
npx vsce package

Main features

The extension uses xOpera SaaS REST API and can therefore invoke various xOpera SaaS actions.

The plugin currently allows users to:

  • create a new SaaS workspace
  • create a new SaaS project in a new or existing workspace
  • deploy a project