fix(config): Handle invalid config file #5000
Closed
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
Changed default for StarshipConfig to prevent crashing when invalid config path is provided. Added specific error message when invalid config path is provided.
Ceres445
commented
Mar 15, 2023
| @@ -149,19 +157,21 @@ impl StarshipConfig { | |||
| fn config_from_file() -> Option<toml::Table> { | |||
| let file_path = get_config_path()?; | |||
|
|
|||
| let toml_content = match utils::read_file(file_path) { | |||
| let toml_content = match utils::read_file(&file_path) { | |||
There was a problem hiding this comment.
Changed the move to a borrow so I can use the file_path for the error message later. Worked in my testing, but I'm not sure if it will break in other cases.
domsleee
reviewed
Mar 15, 2023
| Ok(content) => { | ||
| log::trace!("Config file content: \"\n{}\"", &content); | ||
| Some(content) | ||
| } | ||
| Err(e) => { | ||
| let level = if e.kind() == ErrorKind::NotFound { | ||
| log::Level::Debug | ||
| if e.kind() == ErrorKind::NotFound { |
There was a problem hiding this comment.
I think this is inconsistent with prompt behaviour
When an invalid environment variable is specified, starship currently uses the default config (even if ~/.config/starship.config exists it seems)
If we want an error like this, I think it should be in the prompt as well, I feel like the user would expect print-config to print the configuration that is being used by the prompt?
I also have a PR on this issue, my bad: #5001
5 tasks
andytom
changed the title
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.
Description
Changed the default value for StarshipConfig to prevent crashing when invalid config path is provided.
Added a specific error message when invalid config path is provided.
Motivation and Context
Closes #4958
Closes #5001
How Has This Been Tested?
Checklist: