Skip to content

Decouple converter for stand-alone use #439

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
wants to merge 2 commits into from

Conversation

bryanforbes
Copy link

This is part of the work for #378. Right now, lib/converter/converter.ts uses a "component" architecture via decorators to register handlers to convert from the TypeScript compiler's representation of the code to typedoc's reflections. This architecture is very difficult to follow and know for sure how everything works together and directly couples the converter to the Application and Options classes. This pull request simplifies the converter by removing the concept of "components", eschews the use of decorators, and changes the constructor to accept an options object.

@blakeembrey
Copy link
Member

I would love to merge this if we can get an additional set of eyes. Aside from that, my only question is - do you want to delete that commented out code instead?

@bryanforbes
Copy link
Author

Not to put a damper on this, but I made some discoveries in the TypeScript APIs today and I'm looking into a way to simplify the converter more than what I've done here. I should have a proof of concept tomorrow.

@dupski
Copy link

dupski commented Feb 25, 2018

Was there ever any update on this @bryanforbes ? Would be great to get it merged, TypeDoc is awesome, but is real hard to hack on currently, partially due to this stuff :)

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

Successfully merging this pull request may close these issues.

5 participants