COMP6255 (Advanced Programming Language Concepts) Devcontainer

Docker container for the COMP6255 module. The container can be used for any development via Visual Studio Code. The container configuration will automatically install the necessary extensions and configure editor settings.

Setup

1. Install Docker. I highly recommend Orbstack for MacOS users as it currently uses fewer resources.
2. Make sure Docker/Orbstack is running
3. Install Visual Studio Code
4. Install Dev Containers extension
5. Copy the .devcontainer folder to the root of your project folder

After following the above instructions open your project in Visual Studio Code and run the Dev Containers: Reopen in Container command. If the instructions are followed correctly Visual Studio Code should also automatically suggest opening the repository in container mode when the project is loaded.

System requirements

See here

Known problems

VSCode shows Docker returned an error

Make sure that Docker is installed and running.

The Dev Containers: Reopen in Container command is not recoqnized by VSCode

You need to have the Remote - Containers extension VSCode extension installed and enabled. See here for instructions on how to install it.

Running Dev Containers: Reopen in Container cannot find container

Make sure you copied the .devcontainer folder to your projects root folder and that it includes the devcontainer.json file.

Cannot find a physical path bound to logical path X with prefix Y when importing file

• Make sure that the Coq files have been compiled. Run make to compile the project files.
• If the _CoqProject files is not located in the project root folder you need to either
  • Move the files to the root project folder
  • Or add the line "coq.coqProjectRoot": "PATH_TO_COQPROJECT" (in .devcontainer/devcontainer.json to point to the directory where _CoqProject is located. Restarting the docker container is required after this step.

FAQ

What is included in the Docker image?

The Docker image used for the devcontainer is built using the Dockerfile in this repository and hosted on the GitHub Container registry. It is based on the coqorg/coq:8.17.1-ocaml-4.14.1-flambda image, which includes the following:

• Debian 11 Slim
• opam 2.1.3
• OCaml 4.14.1
• Coq 8.17.1

Credits

Inspired by:

• https://github.com/bcpierce00/au-fsv23/
• https://docs.github.com/en/actions/publishing-packages/publishing-docker-images#publishing-images-to-github-packages