Data: Bundle TypeScript types with the data package #43315
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
… in the package.json)
adamziel
added
[Package] Data
|
Size Change: +610 B (0%) Total Size: 1.24 MB
ℹ️ View Unchanged
|
|
I'm not the best person to review this PR, but everything looks good at first glance. We could clean up the gutenberg/packages/data/tsconfig.json Lines 17 to 23 in 30e9392 In other packages that have gutenberg/packages/element/tsconfig.json Line 11 in 30e9392 I tested it locally and types build and validate correctly. |
gziolo
added
[Type] Breaking Change
gziolo
requested review from
a team and
fullofcaffeine
and removed request for
a team
gziolo
changed the title
|
@gziolo done! Let's see how the checks turn out 🤞 |
gziolo
approved these changes
Aug 18, 2022
|
One thing we could do is to land this PR and publish WordPress packages to npm from |
|
Let's give it a try so we can test on npm and revert if necessary before the planned bi-weekly publishing happening tomorrow. |
|
It seems to be working well, good idea with the
|
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/datapackage by adding"types": "build-types"to package.json.This would provide autocompletion support to the consumer of this package:
CleanShot.2022-06-09.at.16.36.16.mp4
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/dataconsumers.Why is it a breaking change?
Currently, TypeScript uses the DefinitelyTyped types for the
@wordpress/datapackage. With this PR, it will use the types shipped with the@wordpress/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