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

[Feature]: Support entryPointStrategy option of TypeDoc plugin #1720

Closed
kalisjoshua opened this issue Dec 27, 2024 · 2 comments
Closed

[Feature]: Support entryPointStrategy option of TypeDoc plugin #1720

kalisjoshua opened this issue Dec 27, 2024 · 2 comments

Comments

@kalisjoshua
Copy link

What problem does this feature solve?

Support for [entryPointStrategy](https://typedoc.org/documents/Options.Input.html#entrypointstrategy) option of TypeDoc.

What does the proposed API look like?

Extend the interface to support the additional option:

export declare interface PluginTypeDocOptions {
    // ...
    entryPointStrategy: 'resolve' | 'expand' | 'package' | 'merge',
    // ...
}

Then pass that through to TypeDoc.

Would that create more problems downstream?

@Timeless0911 Timeless0911 changed the title [Feature]: [Feature]: Support entryPointStrategy option of TypeDoc plugin Dec 30, 2024
@Timeless0911
Copy link
Contributor

There should be no problem I think, PR is welcome and you can add e2e tests to ensure it.

@kalisjoshua
Copy link
Author

I get the feeling like the tests are going to reveal some extensive needs for this; maybe I am wrong. At this time I think we are going to attempt to use the TypeDoc output instead of this plugin and see if that gets us farther than with the plugin for the required effort #ROI.

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