typedoc-plugin-missing-exports
Advanced tools
Comparing version 0.22.6 to 0.23.0
32
index.js
@@ -21,3 +21,2 @@ "use strict"; | ||
function onResolveBegin(knownPrograms, context) { | ||
var _a; | ||
const modules = context.project.getChildrenByKind(typedoc_1.ReflectionKind.Module); | ||
@@ -37,3 +36,3 @@ if (modules.length === 0) { | ||
.createDeclarationReflection(typedoc_1.ReflectionKind.Namespace, void 0, void 0, context.converter.application.options.getValue("internalNamespace")); | ||
context.finalizeDeclarationReflection(internalNs, void 0); | ||
context.finalizeDeclarationReflection(internalNs); | ||
const internalContext = context.withScope(internalNs); | ||
@@ -57,3 +56,3 @@ // Keep track of which symbols we've tried to convert. If they don't get converted | ||
// All the missing symbols were excluded, so get rid of our namespace. | ||
if (!((_a = internalNs.children) === null || _a === void 0 ? void 0 : _a.length)) { | ||
if (!internalNs.children?.length) { | ||
context.project.removeReflection(internalNs); | ||
@@ -66,3 +65,2 @@ } | ||
function discoverMissingExports(root) { | ||
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o; | ||
const missing = new Set(); | ||
@@ -102,3 +100,3 @@ const queue = []; | ||
if (current instanceof typedoc_1.DeclarationReflection) { | ||
(_a = current.type) === null || _a === void 0 ? void 0 : _a.visit(visitor); | ||
current.type?.visit(visitor); | ||
add(current.typeParameters); | ||
@@ -109,8 +107,8 @@ add(current.signatures); | ||
add(current.setSignature); | ||
(_b = current.overwrites) === null || _b === void 0 ? void 0 : _b.visit(visitor); | ||
(_c = current.inheritedFrom) === null || _c === void 0 ? void 0 : _c.visit(visitor); | ||
(_d = current.implementationOf) === null || _d === void 0 ? void 0 : _d.visit(visitor); | ||
(_e = current.extendedTypes) === null || _e === void 0 ? void 0 : _e.forEach((type) => type.visit(visitor)); | ||
current.overwrites?.visit(visitor); | ||
current.inheritedFrom?.visit(visitor); | ||
current.implementationOf?.visit(visitor); | ||
current.extendedTypes?.forEach((type) => type.visit(visitor)); | ||
// do not validate extendedBy, guaranteed to all be in the documentation. | ||
(_f = current.implementedTypes) === null || _f === void 0 ? void 0 : _f.forEach((type) => type.visit(visitor)); | ||
current.implementedTypes?.forEach((type) => type.visit(visitor)); | ||
// do not validate implementedBy, guaranteed to all be in the documentation. | ||
@@ -121,13 +119,13 @@ } | ||
add(current.typeParameters); | ||
(_g = current.type) === null || _g === void 0 ? void 0 : _g.visit(visitor); | ||
(_h = current.overwrites) === null || _h === void 0 ? void 0 : _h.visit(visitor); | ||
(_j = current.inheritedFrom) === null || _j === void 0 ? void 0 : _j.visit(visitor); | ||
(_k = current.implementationOf) === null || _k === void 0 ? void 0 : _k.visit(visitor); | ||
current.type?.visit(visitor); | ||
current.overwrites?.visit(visitor); | ||
current.inheritedFrom?.visit(visitor); | ||
current.implementationOf?.visit(visitor); | ||
} | ||
if (current instanceof typedoc_1.ParameterReflection) { | ||
(_l = current.type) === null || _l === void 0 ? void 0 : _l.visit(visitor); | ||
current.type?.visit(visitor); | ||
} | ||
if (current instanceof typedoc_1.TypeParameterReflection) { | ||
(_m = current.type) === null || _m === void 0 ? void 0 : _m.visit(visitor); | ||
(_o = current.default) === null || _o === void 0 ? void 0 : _o.visit(visitor); | ||
current.type?.visit(visitor); | ||
current.default?.visit(visitor); | ||
} | ||
@@ -134,0 +132,0 @@ } while ((current = queue.shift())); |
{ | ||
"name": "typedoc-plugin-missing-exports", | ||
"version": "0.22.6", | ||
"version": "0.23.0", | ||
"description": "Include non-exported types in TypeDoc documentation", | ||
@@ -11,6 +11,6 @@ "main": "./index.js", | ||
"@types/node": "^16.11.10", | ||
"ava": "^3.15.0", | ||
"prettier": "^2.4.1", | ||
"typedoc": "^0.22.10", | ||
"typescript": "^4.5.2" | ||
"ava": "^4.3.0", | ||
"prettier": "^2.7.1", | ||
"typedoc": "^0.23.1", | ||
"typescript": "^4.7.4" | ||
}, | ||
@@ -25,6 +25,6 @@ "repository": { | ||
"keywords": [ | ||
"typedocplugin" | ||
"typedoc-plugin" | ||
], | ||
"peerDependencies": { | ||
"typedoc": "0.22.x" | ||
"typedoc": "0.22.x || 0.23.x" | ||
}, | ||
@@ -31,0 +31,0 @@ "scripts": { |
@@ -5,3 +5,3 @@ # typedoc-plugin-missing-exports | ||
> Supports TypeDoc 0.22.x | ||
> Supports TypeDoc 0.22.x and 0.23.x | ||
@@ -14,2 +14,8 @@ TypeDoc 0.20 switched from documenting each file individually to documenting based on entry points. TypeDoc looks at each provided entry point and documents all exports from that entry point. | ||
### Usage | ||
`npm install typedoc-plugin-missing-exports` | ||
TypeDoc will automatically use this plugin when present. | ||
### Options | ||
@@ -16,0 +22,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
6
26
170