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.

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

CLI - Preserve comments when mutating the config file #1798

Open
bfops opened this issue Oct 2, 2024 · 0 comments · May be fixed by #2002
Open

CLI - Preserve comments when mutating the config file #1798

bfops opened this issue Oct 2, 2024 · 0 comments · May be fixed by #2002
Assignees

Comments

@bfops
Copy link
Collaborator

bfops commented Oct 2, 2024

Background

We currently parse, update, and write out the entire config file whenever the CLI is mutating the file. This has the side effect of removing any comments.

We would like to preserve a user's manual edits, including comments, whenever possible.

Definition of "Done"

  • We use toml_edit or some similar crate in order to apply edits to the spacetime config file.
  • When the CLI mutates the config, user comments are preserved.
@bfops bfops self-assigned this Oct 2, 2024
@mamcx mamcx self-assigned this Nov 15, 2024
@mamcx mamcx linked a pull request Nov 19, 2024 that will close this issue
2 tasks
@bfops bfops removed their assignment Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants