core-data: Bundle TypeScript types with the data package #43643
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adamziel
added
[Type] Enhancement
|
Size Change: 0 B Total Size: 1.24 MB ℹ️ View Unchanged
|
gziolo
approved these changes
Aug 29, 2022
This was referenced Apr 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
This PR exposes TypeScript types with the
@wordpress/core-datapackage by adding"types": "build-types"to package.json.This would provide autocompletion support to consumers of this package:
While the types are not 100% complete, they have been iterated on and already provide value. Exposing them creates an incentive to improve them further as every contribution would immediately benefit
@wordpress/core-dataconsumers.Why is it a breaking change?
Currently, TypeScript uses the DefinitelyTyped types for the
@wordpress/core-datapackage. With this PR, it will use the types shipped with the@wordpress/core-dataitself and ignore the types from DefinitelyTyped. The two are not compatible, hence this PR lists a breaking change in the changelog.Test plan
Confirm the checks are all green
cc @gziolo @dmsnell