refactor!: remove `simulator` feature by deadbaed · Pull Request #67 · ratatui/mousefood

deadbaed · 2025-06-16T22:30:13Z

Move simulator display implementation to the example directly
Created standalone crate for simulator example
Remove simulator feature, Fixes Simulator feature flag is semver-incompatible #61

misc

added workspace for mousefood, examples, and the future
build examples in CI
editorconfig for toml files

j-g00da · 2025-06-17T08:34:38Z

Leave the --lib in CI for now, the docstrings have to be completely rewritten, then we will remove this.

Maybe I will take a look at no_std and merge it without changing docs, as the docs will have to be changed a lot anyway after your changes - I will open a separate issue for that.

I know we will create some temporary mess on main, but I don't mind this as I don't plan releasing mousefood 0.3.0 before ratatui 0.30.0, which will take more than month probably.

WDYT?

j-g00da

Thanks so much for this! I know it's a draft still but I left some notes.

.gitignore

examples/Cargo.toml

j-g00da · 2025-06-17T10:57:51Z

No-std changes are on main, you can merge these in now.

- Move `simulator` example into its own crate with all its dependencies - Remove crate feature `simulator`, code implementation is moved to the `simulator` example crate - Created workspace to host `mousefood` crate + examples + future stuff

to keep TOML files indented correctly when using multiple text editors

- Install dependencies, and build examples - Add YAML files to editorconfig

deadbaed · 2025-06-17T19:12:51Z

I will merge main into my branch, and fix conflicts

I know we will create some temporary mess on main, but I don't mind this as I don't plan releasing mousefood 0.3.0 before ratatui 0.30.0, which will take more than month probably.
WDYT?

Fine by me! If you want we can make a staging branch before merging everything onto main.

I hope there won't be too much mess, my goal is to never break the build on main!

j-g00da · 2025-06-17T19:33:49Z

Main builds, it's just the docs that are outdated.

deadbaed · 2025-06-17T19:40:10Z

Hum, for some reason GitHub is not showing the fact I merged main into my branch on thie PR https://github.com/deadbaed/mousefood/commits/remove_simulator_feature/

And GitHub action is not running, what is going on? 😅

Edit: TIL GitHub can need some time to process pushes to branches https://github.blog/changelog/2023-09-26-more-details-provided-when-a-pull-request-is-merged-indirectly-or-is-still-processing-updates/

deadbaed · 2025-06-17T20:05:06Z

CI is failing, but it's due to a download error. I cannot seem to restart it for the PR, but I re-ran jobs on my fork and everything went well. https://github.com/deadbaed/mousefood/actions/runs/15716651585

Ready for another round of review!

build-examples: make github actions aware of `cargo build` failures by using `xargs`

- ratatui is no longer re-exported from mousefood anymore - use mousefood::error::Error

j-g00da

I will take a deeper look tomorrow, but I left some comments

j-g00da · 2025-06-17T20:34:36Z

Cargo.toml

+[workspace]
+resolver = "3"
+members = [
+  ".",
+  "examples/*",
+]
+


We should create a mousefood directory in the repo and move there the whole src and Cargo.toml, then in the root Cargo.toml we should only have workspace setup.

Works for me.
Do you want to do that in another PR?

I think let's do it in this PR, it's already mostly about introducing a workspace setup

Okay, just pushed it.

examples/simulator/Cargo.toml

j-g00da · 2025-06-17T20:53:22Z

Btw. nit: readme.md -> README.md
But I would remove this readme file completely, and just move it inside /examples/simulator/src/main.rs
(or at least add #![doc = include_str!("../README.md")] inside main.rs).

I think the merge got messed-up somehow

deadbaed · 2025-06-17T21:08:58Z

But I would remove this readme file completely, and just move it inside /examples/simulator/src/main.rs

I'd prefer to keep the readme, GitHub will render it for us when users browse the repo, might get users to clone the repo and run the examples! That's what I do inside repositories when I see they have examples.

j-g00da · 2025-06-18T12:18:00Z

We should probably put this in docs in main.rs and generate README.md files for all examples using cargo-rdme later (but this is a topic for another PR).

deadbaed · 2025-06-18T16:15:07Z

Did not know about this, looks very promising!

j-g00da · 2025-06-18T19:59:07Z

.editorconfig

+# EditorConfig is awesome: https://editorconfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+
+[*.{toml,yml}]
+indent_style = space
+indent_size = 2


This is a topic for separate PR

deadbaed marked this pull request as draft June 16, 2025 22:30

deadbaed force-pushed the remove_simulator_feature branch from fe381d6 to b0c2784 Compare June 16, 2025 22:43

j-g00da reviewed Jun 17, 2025

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

examples/Cargo.toml Outdated Show resolved Hide resolved

deadbaed added 3 commits June 17, 2025 21:02

simulator: Refactor out of crate feature

52aec37

- Move `simulator` example into its own crate with all its dependencies - Remove crate feature `simulator`, code implementation is moved to the `simulator` example crate - Created workspace to host `mousefood` crate + examples + future stuff

added EditorConfig for TOML files

626008f

to keep TOML files indented correctly when using multiple text editors

ci: Build examples

711a383

- Install dependencies, and build examples - Add YAML files to editorconfig

deadbaed force-pushed the remove_simulator_feature branch from b0c2784 to 711a383 Compare June 17, 2025 19:07

Merge no_std changes into remove_simulator_feature

18d1a10

deadbaed marked this pull request as ready for review June 17, 2025 20:05

deadbaed added 2 commits June 17, 2025 22:26

ci: propagate cargo build failures

f2a2b7e

build-examples: make github actions aware of `cargo build` failures by using `xargs`

simulator example: fixes after ratatui#60

52d52f8

- ratatui is no longer re-exported from mousefood anymore - use mousefood::error::Error

j-g00da reviewed Jun 17, 2025

View reviewed changes

deadbaed added 2 commits June 17, 2025 22:55

Removed previous simulator.rs example

c2ff124

I think the merge got messed-up somehow

2024 edition for all crates in workspace

cc54fe0

deadbaed added 2 commits June 17, 2025 23:09

simulator example: include readme in main.rs

5013495

Workspace: move mousefood from / to mousefood/

3666037

deadbaed force-pushed the remove_simulator_feature branch from 82dc613 to 3666037 Compare June 18, 2025 06:47

deadbaed mentioned this pull request Jun 18, 2025

Workspace setup #75

Merged

j-g00da reviewed Jun 18, 2025

View reviewed changes

j-g00da changed the title ~~Move simulator to its own crate, remove crate feature~~ refactor!: remove simulator feature Jun 18, 2025

deadbaed mentioned this pull request Jun 19, 2025

feat(simulator)!: remove simulator feature #83

Merged

j-g00da closed this Jun 19, 2025

Uh oh!

Conversation

deadbaed commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

misc

Uh oh!

j-g00da commented Jun 17, 2025

Uh oh!

j-g00da left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

j-g00da commented Jun 17, 2025

Uh oh!

deadbaed commented Jun 17, 2025

Uh oh!

j-g00da commented Jun 17, 2025

Uh oh!

deadbaed commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

deadbaed commented Jun 17, 2025

Uh oh!

j-g00da left a comment

Choose a reason for hiding this comment

Uh oh!

j-g00da Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

deadbaed Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

j-g00da Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

deadbaed Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

j-g00da commented Jun 17, 2025

Uh oh!

deadbaed commented Jun 17, 2025

Uh oh!

j-g00da commented Jun 18, 2025

Uh oh!

deadbaed commented Jun 18, 2025

Uh oh!

j-g00da Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

deadbaed commented Jun 16, 2025 •

edited

Loading

deadbaed commented Jun 17, 2025 •

edited

Loading