Skip to content
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

Closed
chradek opened this issue May 1, 2020 · 2 comments
Closed

[track2] should we publish tsdoc-metadata.json #8662

chradek opened this issue May 1, 2020 · 2 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library.
Milestone

Comments

@chradek
Copy link
Contributor

chradek commented May 1, 2020

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.

@ghost ghost added the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label May 1, 2020
@ramya-rao-a ramya-rao-a added the Client This issue points to a problem in the data-plane of the library. label May 3, 2020
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label May 3, 2020
@ramya-rao-a ramya-rao-a added this to the [2020] June milestone May 3, 2020
@ramya-rao-a
Copy link
Contributor

cc @jeremymeng, @xirzec

@deyaaeldeen
Copy link
Member

Ok it looks like that the API extractor generating tsdoc-metadata.json is now undesirable as explained here: microsoft/rushstack#1628 (comment) (the origin of the design is here: microsoft/rushstack#959). Furthermore, in the same issue you are linking to, the idea of using a human-authored tsdoc.json was born and which I already introduced using in our repo across our packages to support the @hidden tag and the API extractor tool is already working on support for it here: microsoft/rushstack#1950.

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library.
Projects
None yet
Development

No branches or pull requests

5 participants