From 8702aaaefcc3a069947b4e52a9c1f57868f32b5c Mon Sep 17 00:00:00 2001 From: Nirmal Patel Date: Wed, 30 Mar 2022 01:09:25 -0400 Subject: [PATCH] Handle BrokenPipe when piping hx --health through head (#1876) Co-authored-by: Gokul Soumya --- helix-term/src/health.rs | 135 +++++++++++++++++++++++++++++---------- helix-term/src/main.rs | 14 ++-- 2 files changed, 106 insertions(+), 43 deletions(-) diff --git a/helix-term/src/health.rs b/helix-term/src/health.rs index 2a02e118..80f59680 100644 --- a/helix-term/src/health.rs +++ b/helix-term/src/health.rs @@ -1,6 +1,7 @@ use crossterm::style::{Color, Print, Stylize}; use helix_core::config::{default_syntax_loader, user_syntax_loader}; use helix_loader::grammar::load_runtime_file; +use std::io::Write; #[derive(Copy, Clone)] pub enum TsFeature { @@ -40,43 +41,62 @@ impl TsFeature { } /// Display general diagnostics. -pub fn general() { +pub fn general() -> std::io::Result<()> { + let stdout = std::io::stdout(); + let mut stdout = stdout.lock(); + let config_file = helix_loader::config_file(); let lang_file = helix_loader::lang_config_file(); let log_file = helix_loader::log_file(); let rt_dir = helix_loader::runtime_dir(); if config_file.exists() { - println!("Config file: {}", config_file.display()); + writeln!(stdout, "Config file: {}", config_file.display())?; } else { - println!("Config file: default") + writeln!(stdout, "Config file: default")?; } if lang_file.exists() { - println!("Language file: {}", lang_file.display()); + writeln!(stdout, "Language file: {}", lang_file.display())?; } else { - println!("Language file: default") + writeln!(stdout, "Language file: default")?; } - println!("Log file: {}", log_file.display()); - println!("Runtime directory: {}", rt_dir.display()); + writeln!(stdout, "Log file: {}", log_file.display())?; + writeln!(stdout, "Runtime directory: {}", rt_dir.display())?; if let Ok(path) = std::fs::read_link(&rt_dir) { let msg = format!("Runtime directory is symlinked to {}", path.display()); - println!("{}", msg.yellow()); + writeln!(stdout, "{}", msg.yellow())?; } if !rt_dir.exists() { - println!("{}", "Runtime directory does not exist.".red()); + writeln!(stdout, "{}", "Runtime directory does not exist.".red())?; } if rt_dir.read_dir().ok().map(|it| it.count()) == Some(0) { - println!("{}", "Runtime directory is empty.".red()); + writeln!(stdout, "{}", "Runtime directory is empty.".red())?; } + + Ok(()) } -pub fn languages_all() { - let mut syn_loader_conf = user_syntax_loader().unwrap_or_else(|err| { - eprintln!("{}: {}", "Error parsing user language config".red(), err); - eprintln!("{}", "Using default language config".yellow()); - default_syntax_loader() - }); +pub fn languages_all() -> std::io::Result<()> { + let stdout = std::io::stdout(); + let mut stdout = stdout.lock(); + + let mut syn_loader_conf = match user_syntax_loader() { + Ok(conf) => conf, + Err(err) => { + let stderr = std::io::stderr(); + let mut stderr = stderr.lock(); + + writeln!( + stderr, + "{}: {}", + "Error parsing user language config".red(), + err + )?; + writeln!(stderr, "{}", "Using default language config".yellow())?; + default_syntax_loader() + } + }; let mut headings = vec!["Language", "LSP", "DAP"]; @@ -106,7 +126,7 @@ pub fn languages_all() { for heading in headings { column(heading, Color::White); } - println!(); + writeln!(stdout)?; syn_loader_conf .language @@ -139,18 +159,34 @@ pub fn languages_all() { } } - println!(); + writeln!(stdout)?; } + + Ok(()) } /// Display diagnostics pertaining to a particular language (LSP, /// highlight queries, etc). -pub fn language(lang_str: String) { - let syn_loader_conf = user_syntax_loader().unwrap_or_else(|err| { - eprintln!("{}: {}", "Error parsing user language config".red(), err); - eprintln!("{}", "Using default language config".yellow()); - default_syntax_loader() - }); +pub fn language(lang_str: String) -> std::io::Result<()> { + let stdout = std::io::stdout(); + let mut stdout = stdout.lock(); + + let syn_loader_conf = match user_syntax_loader() { + Ok(conf) => conf, + Err(err) => { + let stderr = std::io::stderr(); + let mut stderr = stderr.lock(); + + writeln!( + stderr, + "{}: {}", + "Error parsing user language config".red(), + err + )?; + writeln!(stderr, "{}", "Using default language config".yellow())?; + default_syntax_loader() + } + }; let lang = match syn_loader_conf .language @@ -160,7 +196,7 @@ pub fn language(lang_str: String) { Some(l) => l, None => { let msg = format!("Language '{}' not found", lang_str); - println!("{}", msg.red()); + writeln!(stdout, "{}", msg.red())?; let suggestions: Vec<&str> = syn_loader_conf .language .iter() @@ -169,9 +205,13 @@ pub fn language(lang_str: String) { .collect(); if !suggestions.is_empty() { let suggestions = suggestions.join(", "); - println!("Did you mean one of these: {} ?", suggestions.yellow()); + writeln!( + stdout, + "Did you mean one of these: {} ?", + suggestions.yellow() + )?; } - return; + return Ok(()); } }; @@ -180,41 +220,66 @@ pub fn language(lang_str: String) { lang.language_server .as_ref() .map(|lsp| lsp.command.to_string()), - ); + )?; probe_protocol( "debug adapter", lang.debugger.as_ref().map(|dap| dap.command.to_string()), - ); + )?; for ts_feat in TsFeature::all() { - probe_treesitter_feature(&lang_str, *ts_feat) + probe_treesitter_feature(&lang_str, *ts_feat)? } + + Ok(()) } /// Display diagnostics about LSP and DAP. -fn probe_protocol(protocol_name: &str, server_cmd: Option) { +fn probe_protocol(protocol_name: &str, server_cmd: Option) -> std::io::Result<()> { + let stdout = std::io::stdout(); + let mut stdout = stdout.lock(); + let cmd_name = match server_cmd { Some(ref cmd) => cmd.as_str().green(), None => "None".yellow(), }; - println!("Configured {}: {}", protocol_name, cmd_name); + writeln!(stdout, "Configured {}: {}", protocol_name, cmd_name)?; if let Some(cmd) = server_cmd { let path = match which::which(&cmd) { Ok(path) => path.display().to_string().green(), Err(_) => "Not found in $PATH".to_string().red(), }; - println!("Binary for {}: {}", protocol_name, path); + writeln!(stdout, "Binary for {}: {}", protocol_name, path)?; } + + Ok(()) } /// Display diagnostics about a feature that requires tree-sitter /// query files (highlights, textobjects, etc). -fn probe_treesitter_feature(lang: &str, feature: TsFeature) { +fn probe_treesitter_feature(lang: &str, feature: TsFeature) -> std::io::Result<()> { + let stdout = std::io::stdout(); + let mut stdout = stdout.lock(); + let found = match load_runtime_file(lang, feature.runtime_filename()).is_ok() { true => "Found".green(), false => "Not found".red(), }; - println!("{} queries: {}", feature.short_title(), found); + writeln!(stdout, "{} queries: {}", feature.short_title(), found)?; + + Ok(()) +} + +pub fn print_health(health_arg: Option) -> std::io::Result<()> { + match health_arg.as_deref() { + Some("all") => languages_all()?, + Some(lang) => language(lang.to_string())?, + None => { + general()?; + writeln!(std::io::stdout().lock())?; + languages_all()?; + } + } + Ok(()) } diff --git a/helix-term/src/main.rs b/helix-term/src/main.rs index 0385d92c..4a3434d1 100644 --- a/helix-term/src/main.rs +++ b/helix-term/src/main.rs @@ -88,16 +88,14 @@ FLAGS: } if args.health { - if let Some(lang) = args.health_arg { - match lang.as_str() { - "all" => helix_term::health::languages_all(), - _ => helix_term::health::language(lang), + if let Err(err) = helix_term::health::print_health(args.health_arg) { + // Piping to for example `head -10` requires special handling: + // https://stackoverflow.com/a/65760807/7115678 + if err.kind() != std::io::ErrorKind::BrokenPipe { + return Err(err.into()); } - } else { - helix_term::health::general(); - println!(); - helix_term::health::languages_all(); } + std::process::exit(0); }