Skip to content

Commit 20a97ce

Browse files
committed
Improve prose structure for caveats
1 parent 9b7cec5 commit 20a97ce

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

content/stable-typescript-types-in-ember-5-1.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -96,22 +96,20 @@ Finally, you will need to remove the following packages from your `package.json`
9696
- `@types/ember__test`
9797
- `@types/ember__utils`
9898

99-
That's all you need to do to enjoy the new TypeScript support!
99+
That's all you need to do to enjoy the new TypeScript support! However, there are a couple important caveats you should know about.
100100

101101

102102
## Caveats
103103

104-
However, there are a couple important caveats you should know about.
104+
**First, and most importantly, these new types are not compatible with the existing `@types` definitions for Ember Data.** Unfortunately, Ember Data's hand-written type definitions rely in a number of key areas on some of the mistakes in the `@types` packages for Ember—mistakes that are fixed by using types published from Ember's own source code. So far, the Ember Data team has had too few contributors to make fixing this a top priority. We made the choice to go ahead and publish these stable types from Ember anyway for two reasons:
105105

106-
1. These new types are not compatible with the existing `@types` definitions for Ember Data. Unfortunately, Ember Data's hand-written type definitions rely in a number of key areas on some of the mistakes in the `@types` packages for Ember—mistakes that are fixed by using types published from Ember's own source code. So far, the Ember Data team has had too few contributors to make fixing this a top priority. We made the choice to go ahead and publish these stable types from Ember anyway for two reasons:
106+
- While many Ember users *do* rely on Ember Data, not all do, and this makes the best possible types for Ember available to anyone who is not blocked in this way.
107107

108-
- While many Ember users *do* rely on Ember Data, not all do, and this makes the best possible types for Ember available to anyone who is not blocked in this way.
108+
- Ember Data itself can now take advantage of the Ember types! This was a long-standing chicken-or-egg problem: Ember Data could not really publish its own stable types while relying on the hand-written `@types` packages for Ember!
109109

110-
- Ember Data itself can now take advantage of the Ember types! This was a long-standing chicken-or-egg problem: Ember Data could not really publish its own stable types while relying on the hand-written `@types` packages for Ember!
110+
Happily, the two newest members of the Ember TypeScript team, Peter Wagenet and Krystan HuffMenne, are both actively interested in tackling this problem, so there will hopefully be good progress in this space in the rest of 2023. (This is a great place to chip in and help, by the way!)
111111

112-
Happily, the two newest members of the Ember TypeScript team, Peter Wagenet and Krystan HuffMenne, are both actively interested in tackling this problem, so there will hopefully be good progress in this space in the rest of 2023. (This is a great place to chip in and help, by the way!)
113-
114-
2. Ember's stable types do not have full support for the Ember Classic programming model. If you rely heavily on the Ember Classic programming model, we encourage you to update your code to the Ember Octane programming model—for *many* reasons! For details on absorbing these changes in particular, see the [Migration Guide](#toc_migration-guide) below.
112+
**Second, Ember's stable types do not have full support for the Ember Classic programming model.** If you rely heavily on the Ember Classic programming model, we encourage you to update your code to the Ember Octane programming model—for *many* reasons! For details on absorbing these changes in particular, see the [Migration Guide](#toc_migration-guide) below.
115113

116114

117115
## Stability

0 commit comments

Comments
 (0)