1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
//! `edit` lets you open and edit something in a text editor, regardless of platform. //! (Think `git commit`.) //! //! It works on Windows, Mac, and Linux, and [knows about] lots of different text editors to fall //! back upon in case standard environment variables such as `VISUAL` and `EDITOR` aren't set. //! //! ```rust,ignore //! let template = "Fill in the blank: Hello, _____!"; //! let edited = edit::edit(template)?; //! println!("after editing: '{}'", edited); //! // after editing: 'Fill in the blank: Hello, world!' //! ``` //! //! [knows about]: ../src/edit/lib.rs.html#31-61 use std::{ env, ffi::OsStr, fs, io::{Error, ErrorKind, Result, Write}, path::{Path, PathBuf}, process::{Command, Stdio}, }; use tempfile::NamedTempFile; #[cfg(feature = "which")] use which::which; static ENV_VARS: &[&str] = &["VISUAL", "EDITOR"]; // TODO: should we hardcode full paths as well in case $PATH is borked? #[cfg(not(any(target_os = "windows", target_os = "macos")))] static HARDCODED_NAMES: &[&str] = &[ // CLI editors "nano", "pico", "vim", "nvim", "vi", "emacs", // GUI editors "code", "atom", "subl", "gedit", "gvim", // Generic "file openers" "xdg-open", "gnome-open", "kde-open", ]; #[cfg(target_os = "macos")] static HARDCODED_NAMES: &[&str] = &[ // CLI editors "nano", "pico", "vim", "nvim", "vi", "emacs", // GUI editors "code", "atom", "subl", "gvim", "mate", // Generic "file openers" "open -a TextEdit", "open -a TextMate", "open", ]; #[cfg(target_os = "windows")] static HARDCODED_NAMES: &[&str] = &[ // GUI editors "code.exe", "atom.exe", "subl.exe", "notepad++.exe", // Installed by default "notepad.exe", // Generic "file openers" "cmd.exe /C start", ]; #[cfg(feature = "better-path")] fn check_editor<T: AsRef<OsStr>>(binary_name: T) -> bool { which(binary_name).is_ok() } #[cfg(not(feature = "better-path"))] fn check_editor<T: AsRef<OsStr>>(binary_name: T) -> bool { if let Some(paths) = env::var_os("PATH") { for dir in env::split_paths(&paths) { if dir.join(&binary_name).is_file() { return true; } } } false } fn string_to_cmd(s: String) -> (PathBuf, Vec<String>) { let mut args = s.split_ascii_whitespace(); ( args.next().unwrap().into(), args.map(String::from).collect(), ) } fn get_editor_args() -> Result<(PathBuf, Vec<String>)> { ENV_VARS .iter() .filter_map(env::var_os) .filter(|v| !v.is_empty()) .filter_map(|v| v.into_string().ok()) .map(string_to_cmd) .filter(|(p, _)| check_editor(p)) .next() .or_else(|| { HARDCODED_NAMES .iter() .map(|s| s.to_string()) .map(string_to_cmd) .filter(|(p, _)| check_editor(p)) .next() }) .ok_or_else(|| Error::from(ErrorKind::NotFound)) } /// Find the system default editor, if there is one. /// /// This function checks several sources to find an editor binary (in order of precedence): /// /// - the `VISITOR` environment variable /// - the `EDITOR` environment variable /// - hardcoded lists of common CLI editors on MacOS/Unix /// - hardcoded lists of GUI editors on Windows/MacOS/Unix /// - platform-specific generic "file openers" (e.g. `xdg-open` on Linux and `open` on MacOS) /// /// Also, it doesn't blindly return whatever is in an environment variable. If a specified editor /// can't be found or isn't marked as executable (the executable bit is checked when the default /// feature `better-path` is enabled), this function will fall back to the next one that is. /// /// # Returns /// /// If successful, returns the name of the system default editor. /// Note that in most cases the full path of the editor isn't returned; what is guaranteed is the /// return value being suitable as the program name for e.g. [`Command::new`]. /// /// On some platforms, a text editor is installed by default, so the chances of a failure are low /// save for `PATH` being unset or something weird like that. However, it is possible for one not /// to be located, and in that case `get_editor` will return [`ErrorKind::NotFound`]. /// /// # Example /// /// ```rust,ignore /// use edit::get_editor; /// /// // will print e.g. "default editor: nano" /// println!("default editor:", get_editor().expect("can't find an editor").to_str()); /// ``` /// /// [`Command::new`]: https://doc.rust-lang.org/std/process/struct.Command.html#method.new /// [`ErrorKind::NotFound`]: https://doc.rust-lang.org/std/io/enum.ErrorKind.html#variant.NotFound pub fn get_editor() -> Result<PathBuf> { get_editor_args().map(|(x, _)| x) } /// Open the contents of a string or buffer in the [default editor]. /// /// This function saves its input to a temporary file and then opens the default editor to it. /// It waits for the editor to return, re-reads the (possibly changed/edited) temporary file, and /// then deletes it. /// /// # Arguments /// /// `text` is written to the temporary file before invoking the editor. (The editor opens with /// the contents of `text` already in the file). /// /// # Returns /// /// If successful, returns the edited string. /// If the edited version of the file can't be decoded as UTF-8, returns [`ErrorKind::InvalidData`]. /// If no text editor could be found, returns [`ErrorKind::NotFound`]. /// Any errors related to spawning the editor process will also be passed through. /// /// [default editor]: fn.get_editor.html /// [`ErrorKind::InvalidData`]: https://doc.rust-lang.org/std/io/enum.ErrorKind.html#variant.InvalidData /// [`ErrorKind::NotFound`]: https://doc.rust-lang.org/std/io/enum.ErrorKind.html#variant.NotFound pub fn edit<S: AsRef<[u8]>>(text: S) -> Result<String> { String::from_utf8(edit_bytes(text)?).map_err(|_| Error::from(ErrorKind::InvalidData)) } /// Open the contents of a string or buffer in the [default editor] and return them as raw bytes. /// /// See [`edit`], the version of this function that takes and returns [`String`]. /// /// # Arguments /// /// `buf` is written to the temporary file before invoking the editor. /// /// # Returns /// /// If successful, returns the contents of the temporary file in raw (`Vec<u8>`) form. /// /// [default editor]: fn.get_editor.html /// [`edit`]: fn.edit.html /// [`String`]: https://doc.rust-lang.org/std/string/struct.String.html pub fn edit_bytes<B: AsRef<[u8]>>(buf: B) -> Result<Vec<u8>> { let mut file = NamedTempFile::new()?; file.write(buf.as_ref())?; let path = file.into_temp_path(); edit_file(&path)?; let edited = fs::read(&path)?; path.close()?; Ok(edited) } /// Open an existing file (or create a new one, depending on the editor's behavior) in the /// [default editor] and wait for the editor to exit. /// /// # Arguments /// /// A [`Path`] to a file, new or existing, to open in the default editor. /// /// # Returns /// /// A Result is returned in case of errors finding or spawning the editor, but the contents of the /// file are not read and returned as in [`edit`] and [`edit_bytes`]. /// /// [default editor]: fn.get_editor.html /// [`Path`]: https://doc.rust-lang.org/std/path/struct.Path.html /// [`edit`]: fn.edit.html /// [`edit_bytes`]: fn.edit_bytes.html pub fn edit_file<P: AsRef<Path>>(file: P) -> Result<()> { let (editor, args) = get_editor_args()?; let status = Command::new(&editor) .args(&args) .arg(file.as_ref()) .stdin(Stdio::inherit()) .stdout(Stdio::inherit()) .stderr(Stdio::inherit()) .output()? .status; if status.success() { Ok(()) } else { let full_command = if args.is_empty() { format!( "{} {}", editor.to_string_lossy(), file.as_ref().to_string_lossy() ) } else { format!( "{} {} {}", editor.to_string_lossy(), args.join(" "), file.as_ref().to_string_lossy() ) }; Err(Error::new( ErrorKind::Other, format!("editor '{}' exited with error: {}", full_command, status), )) } }