Update Readme file : Add Support for Angular 9+ section #1477
Conversation
|
@AleksanderBodurri, can you please review ? |
There was a problem hiding this comment.
Thanks for the PR. Left a few review comments. Other than those there are two things that need to be done:
- There should be a link in the "Supported Versions" section that points to this section.
- fixup all commits to c1be06a
README.md
Outdated
| @@ -161,6 +161,16 @@ To learn more about AoT compilation, visit [this section of Angular documentatio | |||
|
|
|||
| Prior to [Angular 2.2.0](https://github.com/angular/angular/blob/master/CHANGELOG.md#220-upgrade-firebooster-2016-11-14), `enableDebugTools()` would clobber `ng.probe`, which breaks Augury. Prior to that version, [this workaround](https://github.com/AngularClass/angular2-webpack-starter/blob/dbb7d10e6e84b8e88116d957f0047b422ab807c1/src/app/environment.ts#L28...L36) will circumvent the issue. | |||
|
|
|||
| ## Support for Angular 9+ | |||
There was a problem hiding this comment.
Reword: "Support for ivy in Angular 9"
README.md
Outdated
| @@ -161,6 +161,16 @@ To learn more about AoT compilation, visit [this section of Angular documentatio | |||
|
|
|||
| Prior to [Angular 2.2.0](https://github.com/angular/angular/blob/master/CHANGELOG.md#220-upgrade-firebooster-2016-11-14), `enableDebugTools()` would clobber `ng.probe`, which breaks Augury. Prior to that version, [this workaround](https://github.com/AngularClass/angular2-webpack-starter/blob/dbb7d10e6e84b8e88116d957f0047b422ab807c1/src/app/environment.ts#L28...L36) will circumvent the issue. | |||
|
|
|||
| ## Support for Angular 9+ | |||
|
|
|||
| Due to some Angular 9 debug API updates, Augury cannot support ngModule or router tree parsing for the moment. As a workaround, disable ivy to be able to see missing Augury tabs by adding this config to your project's `tsconfig.app.json` file : | |||
There was a problem hiding this comment.
- "Due to some Angular 9 debug API updates." This is unnecessary information. Remove
- "Augury cannot support ngModule or router tree parsing for the moment." Rephrase to emphasize that Augury is unable to provide these features for Angular 9 applications that are using Ivy.
- "disable ivy to be able to see missing Augury tabs" Not specific enough as to what functionality is missing.
Additionally, It should be made very clear that disabling ivy is not recommended, but rather is only a work around for this particular problem. Ivy is enabled by default in new releases. Its use moving forward is encouraged in all new Angular applications.
README.md
Outdated
| "enableIvy": false | ||
| } | ||
| ``` | ||
| For more details about Ivy in Angular 9+, see [documentation](https://angular.io/guide/ivy#opting-out-of-ivy-in-version-9) |
There was a problem hiding this comment.
This link specifically targets the section of ivy related to opting out. The text implies that the link should be related to Ivy in general. Let's remove this line for now as general Ivy information is not relevant to this specific issue.
|
@AleksanderBodurri , thank you for your review, I updated the Readme, can you check it please ? |
|
@AleksanderBodurri Any updates on this? As we are using Angular 9 too |
After some Angular 9 debug API updates, Augury cannot support NgModule or router tree parsing for the moment. I updated the Readme file to explain how to workaround this.
Related to Issue #1472.