Add devcontainer (#279)

.devcontainer/devcontainer.json

@@ -0,0 +1,73 @@
+{
+  "name": "Spook development environment",
+  "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
+  "features": {
+    "ghcr.io/devcontainers/features/github-cli:1": {
+      "installDirectlyFromGitHubRelease": true,
+      "version": "latest"
+    },
+    "ghcr.io/devcontainers/features/node:1": {
+      "nodeGypDependencies": true,
+      "version": "lts"
+    },
+    "ghcr.io/devcontainers-contrib/features/poetry:2": {
+      "version": "latest"
+    }
+  },
+  "forwardPorts": [8123, 3000],
+  "portsAttributes": {
+    "8123": {
+      "label": "Home Assistant",
+      "onAutoForward": "openBrowserOnce"
+    },
+    "3000": {
+      "label": "Documentation",
+      "onAutoForward": "openBrowserOnce"
+    },
+    "3100": {
+      "label": "Documentation (live updates)",
+      "autoForward": "silent"
+    }
+  },
+  "postCreateCommand": "mkdir -p config && poetry config virtualenvs.in-project true && npm install -g mystmd && poetry install",
+  "updateContentCommand": "poetry config virtualenvs.in-project true && poetry install",
+  "containerEnv": {
+    "DEVCONTAINER": "1"
+  },
+  "remoteUser": "vscode",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.vscode-pylance",
+        "ms-python.python",
+        "redhat.vscode-yaml",
+        "esbenp.prettier-vscode",
+        "GitHub.vscode-pull-request-github",
+        "GitHub.copilot",
+        "GitHub.vscode-github-actions",
+        "yzhang.markdown-all-in-one"
+      ],
+      "settings": {
+        "python.pythonPath": "/usr/local/bin/python",
+        "editor.formatOnPaste": false,
+        "editor.formatOnSave": true,
+        "editor.formatOnType": true,
+        "files.trimTrailingWhitespace": true,
+        "terminal.integrated.profiles.linux": {
+          "zsh": {
+            "path": "/usr/bin/zsh"
+          }
+        },
+        "terminal.integrated.defaultProfile.linux": "zsh",
+        "yaml.customTags": [
+          "!input scalar",
+          "!secret scalar",
+          "!include_dir_named scalar",
+          "!include_dir_list scalar",
+          "!include_dir_merge_list scalar",
+          "!include_dir_merge_named scalar"
+        ]
+      }
+    }
+  }
+}

.gitignore

@@ -95,7 +95,7 @@ ENV/
 .ruff_cache
 
 # Visual Studio Code
-.vscode
+.vscode/*
 
 # IntelliJ Idea family of suites
 .idea
@@ -124,3 +124,8 @@ node_modules/
 # Mystjs
 .ipynb_checkpoints
 _build
+
+# Devcontainer
+config
+!.vscode/tasks.json
+!.vscode/launch.json

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Home Assistant with Spook",
+      "type": "python",
+      "request": "launch",
+      "python": "${workspaceFolder}/.venv/bin/python",
+      "module": "homeassistant",
+      "cwd": "${workspaceFolder}",
+      "justMyCode": false,
+      "args": ["--debug", "-c", "config"]
+    }
+  ]
+}

.vscode/tasks.json

@@ -0,0 +1,15 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Preview documentation",
+      "type": "shell",
+      "command": "cd documentation && myst start",
+      "problemMatcher": [],
+      "presentation": {
+        "reveal": "always",
+        "panel": "new"
+      }
+    }
+  ]
+}