Skip to content

Updating outdated information for astro check documentation for Astro 3 #4899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sarah11918 merged 2 commits into from
Oct 2, 2023
Merged

Updating outdated information for astro check documentation for Astro 3 #4899

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
60f31f2
updating astro check notes in Type checking section for Astro 3
jdwilkin4 Oct 1, 2023
6a2d9c1
Merge branch 'main' into docs-4789-update-astro-check-docs
sarah11918 Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/content/docs/en/guides/typescript.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,15 +270,15 @@ const { title } = Astro.props;

To see type errors in your editor, please make sure that you have the [Astro VS Code extension](/en/editor-setup/) installed. Please note that the `astro start` and `astro build` commands will transpile the code with esbuild, but will not run any type checking. To prevent your code from building if it contains TypeScript errors, change your "build" script in `package.json` to the following:

```json title="package.json" del={2} ins={3} ins="astro check && tsc --noEmit && "
```json title="package.json" del={2} ins={3} ins="astro check &&"
"scripts": {
"build": "astro build",
"build": "astro check && tsc --noEmit && astro build",
"build": "astro check && astro build",
},
```

:::note
`astro check` only checks types within `.astro` files, and `tsc --noEmit` only checks types within `.ts` and `.tsx` files. To check types within Svelte and Vue files, you can use the [`svelte-check`](https://www.npmjs.com/package/svelte-check) and the [`vue-tsc`](https://www.npmjs.com/package/vue-tsc) packages respectively.
`astro check` checks all the files included in your TypeScript project. To check types within Svelte and Vue files, you can use the [`svelte-check`](https://www.npmjs.com/package/svelte-check) and the [`vue-tsc`](https://www.npmjs.com/package/vue-tsc) packages respectively.
:::

📚 Read more about [`.ts` file imports](/en/guides/imports/#typescript) in Astro.
Expand Down