docs: ensure referenced types are included in typedoc site (#2960)

electron · Oct 13, 2022 · e22e5b2 · e22e5b2
1 parent 827c3ea
commit e22e5b2
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -144,6 +144,7 @@
     "sinon-chai": "^3.6.0",
     "ts-node": "^10.0.0",
     "typedoc": "^0.22.15",
+    "typedoc-plugin-missing-exports": "^1.0.0",
     "typedoc-plugin-rename-defaults": "^0.6.4",
     "typescript": "^4.6.3",
     "xvfb-maybe": "^0.2.1"

diff --git a/tools/gen-docs.ts b/tools/gen-docs.ts
@@ -13,7 +13,8 @@ import * as typedoc from 'typedoc';
     excludePrivate: true,
     excludeProtected: true,
     hideGenerator: true,
-    plugin: ['typedoc-plugin-rename-defaults'],
+    externalPattern: ['**/node_modules/@types/node/**'],
+    plugin: ['typedoc-plugin-rename-defaults', 'typedoc-plugin-missing-exports'],
   });
 
   const projReflection = typedocApp.convert();

diff --git a/yarn.lock b/yarn.lock
@@ -9084,6 +9084,11 @@ typedarray-to-buffer@^3.1.5:
   dependencies:
     is-typedarray "^1.0.0"
 
+typedoc-plugin-missing-exports@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/typedoc-plugin-missing-exports/-/typedoc-plugin-missing-exports-1.0.0.tgz#7212a2cfaba7b48264df4b4110f3a5684b5c49a1"
+  integrity sha512-7s6znXnuAj1eD9KYPyzVzR1lBF5nwAY8IKccP5sdoO9crG4lpd16RoFpLsh2PccJM+I2NASpr0+/NMka6ThwVA==
+
 typedoc-plugin-rename-defaults@^0.6.4:
   version "0.6.4"
   resolved "https://registry.yarnpkg.com/typedoc-plugin-rename-defaults/-/typedoc-plugin-rename-defaults-0.6.4.tgz#8019bbfdbb4616682a0af8ecf1e8f42d053d4a40"