Skip to content

docs(compiler-cli): add README.md for template type checking system#41004

Closed
alxhub wants to merge 1 commit intoangular:masterfrom
alxhub:ngtsc/typecheck/readme
Closed

docs(compiler-cli): add README.md for template type checking system#41004
alxhub wants to merge 1 commit intoangular:masterfrom
alxhub:ngtsc/typecheck/readme

Conversation

@alxhub
Copy link
Copy Markdown
Member

@alxhub alxhub commented Feb 26, 2021

This commit adds a semi-comprehensive README file which describes the
design goals and implementation of the template type checking engine,
which powers the Angular Language Service as well as the main compiler's
understanding of types in templates.

@google-cla google-cla bot added the cla: yes label Feb 26, 2021
@alxhub alxhub added action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release labels Feb 26, 2021
@alxhub alxhub requested a review from zarend February 26, 2021 00:59
Copy link
Copy Markdown
Member

@gkalpak gkalpak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just awesome 💯0️⃣0️⃣0️⃣

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
During TCB generation, a numeric `TemplateId` is assigned to each template declared within a given input file. These `TemplateId` are attached in a comment to the TCBs for each template within the corresponding typecheck files. So the full algorithm for mapping a diagnostic back to the original template involves two steps:
During TCB generation, a numeric `TemplateId` is assigned to each template declared within a given input file. These `TemplateId`s are attached in a comment to the TCBs for each template within the corresponding typecheck files. So the full algorithm for mapping a diagnostic back to the original template involves two steps:

@gkalpak gkalpak added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews and removed action: merge The PR is ready for merge by the caretaker labels Feb 26, 2021
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'' + user.name;
'' + ctx.user.name;

Copy link
Copy Markdown
Contributor

@zarend zarend left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I found these docs helpful.

@zarend zarend added the area: compiler Issues related to `ngc`, Angular's template compiler label Feb 26, 2021
@ngbot ngbot bot added this to the Backlog milestone Feb 26, 2021
This commit adds a semi-comprehensive README file which describes the
design goals and implementation of the template type checking engine,
which powers the Angular Language Service as well as the main compiler's
understanding of types in templates.
@alxhub alxhub added action: merge The PR is ready for merge by the caretaker and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Mar 8, 2021
@alxhub alxhub force-pushed the ngtsc/typecheck/readme branch from a650d99 to 139e3de Compare March 8, 2021 19:20
AndrewKushnir pushed a commit that referenced this pull request Mar 8, 2021
…41004)

This commit adds a semi-comprehensive README file which describes the
design goals and implementation of the template type checking engine,
which powers the Angular Language Service as well as the main compiler's
understanding of types in templates.

PR Close #41004
@angular-automatic-lock-bot
Copy link
Copy Markdown

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Apr 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

action: merge The PR is ready for merge by the caretaker area: compiler Issues related to `ngc`, Angular's template compiler cla: yes target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants