1
0
mirror of https://github.com/Llewellynvdm/starship.git synced 2025-01-03 22:27:28 +00:00
starship/src/configure.rs
Kevin Song 7f82dd66ed
fix: check if editor is not found for configure (#961)
* fix: check if editor is not found for `configure`

STD_EDITOR falls back on `vi` if $EDITOR and $VISUAL is not set.
However, some machines might not have `vi` symlinked or installed and a
bad error message is displayed. This commit adds a better error message.

* fix lint errors

* Change NotFound to write to stderr instead of panic!

Oh wow writing rust makes my commit messages look very enthusiastic!
2020-03-05 09:50:34 -06:00

122 lines
3.4 KiB
Rust

use std::env;
use std::ffi::OsString;
use std::io::ErrorKind;
use std::process::Command;
const STD_EDITOR: &str = "vi";
pub fn edit_configuration() {
let config_path = get_config_path();
let editor_cmd = get_editor();
let mut cmd_iter = editor_cmd
.to_str()
.expect("environment variable contains invalid unicode")
.split_whitespace();
let editor = cmd_iter.next().unwrap_or(STD_EDITOR);
let args: Vec<_> = cmd_iter.collect();
let command = Command::new(editor).args(args).arg(config_path).status();
match command {
Ok(_) => (),
Err(error) => match error.kind() {
ErrorKind::NotFound => {
eprintln!(
"Error: editor {:?} was not found. Did you set your $EDITOR or $VISUAL \
environment variables correctly?",
editor
);
eprintln!("Full error: {:?}", error);
std::process::exit(1)
}
other_error => panic!("failed to open file: {:?}", other_error),
},
};
}
fn get_editor() -> OsString {
get_editor_internal(env::var_os("VISUAL"), env::var_os("EDITOR"))
}
fn get_editor_internal(visual: Option<OsString>, editor: Option<OsString>) -> OsString {
let mut editor_name = visual.unwrap_or_else(|| "".into());
if !editor_name.is_empty() {
return editor_name;
}
editor_name = editor.unwrap_or_else(|| "".into());
if !editor_name.is_empty() {
return editor_name;
}
STD_EDITOR.into()
}
fn get_config_path() -> OsString {
let config_path = env::var_os("STARSHIP_CONFIG").unwrap_or_else(|| "".into());
if config_path.is_empty() {
dirs::home_dir()
.expect("couldn't find home directory")
.join(".config/starship.toml")
.as_os_str()
.to_owned()
} else {
config_path
}
}
#[cfg(test)]
mod tests {
use super::*;
// This is every possible permutation, 3² = 9.
#[test]
fn visual_set_editor_set() {
let actual = get_editor_internal(Some("foo".into()), Some("bar".into()));
assert_eq!("foo", actual);
}
#[test]
fn visual_set_editor_empty() {
let actual = get_editor_internal(Some("foo".into()), None);
assert_eq!("foo", actual);
}
#[test]
fn visual_set_editor_not_set() {
let actual = get_editor_internal(Some("foo".into()), None);
assert_eq!("foo", actual);
}
#[test]
fn visual_empty_editor_set() {
let actual = get_editor_internal(Some("".into()), Some("bar".into()));
assert_eq!("bar", actual);
}
#[test]
fn visual_empty_editor_empty() {
let actual = get_editor_internal(Some("".into()), Some("".into()));
assert_eq!("vi", actual);
}
#[test]
fn visual_empty_editor_not_set() {
let actual = get_editor_internal(Some("".into()), None);
assert_eq!("vi", actual);
}
#[test]
fn visual_not_set_editor_set() {
let actual = get_editor_internal(None, Some("bar".into()));
assert_eq!("bar", actual);
}
#[test]
fn visual_not_set_editor_empty() {
let actual = get_editor_internal(None, Some("".into()));
assert_eq!("vi", actual);
}
#[test]
fn visual_not_set_editor_not_set() {
let actual = get_editor_internal(None, None);
assert_eq!("vi", actual);
}
}