Feat: set up devcontainer (#22)

Author: lalver1

.devcontainer/Dockerfile

@@ -0,0 +1,39 @@
+ARG PYTHON_VERSION=3.12
+
+FROM python:${PYTHON_VERSION}
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    USER=caltrans
+
+# create non-root $USER and home directory
+RUN useradd --create-home --shell /bin/bash $USER && \
+    chown -R $USER /home/$USER
+
+# switch to $USER
+USER $USER
+
+# enter src directory
+WORKDIR /home/$USER/src
+
+# update PATH for local pip installs
+ENV PATH="$PATH:/home/$USER/.local/bin"
+
+# upgrade pip
+RUN python -m pip install --upgrade pip
+
+# copy assets
+COPY . .
+
+# install devcontainer requirements
+RUN pip install --no-cache-dir -r .devcontainer/requirements.txt
+
+# install pre-commit environments in throwaway Git repository
+# https://stackoverflow.com/a/68758943
+RUN git init . && \
+    pre-commit install-hooks && \
+    rm -rf .git
+
+CMD sleep infinity
+
+ENTRYPOINT []

.devcontainer/devcontainer.json

@@ -0,0 +1,27 @@
+{
+  "name": "caltrans/pems",
+  "dockerComposeFile": ["../compose.yml"],
+  "service": "dev",
+  "runServices": ["dev"],
+  "workspaceFolder": "/home/caltrans/src",
+  "postAttachCommand": ["/bin/bash", ".devcontainer/postAttach.sh"],
+  "customizations": {
+    "vscode": {
+      // Set *default* container specific settings.json values on container create.
+      "settings": {
+        "terminal.integrated.defaultProfile.linux": "bash",
+        "terminal.integrated.profiles.linux": {
+          "bash": {
+            "path": "/bin/bash"
+          }
+        }
+      },
+      // Add the IDs of extensions you want installed when the container is created.
+      "extensions": [
+        "eamodio.gitlens",
+        "esbenp.prettier-vscode",
+        "mhutchie.git-graph"
+      ]
+    }
+  }
+}

.devcontainer/postAttach.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -eux
+
+# initialize pre-commit
+git config --global --add safe.directory /home/$USER/src
+pre-commit install --overwrite

.devcontainer/requirements.txt

@@ -0,0 +1 @@
+pre-commit

.dockerignore

@@ -0,0 +1 @@
+.git/

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+ci:
+  autofix_commit_msg: "chore(pre-commit): autofix run"
+  autoupdate_commit_msg: "chore(pre-commit): autoupdate hooks"
+
+default_install_hook_types:
+  - pre-commit
+  - commit-msg
+
+repos:
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v3.6.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-yaml
+        args: [--unsafe]
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+      - id: trailing-whitespace

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "files.encoding": "utf8",
+  "files.eol": "\n",
+  "files.insertFinalNewline": true,
+  "files.trimFinalNewlines": true,
+  "files.trimTrailingWhitespace": true
+}

compose.yml

@@ -0,0 +1,10 @@
+name: pems
+
+services:
+  dev:
+    build:
+      context: .
+      dockerfile: .devcontainer/Dockerfile
+    image: caltrans/pems:main
+    volumes:
+      - ./:/home/caltrans/src