Feature: Introduce ambient type definitions #823
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
Ultimately we'd like to convert the package to TS, but this unblocks wider ecosystem adoption of the stable/preview Ember types. This PR can also serve as a model for other packages which want to publish types in a similar way. This will also work just fine with the `@types` packages from DefinitelyTyped once [a key PR][pr] lands there, but that is not the path we will recommend, so this only includes the `ember-source` peer dependency. [pr]: DefinitelyTyped/DefinitelyTyped#63589
chriskrycho
changed the title
bertdeblock
approved these changes
Dec 14, 2022
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.
Ultimately we'd like to convert the package to TS, but this unblocks wider ecosystem adoption of the stable/preview Ember types. This PR can also serve as a model for other packages which want to publish types in a similar way.
This will also work just fine with the
@typespackages from DefinitelyTyped once a key PR lands there, but that is not the path we will recommend, so this only includes theember-sourcepeer dependency.Notably, this specifies a
peerDependenciesversion forember-sourcewith a constraint for^4.8.3, since that is the version of Ember which supports the types. This may be a technically-breaking change for some consumers (specifically Yarn 3 or pnpm users who are taking advantage of those package managers), so we may want to set a looser version and simply document that; I'll happily push an update if folks prefer that!Resolves #795