From d3f79043ff550188d17f1a8e8ec14cb618372655 Mon Sep 17 00:00:00 2001 From: Denis Davidyuk Date: Sat, 11 Jun 2022 16:46:27 +0400 Subject: [PATCH] docs: add typedoc-plugin-missing-exports to render not exported types --- package-lock.json | 17 +++++++++++++++++ package.json | 1 + typedoc.json | 2 ++ 3 files changed, 20 insertions(+) diff --git a/package-lock.json b/package-lock.json index ab8a4da6f9..1a06c6cdcb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -74,6 +74,7 @@ "standard-version": "^9.3.2", "ts-node": "^10.5.0", "typedoc": "^0.22.17", + "typedoc-plugin-missing-exports": "^0.22.6", "typescript": "^4.5.5", "webpack": "^5.68.0", "webpack-bundle-analyzer": "^4.5.0", @@ -10376,6 +10377,15 @@ "typescript": "4.0.x || 4.1.x || 4.2.x || 4.3.x || 4.4.x || 4.5.x || 4.6.x || 4.7.x" } }, + "node_modules/typedoc-plugin-missing-exports": { + "version": "0.22.6", + "resolved": "https://registry.npmjs.org/typedoc-plugin-missing-exports/-/typedoc-plugin-missing-exports-0.22.6.tgz", + "integrity": "sha512-1uguGQqa+c5f33nWS3v1mm0uAx4Ii1lw4Kx2zQksmYFKNEWTmrmMXbMNBoBg4wu0p4dFCNC7JIWPoRzpNS6pFA==", + "dev": true, + "peerDependencies": { + "typedoc": "0.22.x" + } + }, "node_modules/typedoc/node_modules/brace-expansion": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", @@ -18902,6 +18912,13 @@ } } }, + "typedoc-plugin-missing-exports": { + "version": "0.22.6", + "resolved": "https://registry.npmjs.org/typedoc-plugin-missing-exports/-/typedoc-plugin-missing-exports-0.22.6.tgz", + "integrity": "sha512-1uguGQqa+c5f33nWS3v1mm0uAx4Ii1lw4Kx2zQksmYFKNEWTmrmMXbMNBoBg4wu0p4dFCNC7JIWPoRzpNS6pFA==", + "dev": true, + "requires": {} + }, "typescript": { "version": "4.5.5", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.5.tgz", diff --git a/package.json b/package.json index a1906dcd9a..da2ed25d69 100644 --- a/package.json +++ b/package.json @@ -102,6 +102,7 @@ "standard-version": "^9.3.2", "ts-node": "^10.5.0", "typedoc": "^0.22.17", + "typedoc-plugin-missing-exports": "^0.22.6", "typescript": "^4.5.5", "webpack": "^5.68.0", "webpack-bundle-analyzer": "^4.5.0", diff --git a/typedoc.json b/typedoc.json index 17927d2e24..df76198f3d 100644 --- a/typedoc.json +++ b/typedoc.json @@ -3,5 +3,7 @@ "out": "./docs/api", "excludePrivate": true, "githubPages": false, + "excludeExternals": true, + "treatWarningsAsErrors": true, "readme": "none" }