Mirrors/dioxus
2
0
Fork 0
mirror of https://github.com/DioxusLabs/dioxus synced 2024-11-23 12:43:08 +00:00
Code Issues Projects Releases Packages Wiki Activity
dioxus/packages/check/README.md

40 lines
1.6 KiB
Markdown
Raw Normal View History

docs(check): update README It was just copy-pasted from `dioxus-autofmt`.
2023-07-18 21:16:28 +00:00
# dioxus-check
feat(check): adds `dx check` At the moment this only checks the Rules of Hooks, ensuring that hook functions (i.e. `use_*`) are being called as expected. https://dioxuslabs.com/docs/0.3/guide/en/interactivity/hooks.html Closes #1202
2023-07-18 21:12:47 +00:00
[![Crates.io][crates-badge]][crates-url]
[![MIT licensed][mit-badge]][mit-url]
[![Build Status][actions-badge]][actions-url]
[![Discord chat][discord-badge]][discord-url]
[crates-badge]: https://img.shields.io/crates/v/dioxus-autofmt.svg
Include README and Dioxus logo in package docs (#1536) * Include README in docs.rs and add Dioxus logo * Update README.md
2023-10-10 15:52:48 +00:00
[crates-url]: https://crates.io/crates/dioxus-check
feat(check): adds `dx check` At the moment this only checks the Rules of Hooks, ensuring that hook functions (i.e. `use_*`) are being called as expected. https://dioxuslabs.com/docs/0.3/guide/en/interactivity/hooks.html Closes #1202
2023-07-18 21:12:47 +00:00
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/dioxuslabs/dioxus/blob/master/LICENSE
[actions-badge]: https://github.com/dioxuslabs/dioxus/actions/workflows/main.yml/badge.svg
[actions-url]: https://github.com/dioxuslabs/dioxus/actions?query=workflow%3ACI+branch%3Amaster
[discord-badge]: https://img.shields.io/discord/899851952891002890.svg?logo=discord&style=flat-square
[discord-url]: https://discord.gg/XgGxMSkvUM
[Website](https://dioxuslabs.com) |
fix: Update doc links from v3 to v4
2023-09-16 17:03:27 +00:00
[Guides](https://dioxuslabs.com/learn/0.4/) |
Include README and Dioxus logo in package docs (#1536) * Include README in docs.rs and add Dioxus logo * Update README.md
2023-10-10 15:52:48 +00:00
[API Docs](https://docs.rs/dioxus-check) |
feat(check): adds `dx check` At the moment this only checks the Rules of Hooks, ensuring that hook functions (i.e. `use_*`) are being called as expected. https://dioxuslabs.com/docs/0.3/guide/en/interactivity/hooks.html Closes #1202
2023-07-18 21:12:47 +00:00
[Chat](https://discord.gg/XgGxMSkvUM)
## Overview
fix: Update doc links from v3 to v4
2023-09-16 17:03:27 +00:00
`dioxus-check` analyzes Dioxus source code and reports errors and warnings. Primarily, it enforces the [Rules of Hooks](https://dioxuslabs.com/learn/0.4/reference/hooks#rules-of-hooks).
feat(check): adds `dx check` At the moment this only checks the Rules of Hooks, ensuring that hook functions (i.e. `use_*`) are being called as expected. https://dioxuslabs.com/docs/0.3/guide/en/interactivity/hooks.html Closes #1202
2023-07-18 21:12:47 +00:00
## Contributing
- Report issues on our [issue tracker](https://github.com/dioxuslabs/dioxus/issues).
- Join the discord and ask questions!
## License
fix: Update doc links from v3 to v4
2023-09-16 17:03:27 +00:00
feat(check): adds `dx check` At the moment this only checks the Rules of Hooks, ensuring that hook functions (i.e. `use_*`) are being called as expected. https://dioxuslabs.com/docs/0.3/guide/en/interactivity/hooks.html Closes #1202
2023-07-18 21:12:47 +00:00
This project is licensed under the [MIT license].
[mit license]: https://github.com/DioxusLabs/dioxus/blob/master/LICENSE-MIT
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in Dioxus by you shall be licensed as MIT without any additional
terms or conditions.
Reference in a new issue Copy permalink