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

Astro check command missing flags #7542

Open
lifeisfakenews opened this issue Mar 22, 2024 · 3 comments · May be fixed by #8237
Open

Astro check command missing flags #7542

lifeisfakenews opened this issue Mar 22, 2024 · 3 comments · May be fixed by #8237
Labels
help wanted Issues looking for someone to run with them! improve documentation Enhance existing documentation (e.g. add an example, improve description)

Comments

@lifeisfakenews
Copy link

📚 Subject area/topic

astro cli commands

📋 Page(s) affected (or suggested, for new content)

https://docs.astro.build/en/reference/cli-reference/#astro-check

📋 Description of content that is out-of-date or incorrect

the only flag listed on the docs website for the astro check command is --watch
There are it turns out other flags that can be supplied such as --minimumSeverity or --help

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

@lifeisfakenews lifeisfakenews added the improve documentation Enhance existing documentation (e.g. add an example, improve description) label Mar 22, 2024
@jmayergit
Copy link

Came to make this issue and saw it was already made 👍

In the language tools repository we can see the following flags

https://github.com/withastro/language-tools/blob/main/packages/astro-check/src/options.ts#L21

	minimumSeverity: {
		choices: ['error', 'warning', 'hint'] as const,
		description:
			'Minimum diagnostic severity to show. Choosing `warning` will, for example, show both errors and warnings, but not hints. ',
		default: 'hint',
	},

Which are not documented at this location in the docs repository, https://github.com/withastro/docs/blob/2f83515ba71f5a2138f1c7e47f74d12b3e0c38fb/src/content/docs/en/reference/cli-reference.mdx#astro-check.

@sarah11918 sarah11918 added the help wanted Issues looking for someone to run with them! label May 4, 2024
@sarah11918
Copy link
Member

Thank you both for pointing this out @lifeisfakenews and @jmayer -- especially pointing !

Would love a PR to docs (following the existing format) if someone wants to add the missing flags!

@lifeisfakenews
Copy link
Author

i can submit a PR with added flags

@lifeisfakenews lifeisfakenews linked a pull request May 9, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Issues looking for someone to run with them! improve documentation Enhance existing documentation (e.g. add an example, improve description)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants