Add testing for website code blocks #2014
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
August 26, 2021 02:41
Heavily inspired by tokio-rs/website repo.
Some code snippets are explicitly ignored and some are not run to avoid having to include dependencies for one liners.
|
Visit the preview URL for this PR (updated for commit e9d217c): https://yew-rs--pr2014-website-code-tests-ocoqi4on.web.app (expires Fri, 03 Sep 2021 12:30:33 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
Code snippets can import types from doc_test crate i.e.: ```rust use doc_test::agents::EventBus; ``` This allows for moving some boilerplate away from the example and still checks that the code compiles correctly. Also some slight changes to some of the examples and the information about `ComponentLink` which is deprecated.
2 tasks
mc1098
changed the title
5 tasks
|
Why not put |
added 3 commits
August 27, 2021 13:18
The new name makes it more clear the purpose of this crate.
Good point :D I have also renamed |
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a new crate for testing the website code blocks. This came from this suggestion and the code is essentially tweaked from the tokio-rs/website repo.
Luckily it doesn't wreck havoc with Docusaurus markup to use rust doc test attributes, like
ignore. Docusaurus attributes, liketitle, don't seem to cause issues for the doc tests either :)The tests run on the
docs/path so just themaster/nextcode blocks- I think to test versioned code blocks would require a different crate due to conflicts of the yew versions.Some of the code blocks have been changed quite a bit to add context for it to compile and some seem to have just been old blocks that never got updated.
Some code blocks depend on other types that don't really add to the point of the example but are required for compile checking, this can now be added as module and imported in the code blocks for example:
Part of #2012
Checklist
cargo make pr-flow