Merge pull request #96 from gadget-inc/devcontainer

Add a nixified devcontainer setup for codespaces

Author: airhorns

.devcontainer/Dockerfile

@@ -0,0 +1,43 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.202.1/containers/debian/.devcontainer/base.Dockerfile
+
+# [Choice] Debian version (use bullseye or stretch on local arm64/Apple Silicon): bullseye, buster, stretch
+ARG VARIANT="buster"
+FROM mcr.microsoft.com/vscode/devcontainers/base:0-${VARIANT}
+
+# use bash to run commands in the dockerfile so we can easily source the nix environment
+SHELL ["/bin/bash", "-c"]
+
+# install dependencies nix needs to install itself
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+  && apt-get -y install --no-install-recommends xz-utils acl
+
+# set up chsh to allow passwordless shell changing
+RUN sed -i 's/required/sufficient/' /etc/pam.d/chsh
+
+# setup the default vscode user that codespaces uses as a passwordless sudoer
+RUN usermod -aG sudo vscode && echo "vscode   ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers
+USER vscode
+ENV USER=vscode
+
+# Install nix (requires non-root user)
+RUN curl -L https://nixos.org/nix/install | sh -s -- --no-daemon && \
+  echo 'source ~/.nix-profile/etc/profile.d/nix.sh' >> ~/.bashrc
+
+# Enable required Nix experimental features & pin the nixpkgs flake
+ENV NIXPKGS_COMMIT=ec750fd01963ab6b20ee1f0cb488754e8036d89d
+RUN source ~/.nix-profile/etc/profile.d/nix.sh && \
+  nix-env -f https://github.com/NixOS/nixpkgs/archive/$NIXPKGS_COMMIT.tar.gz -iA nix && \
+  mkdir -p ~/.config/nix && \
+  echo 'experimental-features = nix-command flakes' >> ~/.config/nix/nix.conf && \
+  nix registry pin nixpkgs github:NixOS/nixpkgs/$NIXPKGS_COMMIT
+
+# Install & setup direnv
+RUN source ~/.nix-profile/etc/profile.d/nix.sh && \
+  nix profile install nixpkgs#direnv nixpkgs#nix-direnv && \
+  echo 'eval "$(direnv hook bash)"' >> ~/.bashrc && \
+  echo 'source ~/.nix-profile/share/nix-direnv/direnvrc' >> ~/.direnvrc
+
+# Install docker and setup buildx as default docker builder
+RUN source ~/.nix-profile/etc/profile.d/nix.sh && \
+  nix profile install nixpkgs#docker && \
+  docker buildx install

.devcontainer/bootstrap.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+# source the nix environment
+source /home/vscode/.nix-profile/etc/profile.d/nix.sh
+
+set -euox pipefail
+
+# fixes nix builds within github codespaces, see https://github.com/xtruder/nix-devcontainer/issues/12
+sudo setfacl --remove-default  /tmp
+
+sudo locale-gen en_US.UTF-8
+
+# Pre-load development environment
+direnv allow
+nix print-dev-env > /dev/null

.devcontainer/devcontainer.json

@@ -0,0 +1,37 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.202.1/containers/debian
+{
+  "name": "Debian",
+  "runArgs": ["--init"],
+  "build": {
+    "dockerfile": "Dockerfile",
+    // Update 'VARIANT' to pick an Debian version: bullseye, buster, stretch
+    // Use bullseye or stretch on local arm64/Apple Silicon.
+    "args": { "VARIANT": "bullseye" }
+  },
+
+  // Set *default* container specific settings.json values on container create.
+  "settings": {},
+
+  // Add the IDs of extensions you want installed when the container is created.
+  "extensions": [],
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  "forwardPorts": [
+    "3000", // the app
+    "9000", // webpack-dev-server
+    "5432" // postgres
+  ],
+
+  // Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker.
+  "mounts": ["source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind"],
+
+  // Uncomment when using a ptrace-based debugger like C++, Go, and Rust
+  // "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ],
+
+  // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+  "remoteUser": "vscode",
+
+  // setup nix which we need the source tree for, which only is available after building the devcontainer
+  "postCreateCommand": ".devcontainer/bootstrap.sh"
+}

.gitignore

@@ -5,4 +5,5 @@ yarn.lock
 vscode-profile*
 isolate-*
 flamegraph.html
-*.perf
+*.perf
+.vscode/settings.json