Theia - Che Task Extension

The extension allows to work with the Che Commands through the Theia Tasks concept.

Contributes:

• Che task runner that runs the Che commands as the Theia tasks;
• Che task resolver that fills the missed mandatory parameters in a task;
• Che task provider that provides the Che workspace's commands as provided Theia tasks;
• Preview URLs view;
• che.task.preview.notifications preference to set the preferred way of previewing a service URL:
  • on value enables a notification to ask a user how a URL should be opened
  • alwaysPreview value tells Theia to open a preview URL automatically inside Theia as soon as a task is running
  • alwaysGoTo value tells Theia to open a preview URL automatically in a separate browser's tab as soon as a task is running
  • off value disables opening a preview URL (automatically and with a notification)

The extension provides the CheTaskService allows to run a Che task by it's name.

The format of a Che task is the following:

{
    "type": "che",
    "label": "",
    "command": "",
    "target": {
        "workspaceId": "",
        "machineName": ""
    },
    "previewUrl": ""
}

The target and previewUrl fields are optional.

The variables substitution is supported for the command and previewUrl fields.

Running and developing with the example app

Start Che

Run a Che7 workspace with the che-machine-exec-plugin included, e.g. use Che7 stack.

Run the example Theia app

Set the environment variables point to your workspace:

• CHE_API_EXTERNAL
• CHE_API_INTERNAL
• CHE_WORKSPACE_ID

Build the extension and start the example app

yarn
cd browser-app
yarn start

Open http://localhost:3000 in the browser

Start watching of the che-theia-task-extension

cd che-theia-task-extension
yarn watch

Start watching of the example app

cd browser-app
yarn watch