chore(hub): provide VS Code config

dunglas · Aug 12, 2022 · 4bd2ce5 · 4bd2ce5
1 parent e16de2e
commit 4bd2ce5
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 23 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@ __pycache__
 dist
 /caddy/caddy
 /caddy/mercure/mercure
+/caddy/mercure/__debug_bin
 /cmd/mercure/mercure
 /certs
 /spec/mercure.html

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,18 @@
+{
+   "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch the hub",
+            "type": "go",
+            "request": "launch",
+            "mode": "auto",
+            "program": "${workspaceFolder}/caddy/mercure",
+            "env": {
+                "MERCURE_PUBLISHER_JWT_KEY": "!ChangeMe!",
+                "MERCURE_SUBSCRIBER_JWT_KEY": "!ChangeMe!",
+                "MERCURE_EXTRA_DIRECTIVES": "anonymous"
+            },
+            "args": ["run", "-config", "../../Caddyfile.dev"]
+        }
+    ]
+}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -67,29 +67,10 @@ When you send a PR, make sure that:
 * You make the PR on the same branch you based your changes on. If you see commits
   that you did not make in your PR, you're doing it wrong.
 
-### Configuring VSCode
-
-`.vscode/launch.json`:
-
-```json
-{
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Launch the hub",
-            "type": "go",
-            "request": "launch",
-            "mode": "auto",
-            "program": "${workspaceFolder}",
-            "env": {
-                "MERCURE_PUBLISHER_JWT_KEY": "!ChangeMe!",
-                "MERCURE_SUBSCRIBER_JWT_KEY": "!ChangeMe!"
-            },
-            "args": ["run", "-config", "Caddyfile.dev"]
-        }
-    ]
-}
-```
+### Configuring Visual Studio Code
+
+A configuration for VSCode is provided in the `.vscode/` directory of the repository.
+It is automatically loaded by VS Code.           
 
 ### Finding Deadlocks