-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
astro check documentation is outdated for Astro 3 #4789
Copy link
Copy link
Closed
Labels
improve or update documentationEnhance / update existing documentation (e.g. add example, improve description, update for changes)Enhance / update existing documentation (e.g. add example, improve description, update for changes)
Description
📚 Subject area/topic
TypeScript
📋 Page(s) affected (or suggested, for new content)
https://docs.astro.build/en/guides/typescript/#type-checking
📋 General description or bullet points (if proposing new content)
This is actually mostly my fault.
The typechecking section mentions using both tsc --noEmit and astro check, but in Astro 3, those commands do essentially the same thing, because astro check now checks all the files included in your TypeScript project, which in most case will include your .(t|j)s(x).
This text:
astro check only checks types within .astro files, and tsc --noEmit only checks types within .ts and .tsx files.
should be removed
and the package.json should be updated to remove the call to tsc --noEmit
🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)
N/A
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
improve or update documentationEnhance / update existing documentation (e.g. add example, improve description, update for changes)Enhance / update existing documentation (e.g. add example, improve description, update for changes)