introduce devcontainers (#29)

* chore: introduce devcontainers

This brings in an emscripten environment for all developers, without having to install it manually

---------

Co-authored-by: James Lan <[email protected]>

Author: fennibay

.devcontainer/Dockerfile

@@ -0,0 +1,21 @@
+FROM mcr.microsoft.com/devcontainers/typescript-node:1-20-bookworm
+
+ARG EMSDK_DIR=/emsdk
+
+RUN apt-get update -y && \
+    apt-get -y install --no-install-recommends \
+        curl \
+        ca-certificates \
+        zip \
+        unzip \
+        xz-utils \
+        bzip2 \
+        sed \
+        git-core \
+        python3
+
+RUN git clone --depth 1 -- https://github.com/emscripten-core/emsdk.git $EMSDK_DIR && \
+    cd $EMSDK_DIR && \
+    ./emsdk install latest && \
+    ./emsdk activate latest && \
+    echo ". $EMSDK_DIR/emsdk_env.sh" >> /etc/bash.bashrc

.devcontainer/devcontainer.json

@@ -0,0 +1,30 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
+{
+	"name": "libxml2-wasm development environment",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"build": {
+		"dockerfile": "Dockerfile"
+	},
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "yarn install",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+
+	"runArgs": [
+		"--userns=keep-id"
+	],
+	"containerEnv": {
+		"HOME": "/home/node"
+	}
+}

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "ms-vscode-remote.remote-containers"
+    ]
+}

README.md

@@ -36,7 +36,7 @@ it requires the minimum version of the following environments,
 
 ## Getting started
 
-Install `lbixml2-wasm` package:
+Install `libxml2-wasm` package:
 
 ```shell
 npm i libxml2-wasm
@@ -77,3 +77,9 @@ For more detail, see the [Doc](https://jameslan.github.io/libxml2-wasm/index.htm
 
 [^1]: The speed of different libraries varies a lot, see [benchmark](performance.md).
 [^2]: The requirement of C/C++ toolchain may be waived if prebuilt binary is available.
+
+## Development environment
+
+If you'd like to contribute to `libxml2-wasm`, you need a [Node.js](https://nodejs.org/) (version 16 or newer) and an [emscripten](https://emscripten.org/) installation in your environment.
+
+Alternatively, you can use the provided devcontainer. Then you only need a Docker or Podman environment, and VS Code with the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension. Then you can just run the command "Dev Containers: Reopen in Container" which will provide you a container with the needed development environment. See <https://containers.dev/> for further info.