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.

Sign up for GitHub

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

docs: Update Loco comparisons and add some links to other sections #522

Merged
merged 1 commit into from
Nov 22, 2024
Merged

docs: Update Loco comparisons and add some links to other sections #522

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions book/src/comparisons/loco.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,16 @@ missing features are not planned but we'd be open to adding if there was enough
| Tracing via the [tracing](https://crates.io/crates/tracing) crate | ✅ | ✅ |
| &ensp;↳ Built-in support for trace/metric exporting via OpenTelemetry | ✅ | ❌ <!--todo: double check--> |
| [insta](https://crates.io/crates/insta) snapshot utilities | ✅ | ✅ |
| Data seeding and cleanup for tests | ❌* | ✅<br/>(⚠️ makes tests non-parallelizable) |
| Data seeding and cleanup hooks for tests | ❌* | ✅<br/>(⚠️ makes tests non-parallelizable) |
| Mock DB support for tests | ✅ | ❌ |
| &ensp;↳ via SeaORM's [MockDatabase](https://www.sea-ql.org/SeaORM/docs/write-test/mock/) | ✅ | ❌ |
| &ensp;↳ via [TestContainers](https://testcontainers.com/) | ✅ | ❌ |
| Allows following any design pattern | ✅ | ❌<br/>(MVC only) |
| Lifecycle hooks | ✅ | ✅ |
| &ensp;↳ Customizable shutdown signal | ✅ | ❌ |
| HTML rendering | ✅ | ✅ |
| &ensp;↳ Built-in | ❌ | ✅ |
| &ensp;↳ via 3rd party integration, e.g. [Leptos](https://crates.io/crates/leptos) | ✅ | ❌ |
| &ensp;↳ via 3rd party integration, e.g. [Leptos](https://crates.io/crates/leptos) | ✅ | ⚠️ (Partial support) |
| Deployment config generation | ❌ | ✅ |
| Starter templates | ❌* | ✅ |

Expand Down
1 change: 1 addition & 0 deletions book/src/features/services/http/initializer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
See:

- <https://docs.rs/roadster/latest/roadster/service/http/initializer/index.html>
- <https://docs.rs/roadster/latest/roadster/service/http/initializer/any/struct.AnyInitializer.html>

3 changes: 3 additions & 0 deletions book/src/features/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
See:

- <https://docs.rs/roadster/latest/roadster/testing/snapshot/index.html>
- [SeaORM MockDatabase example](https://github.com/roadster-rs/roadster/blob/df7cd821021a63766eb4e902e6025efaabe95177/examples/full/src/model/user.rs#L36-L42)
- [Database TestContainers config](https://docs.rs/roadster/latest/roadster/config/database/struct.Database.html#structfield.test_container)
- [Sidekiq TestContainers config](https://docs.rs/roadster/latest/roadster/config/service/worker/sidekiq/struct.Redis.html#structfield.test_container)