-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
[track2] should we publish tsdoc-metadata.json #8662
Comments
cc @jeremymeng, @xirzec |
Ok it looks like that the API extractor generating Unfortunately, we are stuck with an older version of the api extractor for now for reasons I do not remember on top of my head so I do not think we will have access to that support anytime soon. Based on this I am gonna go ahead and close this issue and I recommend to take no action at this time. |
The conversation that started it all:
#8654
It looks like tsdoc-metadata.json allows api-extractor to know what dialect of tsdoc (if any) your package speaks. This can be useful for example when you're running api-extractor on package A, which in turn depends on package B that has types. If api-extractor finds tsdoc-metadata.json in package B, it should be able to respect the TSDoc comments...at least that's how I understand it:
microsoft/tsdoc#7
Currently many of our packages don't publish this file, since they include just the rolled-up types in the package.json
files
field. This package is to investigate (and potentially track efforts) whether we should be publishing this file.The text was updated successfully, but these errors were encountered: