feat: readable toml parsing error #854
Conversation
Previously, the yazi displayed the following error.
```
Backtrace omitted. Run with RUST_BACKTRACE=1 to display it.
Run with RUST_BACKTRACE=full to include source snippets.
The application panicked (crashed).
called `Result::unwrap()` on an `Err` value: Error { inner: Error { inner: TomlError { message: "invalid key", raw: Some("{ mime = \"application/octet-stream\",\nuse = [ \"extract_zlib\", \"reveal\" ] }\n"), keys: [], span: Some(0..1) } } }
in yazi-config/src/preset.rs, line 42
thread: main
```
It now displays the following message instead:
```
Error: Loading "/home/solo/.config/yazi/yazi.toml"
Caused by:
TOML parse error at line 1, column 1
|
1 | { mime = "application/octet-stream",
| ^
invalid key
```
For more information see issue sxyaziGH-847.
|
Thank you for the PR, it's very neat. Regarding shotgun parsing, yes, currently, the user's configuration is first merged with the default configuration without any checks; however, the parsing is done based on the merged new configuration (user configuration + default configuration) with checks. Are you meaning doing the second step's checks in the first step as well? Or moving the checks of the second step to the first step? |
|
Ha, you are fast. I would try to move the checks in the second step to the first step. If you are open to a refactoring commit like that, I will give it a shot. However, it might turn out that such a refactoring improves the code only by little. |
|
Sure, I'm open to it. I'd be happy to accept a refactoring PR if it can make the code tidier and won’t be much performance impact ;) |
See commit message for the new error message.
For more information see issue GH-847. Closes #847
Because this is my first pull request in yazi, I've tried to keep it as minimal as possible. Here are some things I noticed while working on this issue:
keymap.toml, ifyazi.tomlhas an error.yazi.tomlis valid, but contains an unknown key, then the key appears to silently omitted.yazi.tomlcould not be read, due to an IO error, then the file is silently omitted.Preset(explanation of shotgun parsing: https://lexi-lambda.github.io/blog/2019/11/05/parse-don-t-validate/). This may be a personal preference of mine, but I would have checked thatyazi.tomlmatches the format specified the by docs before merging it with the default values.