Add dev container (#6962)

* Add devcontainer json

* Add GitHub CLI feature

* Try and create user instead of root.

* Default to bash

* Simplify Dockerfile and devcontainer

* Move opam install to postCreate

* Add ocamllabs.ocaml-platform extension

* Add extensions

* Remove trailing comma

* Add changelog entry

* Add opam env to bashrc

* Update contributing

* Update CONTRIBUTING.md

Co-authored-by: Christoph Knittel <christoph@knittel.cc>

* Update .devcontainer/postCreate.sh

Co-authored-by: Christoph Knittel <christoph@knittel.cc>

---------

Co-authored-by: root <root@nojaf-desktop>
Co-authored-by: Christoph Knittel <christoph@knittel.cc>

Author: 3 people

.devcontainer/Dockerfile

@@ -0,0 +1,10 @@
+FROM mcr.microsoft.com/devcontainers/rust:1-1-bookworm
+LABEL org.opencontainers.image.authors="Christoph Knittel <ck@cca.io>"
+LABEL org.opencontainers.image.description="Docker image for ReScript development."
+
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    && apt-get -y install --no-install-recommends \
+    opam \
+    musl-tools \
+    python-is-python3 \
+    && rm -rf /var/lib/apt/lists/*

.devcontainer/devcontainer.json

@@ -0,0 +1,27 @@
+{
+  "name": "ReScript Compiler",
+  "build": {
+    "context": ".",
+    "dockerfile": "Dockerfile"
+  },
+  "features": {
+    "ghcr.io/devcontainers/features/github-cli:1":{
+      "installDirectlyFromGitHubRelease": true,
+      "version": "latest"
+    },
+    "ghcr.io/devcontainers/features/node:1": {
+      "version":"20"
+    }
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ocamllabs.ocaml-platform",
+        "chenglou92.rescript-vscode",
+        "biomejs.biome",
+        "rust-lang.rust-analyzer"
+      ]
+    }
+  },
+  "postCreateCommand": ".devcontainer/postCreate.sh"
+}

.devcontainer/postCreate.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+# Install dev dependencies from OPAM
+opam init -y --bare --disable-sandboxing
+opam switch create 5.2.0 --packages ocaml-option-static
+opam install . --deps-only -y
+
+# For IDE support, install the OCaml language server
+opam install ocaml-lsp-server -y
+
+# Add OPAM environment setup to shell startup script
+echo 'eval $(opam env)' >> ~/.zshrc
+echo 'eval $(opam env)' >> ~/.bashrc
+
+npm install --ignore-scripts

.vscode/extensions.json

@@ -1,5 +1,10 @@
 {
-  "recommendations": ["biomejs.biome", "chenglou92.rescript-vscode"],
+  "recommendations": [
+    "biomejs.biome",
+    "chenglou92.rescript-vscode",
+    "ocamllabs.ocaml-platform",
+    "rust-lang.rust-analyzer"
+  ],
   "unwantedRecommendations": [
     "dbaeumer.vscode-eslint",
     "esbenp.prettier-vscode"

CHANGELOG.md

@@ -30,6 +30,10 @@
 - Fix incorrect format of function under unary operator. https://github.com/rescript-lang/rescript-compiler/pull/6953
 - Fix incorrect incorrect printing of module binding with signature. https://github.com/rescript-lang/rescript-compiler/pull/6963
 
+#### :house: Internal
+
+- Add dev container. https://github.com/rescript-lang/rescript-compiler/pull/6962
+
 # 12.0.0-alpha.1
 
 #### :rocket: New Feature

CONTRIBUTING.md

@@ -32,7 +32,11 @@ git clone --depth 1 https://github.com/rescript-lang/rescript-compiler.git
 
 This will only consume less than 50MB.
 
-## Install OCaml compiler + dependencies
+## Installation
+
+### A. Manual installation
+
+#### Install OCaml compiler + dependencies
 
 The ReScript compiler compiles with any recent OCaml compiler. We are using `dune` as a build system for easy workflows and proper IDE support.
 
@@ -51,10 +55,18 @@ opam install . --deps-only
 opam install ocaml-lsp-server
 ```
 
-## npm install
+#### npm install
 
 Run `npm install --ignore-scripts`. This will install the npm dependencies required for the build scripts.
 
+### B. Devcontainer
+
+As an alternative to the manual installation, the repository provides a [development container](https://containers.dev/) definition that can be used with [VS Code's Remote Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). Use this to get a stable development environment without having to install anything locally other than VS Code and Docker.
+
+Run the `Dev Containers: Rebuild and Reopen in Container` action to get started.
+
+You can also open this dev container with [GitHub Codespaces](https://github.com/features/codespaces/).
+
 ## Building the Compiler
 
 The compiler binaries themselves can be built directly with dune as follows: