Skip to content

Exclude pattern with negation prevents doc generation for named export #2937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
softdays opened this issue Apr 15, 2025 · 1 comment
Closed
Milestone

Comments

@softdays
Copy link

Search terms

exclude, glob negation, named export

Expected Behavior

Using exclude option involving a glob negation pattern should generate documentation for named exports.

Actual Behavior

Using this script :

typedoc --html api-doc --entryPoints src/public-api.ts --exclude '!**/foo.ts'"

and this public-api.ts entry point:

export * from './bar';
export * from './baz';
export { Foo } from './foo';

Documentation not generated for Foo

Steps to reproduce the bug

Environment

  • Typedoc version: 0.28.1
  • TypeScript version: 5.7.2
  • Node.js version: v20.19.0
  • OS: WebContainers (Stackblitz)
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 19, 2025

Named exports introduce a new symbol, so TypeDoc's exclude check checks based on public-api.ts rather than the original symbol... it seems reasonable to me to resolve aliased symbols before performing this check.

@Gerrit0 Gerrit0 added this to the v0.28.3 milestone Apr 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants