Skip to content
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.

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

Add missing flags for the astro check command #8237

Merged
merged 5 commits into from
May 13, 2024
Merged
Changes from 2 commits
Commits
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
30 changes: 30 additions & 0 deletions src/content/docs/en/reference/cli-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,36 @@ Use these flags to customize the behavior of the command.

The command will watch for any changes in your project, and will report any errors.

#### `--root <path-to-dir>`

Specify a different root directory to check. Uses the current working directory by default.
lifeisfakenews marked this conversation as resolved.
Show resolved Hide resolved

#### `--tsconfig <path-to-file>`

Specify a `tsconfig.json` or `jsconfig.json` file to use manually. If not provided, Astro will attempt to find a config, or infer the project's config automatically.
lifeisfakenews marked this conversation as resolved.
Show resolved Hide resolved

#### `--minimumFailingSeverity <error|warning|hint>`

Default: `error`

Minimum severity needed to exit with an error code.

For example, chooisng `warning` will cause the command to exit with an error if any warnings are detected.
lifeisfakenews marked this conversation as resolved.
Show resolved Hide resolved

#### `--minimumSeverity <error|warning|hint>`

Default: `hint`

Minimum severity to output.

For example, choosing `warning` will show errors and warnings, but not hints.
lifeisfakenews marked this conversation as resolved.
Show resolved Hide resolved

#### `--preserveWatchOutput`

Default: `false`

If set to false, the output will not be cleared between checks when in watch mode.
lifeisfakenews marked this conversation as resolved.
Show resolved Hide resolved

<ReadMore>Read more about [type checking in Astro](/en/guides/typescript/#type-checking).</ReadMore>

## `astro sync`
Expand Down
Loading