Skip to content

Commit f3c6105

Browse files
authored
CONTRIBUTING: additional note about ember-tsc (#1019)
1 parent c503511 commit f3c6105

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,17 @@ Glint transforms template code into TypeScript code so that it can be type-check
6565

6666
To inspect the transformed code in VSCode:
6767

68-
1. Install the "Volar Labs" extension from the VSCode marketplace
69-
2. Open a .gts file in your editor
70-
3. Use the Volar Labs extension to inspect the VirtualCode tree of embedded documents
71-
4. You can see the transformed TypeScript representation of the GTS file
72-
5. Hover over source GTS code and transformed TypeScript code to see the mapped regions between them
73-
6. The Volar Labs plugin might not display diagnostic errors _within_ the transformed/generated .ts code; if you are debugging, for instance, an issue where Glint is unexpectedly showing `any` as the type of some value within your `<template>` tag, try copying the transformed TS contents to a new file ending in `.ts`, which may reveal the underlying issue.
68+
1. Make sure "@glint/ember-tsc" is installed in your root package.json if you're working within a monorepo.
69+
2. Install the "Volar Labs" extension from the VSCode marketplace, then fully reload your current VSCode window.
70+
3. Open a .gts file in your editor
71+
4. Use the Volar Labs extension to inspect the VirtualCode tree of embedded documents
72+
5. You can see the transformed TypeScript representation of the GTS file
73+
6. Hover over source GTS code and transformed TypeScript code to see the mapped regions between them
7474

7575
This provides a visual way to understand how your template code is being transformed and helps with debugging type issues.
7676

77+
NOTE: The Volar Labs plugin might not display diagnostic errors _within_ the transformed/generated .ts code; if you are debugging, for instance, an issue where Glint is unexpectedly showing `any` as the type of some value within your `<template>` tag, try copying the transformed TS contents to a new file ending in `.ts`, which may reveal the underlying issue.
78+
7779
## How to link all the packages to an external project?
7880

7981
Set up the links for all the `@glint/*` packages:

0 commit comments

Comments
 (0)