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

[node-core-library] [api-extractor] Include typings for the package.json 'exports' and 'typesVersions' fields support for resolving the tsdoc-metadata.json field referenced by 'exports' and 'typesVersions'. #4730

Merged
merged 6 commits into from
May 27, 2024

Conversation

iclanton
Copy link
Member

@iclanton iclanton commented May 21, 2024

Summary

This is necessary for allowing the exports field in package.jsons to define the default typings location.

How it was tested

Tested in a branch that moves node-core-library to use exports and added unit tests.

Impacted documentation

This will probably require updates to the API Extractor and/or tsdoc docs.

Copy link
Contributor

@dmichon-msft dmichon-msft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix that we don't check the types field in package.json while you're doing this? Or typesVersions?

@octogonz
Copy link
Collaborator

octogonz commented May 21, 2024

This will probably require updates to the API Extractor and/or tsdoc docs.

As far as I can tell, the 4 (now 5) lookup rules for tsdoc-metadata.json are only documented in the API Extractor source code. We should add them to the TSDoc website, and link it from the API Extractor website.

(The API Extractor docs do specify how to configure where tsdoc-metadata.json is written but now how it is read.)

@iclanton if you remind me, I can do that after your PR is merged.

@iclanton iclanton force-pushed the add-support-for-exports-types branch from 1b70b97 to d3a4a75 Compare May 26, 2024 01:41
@iclanton iclanton changed the title [node-core-library] [api-extractor] Include typings for the package.json 'exports' field support for resolving the tsdoc-metadata.json field referenced by 'exports'. [node-core-library] [api-extractor] Include typings for the package.json 'exports' and 'typesVersions' fields support for resolving the tsdoc-metadata.json field referenced by 'exports' and 'typesVersions'. May 26, 2024
@iclanton iclanton enabled auto-merge May 26, 2024 06:10
@iclanton iclanton disabled auto-merge May 26, 2024 23:21
@iclanton iclanton merged commit 4123770 into microsoft:main May 27, 2024
5 checks passed
@iclanton iclanton deleted the add-support-for-exports-types branch May 28, 2024 03:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants