typedoc-plugin-missing-exports - npm Package Compare versions

Comparing version 0.22.3 to 0.22.4

index.js

@@ -44,3 +44,5 @@ "use strict";
             for (const s of missing) {
-                internalContext.converter.convertSymbol(internalContext, s);
+                if (shouldConvertSymbol(s, context.checker)) {
+                    internalContext.converter.convertSymbol(internalContext, s);
+                }
                 tried.add(s);
@@ -130,2 +132,13 @@ }
 exports.discoverMissingExports = discoverMissingExports;
+function shouldConvertSymbol(symbol, checker) {
+    while (symbol.flags & typedoc_1.TypeScript.SymbolFlags.Alias) {
+        symbol = checker.getAliasedSymbol(symbol);
+    }
+    // We're looking at an unknown symbol which is declared in some package without
+    // type declarations. We know nothing about it, so don't convert it.
+    if (symbol.name === "unknown" && symbol.flags & typedoc_1.TypeScript.SymbolFlags.Transient) {
+        return false;
+    }
+    return true;
+}
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "typedoc-plugin-missing-exports",
-  "version": "0.22.3",
+  "version": "0.22.4",
   "description": "Include non-exported types in TypeDoc documentation",
@@ -5,0 +5,0 @@ "main": "./index.js",

README.md

 # typedoc-plugin-missing-exports
 
-> Supports TypeDoc 0.22.x.
+Automatically document symbols which aren't exported but are referenced.
 
+> Supports TypeDoc 0.22.x
+
 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.
@@ -6,0 +8,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10361

increased by6.51%

Lines of code

166

increased by8.5%

Number of lines in readme file

20

increased by11.11%

No dependency changes