Skip to content

Latest commit

 

History

History
66 lines (39 loc) · 2.9 KB

README.md

File metadata and controls

66 lines (39 loc) · 2.9 KB
Raw

Theia with Rust support

Building the image

cd [this repo]/theia-rust-docker
make image

By default Rust channel "nightly-2019-07-19" is used (it contains a.o. the required rls component). You can specify which Rust channel is used. Eg.

cd [this repo]/theia-rust-docker
RUST_CHANNEL=nightly make image

The 'image' target makes use of the Docker cache to speedup building. It's possible to build the image from scratch:

cd [this repo]/theia-rust-docker
make clean-image

Start Theia

  1. cd to a folder in your home dir.

eg. cd to the example_workspace folder.

  1. Start editor
[path to theia-apps]/theia-rust-docker/ex_theia

This creates a container and mounts your home dir. It creates a user inside the container with matching UID/GID so that you can edit files without corrupting permissions. A volume rust-cargo-vol is created in which the rust environment is stored. This will allow you to persistently install crates etc. across container life cycles.

Bash inside the container

  1. Start a bash within the container
[path to theia-apps]/theia-rust-docker/ex_bash
  1. Run a single command in the container

You can run a single command in side the container:

[path to theia-apps]/theia-rust-docker/ex_bash "...command..."

eg.

ex_bash "cargo --list"

Persistent changes of Rust environment

When the container is started a named Docker volume is created. This volume stores the Rustup and Cargo folders. You can install libraries etc., these changes will be kept even if you delete your container. If you mess up the Rust environment you can reset the environment by issueing:

docker volume rm rust-cargo-vol

Example project

A very simple rust example project is included in the example_project folder. It contains a build task and debug configuration which uses rust-gdb.

How does it work?

The ex* scripts check if a container exists and if so reuses it. If not, the container is created including a named volume (rust-cargo-vol) to store persistent changes to the Rust environment. A command is ran inside the container to create a user corresponding to the user calling the ex script. This user has its umask set to 002 and is added to "rust" group so that the user has write access to the cargo folder (mounted from the named volume). If ex_theia is ran, the bashrc script is sourced after which the run.sh script is ran inside the container. The bashrc script changes the dir to the same location from which the ex script was ran (via the CONTAINER_START_PATH environment variable). This is done only if the current path is within the users mounted HOME dir. Next the bashrc script sources nvm_setup.sh which activates a specific node version and adds yarn to the path. Lastly it sets up the rust build environment through RUSTUP_HOME and CARGO_HOME. Once the environment is sourced the run.sh script can actually start Theia.