Chapter 9. Adding a Visual Studio Code extension to a workspace

Prerequisites

1. You have the .che/che-theia-plugins.yaml file in the root of the GitHub repository.

Procedure

1. Add the ID of the plug-in to the .che/che-theia-plugins.yaml file. Use the / sign to separate the publisher and plug-in name. The following example uses the IDs of Red Hat Visual Studio Code Java extension:

   - id: redhat/java/latest

Prerequisites

1. You have the .che/che-theia-plugins.yaml file in the root of the GitHub repository.

Procedure

1. Add an override section to the .che/che-theia-plugins.yaml file under the id of the plug-in.

2. Specify the memory limit for the extension. In the following example, OpenShift Dev Spaces automatically installs the Red Hat Visual Studio Code Java extension in the OpenShift Dev Spaces workspace and increases the memory of the workspace by two gigabytes:

     - id: redhat/java/latest
       override:
         sidecar:
           memoryLimit: 2Gi

Prerequisites

1. You have the .che/che-theia-plugins.yaml file in the root of the GitHub repository.

Procedure

1. Add an override section to the .che/che-theia-plugins.yaml file under the id of the extension.

2. Specify the preferences in the Preferences section. In the following example, OpenShift Dev Spaces automatically installs Red Hat Visual Studio Code Java extension in the OpenShift Dev Spaces workspace and sets the java.server.launchMode preference to LightWeight:

     - id: redhat/java/latest
       override:
         preferences:
           java.server.launchMode: LightWeight

Procedure

1. Add an attributes section to your devfile.yaml file.
2. Add .vscode/extensions.json to the atributes section. Add a | sign after the colon separator.

3. Paste the contents of the .vscode/extensions.json file after the | sign. The following example uses Red Hat Visual Studio Code Java extension attributes:

   schemaVersion: 2.2.0
   metadata:
     name: my-example
   attributes:
     .vscode/extensions.json: |
       {
         "recommendations": [
           "redhat.java"
         ]
       }

Procedure

1. Add an attributes section to your devfile.yaml file.
2. Add .vscode/extensions.json to the atributes section. Add a | sign after the colon separator.

3. Paste the content of the .che/che-theia-plugins.yaml file after the | sign. The following example uses Red Hat Visual Studio Code Java extension attributes:

   schemaVersion: 2.2.0
   metadata:
     name: my-example
   attributes:
     .che/che-theia-plugins.yaml: |
       - id: redhat/java/latest