Resolve aliased symbols before checking exclusion

Gerrit0 · Gerrit0 · commit 911faff99ce0 · 2025-04-19T17:48:27.000-06:00
Resolves #2937
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@ title: Changelog
 
 - `@inline` now functions when referencing tuple types, #2932.
 - `@link` links to the current page are now rendered, #2934.
+- Aliased symbols (re-exports) are now resolved before checking if they are excluded/external, #2937.
 
 ## v0.28.2 (2025-04-07)
 
diff --git a/src/lib/converter/context.ts b/src/lib/converter/context.ts
@@ -209,7 +209,7 @@ export class Context {
             this.addChild(reflection);
         }
 
-        if (symbol && this.converter.isExternal(symbol)) {
+        if (symbol && this.converter.isExternal(symbol, this.checker)) {
             reflection.setFlag(ReflectionFlag.External);
         }
         if (exportSymbol) {
@@ -276,7 +276,7 @@ export class Context {
     }
 
     shouldIgnore(symbol: ts.Symbol) {
-        return this.converter.shouldIgnore(symbol);
+        return this.converter.shouldIgnore(symbol, this.checker);
     }
 
     /**
diff --git a/src/lib/converter/converter.ts b/src/lib/converter/converter.ts
@@ -61,6 +61,7 @@ import { SourcePlugin } from "./plugins/SourcePlugin.js";
 import { TypePlugin } from "./plugins/TypePlugin.js";
 import { IncludePlugin } from "./plugins/IncludePlugin.js";
 import { MergeModuleWithPlugin } from "./plugins/MergeModuleWithPlugin.js";
+import { resolveAliasedSymbol } from "./utils/symbols.js";
 
 export interface ConverterEvents {
     begin: [Context];
@@ -330,7 +331,13 @@ export class Converter extends AbstractComponent<Application, ConverterEvents> {
         this.resolve(context);
 
         this.trigger(Converter.EVENT_END, context);
-        this._config = undefined;
+
+        // Delete caches of options so that test usage which changes options
+        // doesn't have confusing behavior where tests run in isolation work
+        // but break when run as a batch.
+        delete this._config;
+        delete this.excludeCache;
+        delete this.externalPatternCache;
 
         return project;
     }
@@ -613,12 +620,13 @@ export class Converter extends AbstractComponent<Application, ConverterEvents> {
      * information at this point since comment discovery hasn't happened.
      * @internal
      */
-    shouldIgnore(symbol: ts.Symbol) {
+    shouldIgnore(symbol: ts.Symbol, checker: ts.TypeChecker) {
+        symbol = resolveAliasedSymbol(symbol, checker);
         if (this.isExcluded(symbol)) {
             return true;
         }
 
-        return this.excludeExternals && this.isExternal(symbol);
+        return this.excludeExternals && this.isExternal(symbol, checker);
     }
 
     private isExcluded(symbol: ts.Symbol) {
@@ -631,11 +639,11 @@ export class Converter extends AbstractComponent<Application, ConverterEvents> {
     }
 
     /** @internal */
-    isExternal(symbol: ts.Symbol) {
+    isExternal(symbol: ts.Symbol, checker: ts.TypeChecker) {
         this.externalPatternCache ??= new MinimatchSet(this.externalPattern);
         const cache = this.externalPatternCache;
 
-        const declarations = symbol.getDeclarations();
+        const declarations = resolveAliasedSymbol(symbol, checker).getDeclarations();
 
         // `undefined` has no declarations, if someone does `export default undefined`
         // the symbol ends up as having no declarations (the export symbol does, but
diff --git a/src/lib/converter/symbols.ts b/src/lib/converter/symbols.ts
@@ -23,6 +23,7 @@ import {
 import { convertJsDocAlias, convertJsDocCallback } from "./jsdoc.js";
 import { getHeritageTypes } from "./utils/nodes.js";
 import { removeUndefined } from "./utils/reflections.js";
+import { resolveAliasedSymbol } from "./utils/symbols.js";
 
 const symbolConverters: {
     [K in ts.SymbolFlags]?: (
@@ -105,7 +106,7 @@ assert(
 );
 
 function _convertSymbolNow(context: Context, symbol: ts.Symbol, exportSymbol: ts.Symbol | undefined) {
-    if (context.shouldIgnore(symbol)) {
+    if (context.shouldIgnore(resolveAliasedSymbol(symbol, context.checker))) {
         return;
     }
 
diff --git a/src/test/converter2/issues/gh2937/index.ts b/src/test/converter2/issues/gh2937/index.ts
@@ -0,0 +1,2 @@
+export const excluded = true;
+export { notExcluded } from "./not-excluded.js";
diff --git a/src/test/converter2/issues/gh2937/not-excluded.ts b/src/test/converter2/issues/gh2937/not-excluded.ts
@@ -0,0 +1 @@
+export const notExcluded = true;
diff --git a/src/test/issues.c2.test.ts b/src/test/issues.c2.test.ts
@@ -2122,4 +2122,10 @@ describe("Issue Tests", () => {
         const sig = querySig(project, "doStuff");
         equal(sig.parameters?.[0].type?.toString(), "[start: number, end: number]");
     });
+
+    it("#2937 resolves symbols before checking if they are excluded/external", () => {
+        app.options.setValue("exclude", ["!**/not-excluded.ts"]);
+        const project = convert();
+        equal(project.children?.map(c => c.name), ["notExcluded"]);
+    });
 });

Original file line number	Diff line number	Diff line change
`@@ -209,7 +209,7 @@ export class Context {`
`209`	`209`	`this.addChild(reflection);`
`210`	`210`	`}`
`211`	`211`
`212`		`- if (symbol && this.converter.isExternal(symbol)) {`
	`212`	`+ if (symbol && this.converter.isExternal(symbol, this.checker)) {`
`213`	`213`	`reflection.setFlag(ReflectionFlag.External);`
`214`	`214`	`}`
`215`	`215`	`if (exportSymbol) {`
`@@ -276,7 +276,7 @@ export class Context {`
`276`	`276`	`}`
`277`	`277`
`278`	`278`	`shouldIgnore(symbol: ts.Symbol) {`
`279`		`- return this.converter.shouldIgnore(symbol);`
	`279`	`+ return this.converter.shouldIgnore(symbol, this.checker);`
`280`	`280`	`}`
`281`	`281`
`282`	`282`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export const excluded = true;`
	`2`	`+export { notExcluded } from "./not-excluded.js";`