Skip to content
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

Understanding why exclude option never works, and entry point difficulty #2376

Closed
viveleroi opened this issue Aug 27, 2023 · 3 comments
Closed
Labels
bug Functionality does not match expectation

Comments

@viveleroi
Copy link

Search terms

negate exclude

Question

I am trying to understand entry points and exclusions. I assume "entry point" means an index.tsx file that is the root of our application, but we have dynamically loaded routes in a react app so a majority of the app is "linked" but even so, using that individual file produces docs output of nothing but our readme.

I tried uses a glob for entry points instead "entryPoints": ["app/**/*.ts?(x)"], which works, except I cannot get excludes to work despite trying a dozen different things.

I tried negating stuff in the glob in various ways, I tried adding stuff to the exclude array, yet nothing is ever excluded from the output.

For example:

{
  "$schema": "https://typedoc.org/schema.json",
  "entryPoints": ["app/**/*.ts?(x)"],
  "exclude": ["app/**/*(.spec|.stories).tsx"],
  "out": "docs"
}

The .spec.tsx and .stories.tsx files are still in the docs output. I've tried various glob patterns, listing them as separate array entries, etc. No changes.

Am I misunderstanding how this works?

@viveleroi viveleroi added the question Question about functionality label Aug 27, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Sep 4, 2023

This doesn't work because I forgot to handle --exclude when adding support for globs in entry points, sorry about that!

@Gerrit0 Gerrit0 added bug Functionality does not match expectation and removed question Question about functionality labels Sep 4, 2023
@Gerrit0 Gerrit0 closed this as completed in 653b281 Sep 4, 2023
@viveleroi
Copy link
Author

Thanks! Please let me know if you can when this gets released.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Sep 4, 2023

Should be later today, there are a couple issues I'd like to get fixed if I have time, but either way, planning on a release today

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants