diff options
| author |  Matthew Phillips <matthew@matthewphillips.info>
| 2021-10-11 08:12:15 -0400 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2021-10-11 08:12:15 -0400 |
| commit | dbd2f5076b4a7d3091deccff77dd545292ee7d76 (patch) | |
| tree | a9fb302afc04fe3f0e46f7a9e547560e315ce647 /docs/src | |
| parent | 4b4596eaac4608dc2273b97b6ad9a61a2f392141 (diff) | |
| download | astro-dbd2f5076b4a7d3091deccff77dd545292ee7d76.tar.gz astro-dbd2f5076b4a7d3091deccff77dd545292ee7d76.tar.zst astro-dbd2f5076b4a7d3091deccff77dd545292ee7d76.zip | |
Adds the astro check command (#1410)
* Adds the `astro check` command.
This adds `astro check`, which runs type checking (and general error
checking) on Astro projects.
* print the number of errors found
* Adds a changeset
* Add cli docs
* Upgrade the language server version
* Prevent linting the console.logs
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/pages/reference/cli-reference.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/src/pages/reference/cli-reference.md b/docs/src/pages/reference/cli-reference.md index 3c66b2368..26b165f48 100644 --- a/docs/src/pages/reference/cli-reference.md +++ b/docs/src/pages/reference/cli-reference.md @@ -25,6 +25,12 @@ Start a local static file server to serve your built `dist/` directory. Useful f This command is meant for local testing only, and is not designed to be run in production. For help with production hosting, check out our guide on [Deploying an Astro Website](/guides/deploy). +### `astro check` + +Runs diagnostics (such as type-checking) against your project and reports errors to the console. If any errors are found the process will exit with a code of __1__. + +This command is intended to be used in CI workflows. + ## Global Flags ### `--config path` |