Edit config files with a temp editor and add some validation #3945
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Fixes martinvonz#3905 This solves a problem where `jj config edit` drops you straight into an editor and allows you to save an invalid toml file. If you mess up your toml syntax, jj cannot launch (even `jj config edit`!) This implements a pattern I've seen in tools like `crontab -e` or `visudo` where you get dropped into a temporary file editor and the tool does a bit of sanity checking before copying over the contents of the temporary file into the actual file. Code wise: this reuses a utility function which takes care of the heavy lifting for creating a temporary file and launching an editor. I put all the validation in a new function in cli/src/config.rs, which seemed a bit like overkill but I figured the details of the config format being toml shouldn't leak into cli_util or command/config
leeavital
force-pushed
the
check_toml_in_config_edit
branch
from
be6f606
to
761f9a1
Compare
|
According to the issue comment, I think temporary backup + restore is preferred over editing temporary file.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3905
This solves a problem where
jj config editdrops you straight into an editor and allows you to save an invalid toml file. If you mess up your toml syntax, jj cannot launch (evenjj config edit!)This implements a pattern I've seen in tools like
crontab -eorvisudowhere you get dropped into a temporary file editor and the tool does a bit of sanity checking before copying over the contents of the temporary file into the actual file.Code wise: this reuses a utility function which takes care of the heavy lifting for creating a temporary file and launching an editor. I put all the validation in a new function in cli/src/config.rs, which seemed a bit like overkill but I figured the details of the config format being toml shouldn't leak into cli_util or command/config
Checklist
If applicable:
CHANGELOG.md