Skip to content
This repository has been archived by the owner on Dec 30, 2023. It is now read-only.

[Bug] The TOML parser doesn't keep comments when saving. #1

Open
3 tasks done
flerouwu opened this issue Nov 18, 2023 · 0 comments
Open
3 tasks done

[Bug] The TOML parser doesn't keep comments when saving. #1

flerouwu opened this issue Nov 18, 2023 · 0 comments
Assignees
Labels
bug Something isn't working enhancement New feature or request

Comments

@flerouwu
Copy link
Owner

Checks

  • I have verified that there are no other opened issues regarding this bug.
  • I am confident that this is a bug report.

Describe the bug

When saving the TOML changes to disk, it doesn't keep the comments that were provided
when the file was loaded.

To Reproduce

Steps to reproduce the behavior:

  1. Launch Bismuth.
  2. Change a value in game (not implemented, but can be done in code).
  3. Save the changes.
  4. Observe that the comments aren't kept.

Expected behavior

The comments to save. The TOML library we are using (Toml4j) doesn't support comments.
There's a PR open in Toml4j's repository that implements this.

Suggested Solution

Fork the Toml4j project found and implement the PR https://www.github.com/mwanji/toml4j/pull/65.

Screenshots

Versions

Bismuth version (/bismuth version): Latest dev (6c19173) with local changes.

Java version (java --version): N/A

Launcher (e.g. Prism, MultiMC, Vanilla, etc.): N/A

Other mods (e.g. Optifine HD U M5): N/A

Crash log (if applicable)

N/A

Game log

N/A

Additional Information

N/A

  • I have completed this template to the best of my ability, providing all information needed to reproduce and fix
    this issue.
@flerouwu flerouwu added bug Something isn't working needs triage This is new. Someone needs to triage this. enhancement New feature or request and removed needs triage This is new. Someone needs to triage this. labels Nov 18, 2023
@flerouwu flerouwu self-assigned this Nov 18, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant