Feat: Allow optional golds and personal_best in split files by Vxwilson · Pull Request #61 · alexozer/flitter

Vxwilson · 2025-10-12T15:48:17Z

Some changes in split_file and timer that should simplify new split file creation.

Closes #60 and #56.

Problem

Small issue of PB attempt not correctly registering when new PB is created (see PB attempt in JSON not updated when new PB is achieved. #60 ). Fixed in timer.rs with a one-liner.
Currently, creating a new split file requires manually adding golds and personal_best fields, even though this data doesn't exist before the first run (see Don't require filled out fields in initial splits file #56). Personally, I also find having to enter all values confusing ("does entering all 0s' work?") See below for details.

Solution

Make golds and personal_best fields in the JSON optional, allowing users to create a minimal file with just a title, category, and split_names. The application will now handle missing fields on first load without crashing by initializing with blank values.

Details

split_file.rs:
- Used #[serde(default)] to make golds and personal_best optional during deserialization.
- Populate above fields with None values if missing.
timer.rs:
- save_personal_best handles case where no previous PB exists.

Simple Test

Example split JSON with minimal config:

{
  "title": "Silksong",
  "category": "Any% (BlueSR Route)",
  "attempts": 0,
  "completed": 0,
  "split_names": [
    "Red",
    "Orange",
    "Yellow",
    "Green"
  ]
}

Steps:

Run Flitter with above JSON. All segments and splits should appear as -.
Start a run up until the Orange segment, then press Backspace to reset and save. The JSON should update to store the gold splits.
Start another run and finish all segments. After pressing Backspace, the JSON should update accordingly.

This reverts commit 1d2b2b2, due to a typo.

Vxwilson · 2025-10-12T15:53:00Z

Have yet to update the JSON example file + readme; converted to draft for now.

alexozer · 2025-10-12T16:03:52Z

Thanks again! Would you mind updating the README to indicate that the personal best and gold JSON fields are now optional, as well?

EDIT: nvm, just saw your previous comment

Vxwilson · 2025-10-12T16:17:10Z

Thanks again! Would you mind updating the README to indicate that the personal best and gold JSON fields are now optional, as well?

Welcome, this is also me learning to contribute!

The README is updated now; feel free to reword it as you see fit.

alexozer · 2025-10-12T19:22:09Z

@Vxwilson What would you think of wrapping the personal_best field of SplitFile in Optional rather than checking if attempt > 0 when needed? I suspect this may better enforce correctness over remembering where/when to check attempts. So when personal_best is Some, the last split would always be valid.

Vxwilson · 2025-10-13T08:13:39Z

@alexozer I agree with your judgement there, wrapping it with Optional is cleaner and makes the code more robust against future changes. I've pushed up the changes, lmk if that looks right; appreciate your feedback!

While we are at it, what's your opinion on extending this approach to other fields? I could see an argument for making attempts/completed default to 0, and category default to an empty string. But those are relatively effortless for users to configure, so it shouldn't be a big issue.

alexozer · 2025-10-13T12:54:01Z

I think defaulting attempts/completed to 0 definitely makes sense for new split files! Requiring a category name upfront probably isn't too unreasonable though. Alex Ozer

…

On Mon, Oct 13, 2025, 4:14 AM Pong Vei Xhen ***@***.***> wrote: *Vxwilson* left a comment (alexozer/flitter#61) <#61 (comment)> @alexozer <https://github.com/alexozer> I agree with your judgement there, wrapping it with Optional is cleaner and makes the code more robust against future changes. I've pushed up the changes, lmk if that looks right; appreciate your feedback! While we are at it, what's your opinion on extending this approach to other fields? I could see an argument for making attempts/completed default to 0, and category default to an empty string. But those are relatively effortless for users to configure, so it shouldn't be a big issue. — Reply to this email directly, view it on GitHub <#61 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAP2NUWCHU5ILDTG45M5KDL3XNNMTAVCNFSM6AAAAACI7CDHXSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTGOJWGM2TGOJYHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

Vxwilson · 2025-10-16T18:11:12Z

@alexozer Done. No validation needed for this part (IMO) as the counter should self-correct as the user perform new runs.

This feature branch should be ready to merge now, thanks for being patient :)

More minor formatting corrections

Vxwilson added 4 commits October 12, 2025 22:47

feat: Allow minimal split files, implement first run save logic

95fff23

fix: issue alexozer#56 of PB attempt not correctly updating

1d2b2b2

Revert "fix: issue alexozer#56 of PB attempt not correctly updating"

e5ef110

This reverts commit 1d2b2b2, due to a typo.

fix: issue alexozer#60 of PB attempt not correctly updating

3d8078b

Vxwilson marked this pull request as draft October 12, 2025 15:51

Vxwilson added 2 commits October 13, 2025 00:11

feat: include example for minimal JSON

a398767

feat: small wording change

186b202

Vxwilson marked this pull request as ready for review October 12, 2025 16:17

fix: typo

78aefc6

refactor: simplify validation logic

0559b2c

feat: optional attempts/complete value

3a47bde

Minor formatting corrections

d14a54f

More minor formatting corrections

alexozer merged commit ef03999 into alexozer:main Oct 17, 2025
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Allow optional golds and personal_best in split files#61

Feat: Allow optional golds and personal_best in split files#61
alexozer merged 10 commits intoalexozer:mainfrom
Vxwilson:feat/init-split-file

Vxwilson commented Oct 12, 2025 •

edited

Loading

Uh oh!

Vxwilson commented Oct 12, 2025

Uh oh!

alexozer commented Oct 12, 2025 •

edited

Loading

Uh oh!

Vxwilson commented Oct 12, 2025

Uh oh!

alexozer commented Oct 12, 2025

Uh oh!

Vxwilson commented Oct 13, 2025

Uh oh!

alexozer commented Oct 13, 2025 via email

Uh oh!

Vxwilson commented Oct 16, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Vxwilson commented Oct 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Details

Simple Test

Uh oh!

Vxwilson commented Oct 12, 2025

Uh oh!

alexozer commented Oct 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Vxwilson commented Oct 12, 2025

Uh oh!

alexozer commented Oct 12, 2025

Uh oh!

Vxwilson commented Oct 13, 2025

Uh oh!

alexozer commented Oct 13, 2025 via email

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Vxwilson commented Oct 12, 2025 •

edited

Loading

alexozer commented Oct 12, 2025 •

edited

Loading

Vxwilson commented Oct 16, 2025 •

edited

Loading