-
-
Notifications
You must be signed in to change notification settings - Fork 120
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #464 from bertdeblock/upgrade-guide
Add upgrading to v8 guide
- Loading branch information
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Upgrading | ||
|
||
## v8 | ||
|
||
The most notable breaking changes introduced in v8 are: | ||
|
||
1. The `includePolyfill` option is no longer supported ([458](https://github.com/babel/ember-cli-babel/pull/458)) | ||
2. `@babel/core` is now a required peer dependency ([452](https://github.com/babel/ember-cli-babel/pull/452)) | ||
|
||
### Upgrade Path for Apps | ||
|
||
Apps that are relying on the `includePolyfill` option should install `core-js`, | ||
and import `core-js/stable` directly in `app.js`. The reason for this is that, | ||
`@babel/polyfill` has been deprecated. More info on this deprecation can be | ||
found in [the documentation for `@babel/polyfill`](https://babeljs.io/docs/en/babel-polyfill). | ||
|
||
Apps are now also required to install `@babel/core` directly in order to use | ||
`ember-cli-babel`. Making `@babel/core` a peer dependency ensures that the | ||
same version is used by all tooling that require it. | ||
|
||
### Upgrade Path for Addons | ||
|
||
Since (v1) addons bring in their own version of `ember-cli-babel`, they should | ||
now also bring in their own version of `@babel/core`. This means that, addons | ||
should add `@babel/core` under `dependencies` in their `package.json` file. | ||
This makes the dependency on `@babel/core` more explicit while also avoiding | ||
addons having to cut a breaking release to update `ember-cli-babel` to v8. |