-
Notifications
You must be signed in to change notification settings - Fork 17
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
fix(javascript): keep comments and jsdoc in build #307
Conversation
✅ Deploy Preview for api-clients-automation canceled.
|
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
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.
looks good, This PR should possibly be linked from an issue on typescript mentioning that the comments get removed even though they shouldn't?
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 think it makes sense. But as Haroen mentioned, do you have a link to the GH issue in TS? It'd be good to tag the issue in this PR, so that we can have a reference to update it in the future when TS rolls out the fix.
I did not had time to open the GH issue yet, will check their open ones and open it if it does not exists |
I've created an issue @eunjae-lee @Haroenv microsoft/TypeScript#48495 If you have changes to propose to it, lmk! |
algolia/api-clients-automation#307 Co-authored-by: Clément Vannicatte <[email protected]>
🧭 What and Why
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-400
Changes included:
Comments and JSDoc were removed in the build, which makes the autocompletion poorer.
Comments
This was just an option to change in the
tsconfig.json
. There's a huge impact on the size of the common package, but types needs to be checked due to many duplicates, so it's fine in the meantime.JSDoc
TS Playground for reproduction
At build time, methods returned in an object loses JSDoc, but does not when inlined in the object. I've went with this solution for now as it's the one if the smallest footprint but alternatives are:
Opened an issue on TypeScript: microsoft/TypeScript#48495
🧪 Test
CI :D