docs(compiler): update ngtsc/ngcc design doc with more details #23174
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
trotyl
reviewed
Apr 4, 2018
| 1. It helps to enforce the Ivy locality principle, since all inputs to the Compiler will be visible. | ||
| 2. It protects against incorrect builds during `--watch` mode, since the dependencies between files will be easily traceable. | ||
|
|
||
| Compilers will also not take Typescript nodes directly as input, but will operate against information extracted from TS sources by the transformer. In addition to helping enforce the rules above, this restriction also enables Compilers to run in at runtime during JIT mode. |
mhevery
approved these changes
Apr 4, 2018
| Thus, `ngcc` will have two approaches for dealing with packages on NPM. | ||
|
|
||
| 1. APF Path: libraries following the Angular package format will have their source code updated to contain Ivy definitions. This ensures tree-shaking will work properly. | ||
| 2. Compatibility Path: libraries where `ngcc` cannot determine how to safely modify the existing code will have a patching operation applied. This patching operation produces a "wrapper" file for each file containing an Angular entity, which re-exports patched versions of the Angular entities. This is not compatible with tree-shaking, but will work for libraries which `ngcc` cannot otherwise understand. A warning will be printed to notify the user they should update the version of the library if possible. |
There was a problem hiding this comment.
Could you add an example of such a situation?
alxhub
added
area: core
alxhub
added
action: merge
|
You can preview b96e5bc at https://pr23174-b96e5bc.ngbuilds.io/. |
|
You can preview 19479cf at https://pr23174-19479cf.ngbuilds.io/. |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.