-
-
Notifications
You must be signed in to change notification settings - Fork 913
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
docs: rewrite api-docs generation using ts-morph #2628
Conversation
I found some broken JSDocs (see diff in this PR), that should be fixed in a separate PR before starting v9.0. |
Looks like I have plenty of time during my travel now, so I'll tackle the jsdocs now. |
Co-authored-by: Shinigami <chrissi92@hotmail.de>
I completed reading
|
✅ Deploy Preview for fakerjs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm still a bit torn on the "process" naming over a simple "get" prefix. Maybe even better, using a factory pattern.
Nevertheless, I think this PR includes a lot of work. We should propably go with the current implementation for now. If we feel discomfort with maintaining the documentation in the future, we can refactor then.
Thats why these will propably be my last comment on this PR, before approving.
Not sure what you are asking for here. Ready for review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would like to unblock this from merge
We can still improve in further iterations 🙂
I merge this slightly early to avoid merge conflicts after the dependency updates. |
This PR replaces the typedoc based api-doc generation with one that uses the typescript AST.
This PR is work in progress, but if you have suggestions please let me know.