Open a VS Code Workspace

​

Install VS Code extensions

1. Use the pre-run script.
2. Use VS Code’s extensions manager.

​

Use the pre-run script

1. Go to the environment.
2. Click Edit Environment.
3. In Pre Run Script, paste the following:
   code-server --install-extension <extension-name> --extensions-dir ${HOME}/.local/share/code-server/extensions
   
4. Click Build.

​

Use VS Code’s extensions manager

1. Find the extension you want to install in the Visual Studio Marketplace. For example, install the scala-lang extension.
2. Microsoft obscures the download URL for the extension by default. Open your browser’s development tools, then click Download extension.
3. Get the download URL for the extension from the request details in your browser’s development tools. It ends with /vspackage. Copy this URL.
4. In Domino, create a new environment. As the base image, use one of the VS Code-equipped Domino standard environments, listed in the Domino standard environments.
5. Add the following instructions to your environment’s Dockerfile. Replace the folder names and example /vspackage URL with the extension URL you retrieved previously. These commands download the extension, extract the required files, and add them to the appropriate folder.
   USER root
   
   RUN apt-get update
   RUN apt-get install -y bsdtar
   RUN mkdir -p /home/ubuntu/.local/share/code-server/extensions/ms-python.python-2019.3.6558
   RUN cd /home/ubuntu/.local/share/code-server/extensions/ms-python.python-2019.3.6558
   RUN curl -JL https://marketplace.visualstudio.com/_apis/public/gallery/publishers/ms-python/vsextensions/python/2019.3.6558/vspackage | bsdtar -xvf - extension
   
   RUN cd /home/ubuntu/.local/share/code-server/extensions/ms-python.python-2019.3.6558/extension/ && mv * ../
   RUN chown ubuntu:ubuntu /home/ubuntu/.local/share/code-server/
   
   USER ubuntu
   
6. Click Build. After a successful build, you can use this new environment to launch VS Code workspace sessions with the extensions already installed.

​

Install VS Code

1. Add the following to your compute environment Dockerfile instructions:
   USER root
   
   # Install VS Code (we install an older version so the Python extension works)
   RUN curl -fOL https://github.com/cdr/code-server/releases/download/v3.10.2/code-server_3.10.2_amd64.deb && \
       dpkg -i code-server_3.10.2_amd64.deb
   
   # Add a VS Code start script
   RUN mkdir -p /opt/domino/workspaces/vscode && \
       chown -R ubuntu:ubuntu /opt/domino/workspaces/vscode && \
       echo "#!/bin/bash" >> /opt/domino/workspaces/vscode/start && \
       echo "SETTINGS_DIR=${DOMINO_WORKING_DIR}/.vscode" >> /opt/domino/workspaces/vscode/start && \
       echo "FILE=${SETTINGS_DIR}/settings.json" >> /opt/domino/workspaces/vscode/start && \
       echo "# Add a user setting file if it doesn't exist. Add in DOMINO_WORKING_DIR so it persists across sessions" >> /opt/domino/workspaces/vscode/start && \
       echo "if [ ! -f "$FILE" ]; then" >> /opt/domino/workspaces/vscode/start && \
       echo "sudo mkdir -p "${FILE%/*}"" >> /opt/domino/workspaces/vscode/start && \
       echo "sudo chown -R ubuntu:ubuntu ${SETTINGS_DIR}" >> /opt/domino/workspaces/vscode/start && \
       echo "printf "{" >> /opt/domino/workspaces/vscode/start && \
       echo "  \"extensions.autoUpdate\": false," >> /opt/domino/workspaces/vscode/start && \
       echo "  \"extensions.autoCheckUpdates\": false," >> /opt/domino/workspaces/vscode/start && \
       echo "  \"python.pythonPath\": \"$(which python)\"," >> /opt/domino/workspaces/vscode/start && \
       echo "  \"workbench.startupEditor\": \"none\"," >> /opt/domino/workspaces/vscode/start && \
       echo "  \"workbench.colorTheme\": \"Default Dark+\"" >> /opt/domino/workspaces/vscode/start && \
       echo "}" > ${FILE}" >> /opt/domino/workspaces/vscode/start && \
       echo "fi" >> /opt/domino/workspaces/vscode/start && \
       echo "code-server ${DOMINO_WORKING_DIR} --user-data-dir ${SETTINGS_DIR} --auth none --bind-addr 0.0.0.0:8888 --extensions-dir ${HOME}/.local/share/code-server/extensions --disable-telemetry" >> /opt/domino/workspaces/vscode/start && \
       chmod +x /opt/domino/workspaces/vscode/start
   
   USER ubuntu
   
2. Add the following to your compute environment’s Pluggable Workspace Tools:
   vscode:
      title: "vscode"
      iconUrl: "https://raw.github.com/dominodatalab/workspace-configs/develop/workspace-logos/vscode.svg?sanitize=true"
      start: [ "/opt/domino/workspaces/vscode/start" ]
      httpProxy:
         port: 8888
         requireSubdomain: false