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

entryPoints with wildcards #24

Open
sambugj opened this issue Nov 2, 2022 · 2 comments
Open

entryPoints with wildcards #24

sambugj opened this issue Nov 2, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@sambugj
Copy link

sambugj commented Nov 2, 2022

The entryPoints option is a list of the source files paths to document (now is a relative path to the file).
We need to configure the entryPoints with a patterns using wildcards to find files in the folder recursively.
Example:

"tsdocsOptions": {
    "entryPoints": ["./entry/point/*", "./entry/point2/*.ts", "./entry/point/**/*.ts"],
}

Do you have any workaround?

@sambugj sambugj added the enhancement New feature or request label Nov 2, 2022
@GoogleFeud
Copy link
Member

GoogleFeud commented Nov 3, 2022

The entryPoints option should be an array pointing to files in different npm packages/projects. Every export inside the file is going to be documented, as well as all exports from the file the export is coming from, so if you want to document all exports in a file, you could do the following:

export * from "./file";

If you're writing an application and not a library, you can turn on documentImports option which also goes through all imported files!

Hope that helps!

@sambugj
Copy link
Author

sambugj commented Nov 3, 2022

Thanks for your recommendation! :)

Could you mention that on the entryPoints documentation?. I think will be useful because both options work together.

On another hand that configuration is not efficient, I need to configure too many entry points to document all and when I add a new file .ts I'm forced to add it to the entryPoints array :(

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants