Skip to content

Commit

Permalink
Add @astrojs/check README (#883)
Browse files Browse the repository at this point in the history
* Add `@astrojs/check` README

* Add homepage and description to package.json

* Add changeset

* Update packages/astro-check/README.md

Co-authored-by: Chris Swithinbank <[email protected]>

---------

Co-authored-by: Erika <[email protected]>
  • Loading branch information
delucis and Princesseuh authored Jul 8, 2024
1 parent eb7215c commit a1769da
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .changeset/friendly-jars-cover.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@astrojs/check": patch
---

Adds a README with helpful links
38 changes: 38 additions & 0 deletions packages/astro-check/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# @astrojs/check ✅

This package powers the `astro check` CLI command for running type checking and diagnostics in Astro projects.

This package's internal logic is powered by [the Astro language server](https://github.com/withastro/language-tools/blob/main/packages/language-server/src/check.ts).

## Documentation

Read [the Astro type checking docs][docs].

## Support

- Get help in the [Astro Discord][discord]. Post questions in our `#support` forum, or visit our dedicated `#editors` channel to discuss current development and more!

- Submit bug reports and feature requests as [GitHub issues][issues].

## Contributing

This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! These links will help you get started:

- [Contributor Manual][contributing]
- [Code of Conduct][coc]
- [Community Guide][community]

## License

MIT

Copyright (c) 2022–present [Astro][astro]

[astro]: https://astro.build/
[docs]: https://docs.astro.build/en/guides/typescript/#type-checking
[contributing]: https://github.com/withastro/language-tools/blob/main/CONTRIBUTING.md
[coc]: https://github.com/withastro/.github/blob/main/CODE_OF_CONDUCT.md
[community]: https://github.com/withastro/.github/blob/main/COMMUNITY_GUIDE.md
[discord]: https://astro.build/chat/
[issues]: https://github.com/withastro/language-tools/issues
[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
2 changes: 2 additions & 0 deletions packages/astro-check/package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
{
"name": "@astrojs/check",
"description": "Type checking and diagnostics for Astro projects",
"version": "0.7.0",
"author": "withastro",
"license": "MIT",
"homepage": "https://github.com/withastro/language-tools/tree/main/packages/astro-check",
"repository": {
"type": "git",
"url": "https://github.com/withastro/language-tools",
Expand Down

0 comments on commit a1769da

Please sign in to comment.