Enable VSCode debugger (#494)

This change saves settings and instructions for easily using the
built-in VSCode node.js debugger to step through and break on a running
local instance of eng-pipes.

.gitignore

@@ -11,6 +11,7 @@ lib
 
 # IDE Settings
 .idea/
+.vscode/bookmarks.json
 
 .yarn/*
 !.yarn/cache

.vscode/launch.json

@@ -0,0 +1,24 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Build and debug eng-pipes via Yarn",
+      "type": "node",
+      "request": "launch",
+      "cwd": "${workspaceFolder}",
+      "envFile": "${workspaceFolder}/.env",
+      "outFiles": ["${workspaceFolder}/lib/**/*.js"],
+      "preLaunchTask": "Build eng-pipes",
+      "runtimeArgs": ["inspect"],
+      "runtimeExecutable": "yarn",
+      "skipFiles": [
+        "<node_internals>/**",
+        "**/node_modules/**",
+        "**/.node/corepack/yarn/**"
+      ],
+    }
+  ]
+}

.vscode/settings.json

@@ -1,17 +1,19 @@
 {
-  "search.exclude": {
-    "**/.yarn": true,
-    "**/.pnp.*": true
-  },
-  "eslint.nodePath": ".yarn/sdks",
-  "prettier.prettierPath": ".yarn/sdks/prettier/index.js",
-  "typescript.tsdk": ".yarn/sdks/typescript/lib",
-  "typescript.enablePromptUseWorkspaceTsdk": true,
   "cSpell.words": [
     "authtoken",
     "direnv",
     "getsentry",
     "pbcopy",
     "NGROK",
-  ]
+  ],
+  "eslint.nodePath": ".yarn/sdks",
+  "prettier.prettierPath": ".yarn/sdks/prettier/index.js",
+  "search.exclude": {
+    "**/.yarn": true,
+    "**/.pnp.*": true
+  },
+  "typescript.tsdk": ".yarn/sdks/typescript/lib",
+  "typescript.enablePromptUseWorkspaceTsdk": true,
+  "terminal.integrated.shellArgs.linux": ["-l"],
+  "terminal.integrated.shellArgs.osx": ["-l"],
 }

.vscode/tasks.json

@@ -0,0 +1,22 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Build eng-pipes",
+            "type": "shell",
+            "command": "yarn build",
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            },
+            "presentation": {
+                "reveal": "silent",
+                "panel": "shared"
+            },
+            "problemMatcher": []
+        }
+    ]
+  }
+

README.md

@@ -160,6 +160,15 @@ ngrok http 3000 --domain your-fun-unique-subdomain.ngrok.io
 
 - If BigQuery is producing a bunch of logspam for you, try adding `DRY_RUN=1` to your `.env` file.
 
+- If you open this project in VSCode, you can attach the built-in debugger to a running server.
+  Rather than using `yarn dev` from the command line, instead open VSCode and select `Debug: Start Debugging` from the command palette:
+
+![startup](/docs/debugger_startup.png 'Start the debugger')
+
+You should hit any breakpoints you set in the code:
+
+![running](/docs/debugger_running.png 'Running debugger paused in the main function')
+
 ## Development & tests
 
 Follow the steps in the '''Setup''' section before running these steps:

package.json

@@ -20,6 +20,8 @@
     "deploy": "yarn build && (yarn deploy:development-metrics)",
     "deploy:development-metrics": "./bin/deploy.sh",
     "dev": "yarn clean && NODE_ENV=development nodemon --ignore '*.test.ts' --watch src/ -e ts --exec \"yarn start:clean\"",
+    "inspect:clean": "yarn build && yarn inspect",
+    "inspect": "NODE_ENV=development node --inspect --async-stack-traces ./lib/index.js",
     "migrate": "yarn knex --knexfile ./src/knexfile.ts",
     "start:clean": "yarn build && yarn start",
     "start": "node --async-stack-traces ./lib/index.js",

tsconfig.build.json

@@ -6,6 +6,6 @@
   "compilerOptions": {
     "sourceMap": true,
     "inlineSources": true,
-    "sourceRoot": "/"
+    "sourceRoot": "../src/",
   }
 }