feat(language-service): view template typecheck block #39974

ayazhafiz · 2020-12-04T16:42:18Z

This patch adds an API to retrieve the template typecheck block for a
template (if any) at a file location, and a selection of the TS node
in the TCB corresponding to the template node at which the request for
a TCB was made (if any).

Probably not something we want to land soon, but a useful debugging tool
for folks working with TCBs.

This patch adds a command to retrieve and display the typecheck block for a template under the user's active selection (if any), and highlights the span of the node(s) in the typecheck block that correspond to the template node under the user's active selection (if any). The typecheck block is made available via a dedicated text document provider that queries fresh typecheck block content whenever the `getTemplateTcb` command is invoked. Probably not something we want to land soon, but a useful debugging tool for folks working with TCBs. See also angular/angular#39974, which provides the language service implementations needed for this feature.

packages/language-service/ivy/language_service.ts

packages/language-service/ivy/test/gettcb_spec.ts

packages/language-service/ivy/ts_plugin.ts

packages/language-service/ivy/language_service.ts

ayazhafiz · 2021-01-20T18:23:52Z

@atscott @kyliau apologies for my delayed response. Is this something that we would like to land?

kyliau · 2021-01-20T18:34:48Z

@ayazhafiz Yeah, we are releasing Ivy LS today. After that we would like to move on to next set of features, like view TCB. Are you available in the coming weeks to work on this? If not @atscott could help land the PR.

ayazhafiz · 2021-01-20T18:41:54Z

@ayazhafiz Yeah, we are releasing Ivy LS today. After that we would like to move on to next set of features, like view TCB. Are you available in the coming weeks to work on this? If not @atscott could help land the PR.

Yeah, I can land this one. Just wasn't sure if this was a feature the team wanted to release. Going through the comments right now.

This patch adds an API to retrieve the template typecheck block for a template (if any) at a file location, and a selection of the TS node in the TCB corresponding to the template node at which the request for a TCB was made (if any). Probably not something we want to land soon, but a useful debugging tool for folks working with TCBs.

packages/language-service/ivy/test/gettcb_spec.ts

packages/language-service/ivy/language_service.ts

packages/language-service/ivy/ts_plugin.ts

packages/language-service/ivy/language_service.ts

kyliau · 2021-01-21T19:03:49Z

packages/language-service/ivy/language_service.ts

+
+      return {
+        fileName: sf.fileName,
+        content: sf.text,


nit: Do you remember the difference between .text and .getText()? I think one is normalized (line endings etc) and the other is not, but I don't remember which is which. If we are calling getEnd() and getStart(), we should probably also call getText() here to be consistent.

Neither is normalizing; text gets the raw text and getText (like getEnd and getStart) performs some assertions that the positions of the source file are not synthetic. Changed accordingly.

kyliau · 2021-01-21T19:20:03Z

packages/language-service/ivy/language_service.ts

+
+      return {
+        fileName: sf.fileName,
+        content: sf.getFullText(),


for context, I was referring to offset bugs due to differences between .getText() and .text:

angular/packages/language-service/src/template.ts

Lines 103 to 105 in 69385f7

// node.text returns the TS internal representation of the normalized text,

// and all CR characters are stripped. node.getText() returns the raw text.

this.source = templateNode.getText().slice(1, -1); // strip leading and trailing quotes

🤦 you're right.

But possibly that comment is wrong: https://github.com/microsoft/TypeScript/blob/2f47527b99028d969ea90352a13dffc005a50a7d/src/services/services.ts#L47-L88

This patch adds a command to retrieve and display the typecheck block for a template under the user's active selection (if any), and highlights the span of the node(s) in the typecheck block that correspond to the template node under the user's active selection (if any). The typecheck block is made available via a dedicated text document provider that queries fresh typecheck block content whenever the `getTemplateTcb` command is invoked. Probably not something we want to land soon, but a useful debugging tool for folks working with TCBs. See also angular/angular#39974, which provides the language service implementations needed for this feature.

This patch adds a command to retrieve and display the typecheck block for a template under the user's active selections (if any), and highlights the span of the node(s) in the typecheck block that correspond to the template node under the user's active selection (if any). The typecheck block is made available via a dedicated text document provider that queries fresh typecheck block content whenever the `getTemplateTcb` command is invoked. See also angular/angular#39974, which provides the language service implementations needed for this feature.

angular-automatic-lock-bot · 2021-02-21T16:34:35Z

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.}

ayazhafiz requested review from atscott and zarend December 4, 2020 16:42

google-cla bot added the cla: yes label Dec 4, 2020

ayazhafiz mentioned this pull request Dec 4, 2020

Command to view template typecheck block angular/vscode-ng-language-service#1008

Merged

mhevery added the area: compiler Issues related to `ngc`, Angular's template compiler label Dec 9, 2020

ngbot bot added this to the Backlog milestone Dec 9, 2020

atscott approved these changes Dec 15, 2020

View reviewed changes

atscott force-pushed the e/ls-getTcb2 branch from 53e6417 to f69b858 Compare January 19, 2021 18:13

atscott requested a review from kyliau January 19, 2021 18:22

atscott added action: review The PR is still awaiting reviews from at least one requested reviewer target: minor This PR is targeted for the next minor release area: language-service Issues related to Angular's VS Code language service labels Jan 19, 2021

kyliau reviewed Jan 19, 2021

View reviewed changes

ayazhafiz requested review from kyliau and atscott January 20, 2021 19:07

ayazhafiz marked this pull request as ready for review January 20, 2021 19:07

ayazhafiz force-pushed the e/ls-getTcb2 branch from f69b858 to d3a0b27 Compare January 20, 2021 19:07

ayazhafiz added 2 commits January 20, 2021 13:10

fixup! feat(language-service): view template typecheck block

db224be

fixup! feat(language-service): view template typecheck block

8ba7efe

atscott approved these changes Jan 21, 2021

View reviewed changes

kyliau reviewed Jan 21, 2021

View reviewed changes

kyliau 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: review The PR is still awaiting reviews from at least one requested reviewer labels Jan 21, 2021

fixup! feat(language-service): view template typecheck block

95bbf28

ayazhafiz requested a review from kyliau January 21, 2021 18:29

fixup! feat(language-service): view template typecheck block

3cecede

ayazhafiz requested a review from atscott January 21, 2021 18:56

kyliau approved these changes Jan 21, 2021

View reviewed changes

fixup! feat(language-service): view template typecheck block

c93970f

ayazhafiz requested a review from kyliau January 21, 2021 19:11

kyliau reviewed Jan 21, 2021

View reviewed changes

kyliau approved these changes Jan 21, 2021

View reviewed changes

ayazhafiz 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 Jan 21, 2021

ayazhafiz removed request for atscott and zarend January 21, 2021 20:01

jessicajaniuk closed this in d482f5c Jan 21, 2021

angular-automatic-lock-bot bot locked and limited conversation to collaborators Feb 21, 2021

	// node.text returns the TS internal representation of the normalized text,
	// and all CR characters are stripped. node.getText() returns the raw text.
	this.source = templateNode.getText().slice(1, -1); // strip leading and trailing quotes

feat(language-service): view template typecheck block #39974

feat(language-service): view template typecheck block #39974

Uh oh!

Conversation

ayazhafiz commented Dec 4, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ayazhafiz commented Jan 20, 2021

Uh oh!

kyliau commented Jan 20, 2021

Uh oh!

ayazhafiz commented Jan 20, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kyliau Jan 21, 2021

Choose a reason for hiding this comment

Uh oh!

ayazhafiz Jan 21, 2021

Choose a reason for hiding this comment

Uh oh!

kyliau Jan 21, 2021

Choose a reason for hiding this comment

Uh oh!

ayazhafiz Jan 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ayazhafiz Jan 21, 2021

Choose a reason for hiding this comment

Uh oh!

angular-automatic-lock-bot bot commented Feb 21, 2021

Uh oh!

Uh oh!

ayazhafiz Jan 21, 2021 •

edited

Loading