Skip to content

RFC: Improving plugin developer experience #1325

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
1 of 2 tasks
Gerrit0 opened this issue Jun 28, 2020 · 2 comments
Closed
1 of 2 tasks

RFC: Improving plugin developer experience #1325

Gerrit0 opened this issue Jun 28, 2020 · 2 comments
Labels
discussion Discussion on large effort changes to TypeDoc

Comments

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 28, 2020

While TypeDoc technically supports plugins, it isn't very friendly right now to develop a plugin for... even ignoring the lack of documentation. What would be helpful when developing plugins? Lets make a list.

  • Export all necessary items from the main entry point. Plugins should never need to import from typedoc/dist/....
  • Transformer API - It would be really useful to have something like TS has for rewriting types rather than implementing logic to iterate over all types in all reflections example

What else is missing?

@Gerrit0 Gerrit0 added the discussion Discussion on large effort changes to TypeDoc label Jun 28, 2020
@Gerrit0
Copy link
Collaborator Author

Gerrit0 commented Oct 17, 2020

@Gerrit0
Copy link
Collaborator Author

Gerrit0 commented Jan 22, 2021

A way to replace all references pointing to some reflection/symbol with another type - ideally should be covered by 2 above.

@Gerrit0 Gerrit0 closed this as completed Apr 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Discussion on large effort changes to TypeDoc
Projects
None yet
Development

No branches or pull requests

1 participant