Set up a debugging config for plugin

Author: Gerrit0

.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Attach",
+			"port": 9229,
+			"request": "attach",
+			"internalConsoleOptions": "openOnSessionStart",
+			"skipFiles": ["<node_internals>/**"],
+			"type": "node",
+			"sourceMaps": true,
+			"resolveSourceMapLocations": [
+				// "${workspaceFolder}/**",
+				"!**/node_modules/**"
+			],
+			"sourceMapPathOverrides": {
+				"typedoc-plugin-missing-exports://*": "${workspaceFolder}/*"
+			}
+		}
+	]
+}

package.json

@@ -28,6 +28,7 @@
   },
   "scripts": {
     "test": "vitest run test/packages.test.ts",
+    "test:doc": "typedoc --plugin ./index.js --tsconfig ./test/packages",
     "build": "tsc"
   }
 }

scripts/setup_links.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+# Expects to be run from within a package where you want to debug this plugin.
+# Will create a td-missing-exports folder which hardlinks the build of this plugin
+# so that imports of typedoc will use the debug target's version of TypeDoc,
+# while allowing changes to be made/debugged in this repo.
+
+PLUGIN_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &> /dev/null && pwd)
+
+rm -rf td-missing-exports
+mkdir td-missing-exports
+ln -T "$PLUGIN_DIR/../package.json" td-missing-exports/package.json
+ln -T "$PLUGIN_DIR/../index.js" td-missing-exports/index.js
+ln -T "$PLUGIN_DIR/../index.js.map" td-missing-exports/index.js.map
+
+echo "Add ./td-missing-exports/index.js to your plugins configuration for debugging"

tsconfig.json

@@ -9,6 +9,7 @@
 		"noUnusedParameters": true,
 		"strict": true,
 		"sourceMap": true,
+		"sourceRoot": "typedoc-plugin-missing-exports://",
 		"skipLibCheck": true
 	},
 	"include": ["."],