feat: hide progress bar if input is stdin only (#1938)

Author: mre

lychee-bin/src/commands/check.rs

@@ -61,7 +61,7 @@ where
         accept,
     ));
 
-    let hide_bar = params.cfg.no_progress;
+    let hide_bar = params.cfg.no_progress || params.is_stdin_input;
     let level = params.cfg.verbose().log_level();
 
     let progress = Progress::new("Extracting links", hide_bar, level, &params.cfg.mode());

lychee-bin/src/commands/mod.rs

@@ -22,6 +22,7 @@ pub(crate) struct CommandParams<S: futures::Stream<Item = Result<Request, Reques
     pub(crate) cache: Cache,
     pub(crate) requests: S,
     pub(crate) cfg: Config,
+    pub(crate) is_stdin_input: bool,
 }
 
 /// Creates a writer that outputs to a file or stdout.

lychee-bin/src/main.rs

@@ -59,7 +59,7 @@
 #![deny(missing_docs)]
 
 use std::fs::{self, File};
-use std::io::{self, BufRead, BufReader, ErrorKind};
+use std::io::{self, BufRead, BufReader, ErrorKind, IsTerminal, stdin};
 use std::path::PathBuf;
 
 use anyhow::{Context, Error, Result};
@@ -301,6 +301,22 @@ fn underlying_io_error_kind(error: &Error) -> Option<io::ErrorKind> {
 async fn run(opts: &LycheeOptions) -> Result<i32> {
     let inputs = opts.inputs()?;
 
+    // Hide the progress bar only when stdin is the sole input and it is
+    // interactive (TTY).
+    //
+    // We restrict this to the sole-input case because with mixed inputs like
+    // `lychee - README.md` the file is processed concurrently with stdin, so
+    // the order of completion is non-deterministic. Hiding the bar there would
+    // be confusing rather than helpful.
+    //
+    // When stdin is piped (`cat links.txt | lychee -`), `is_terminal()` returns
+    // false, so the progress bar is shown normally.
+    let is_stdin_input = inputs.len() == 1
+        && inputs
+            .iter()
+            .any(|input| matches!(input.source, lychee_lib::InputSource::Stdin))
+        && stdin().is_terminal();
+
     // TODO: Remove this section after `--base` got removed with 1.0
     let base = match (opts.config.base.clone(), opts.config.base_url.clone()) {
         (None, base_url) => base_url,
@@ -367,6 +383,7 @@ async fn run(opts: &LycheeOptions) -> Result<i32> {
         cache,
         requests,
         cfg: opts.config.clone(),
+        is_stdin_input,
     };
 
     let exit_code = if opts.config.dump {

lychee-lib/src/types/input/input.rs

@@ -13,6 +13,7 @@ use crate::{ErrorKind, LycheeResult};
 use async_stream::try_stream;
 use futures::stream::{Stream, StreamExt};
 use log::debug;
+use std::io::IsTerminal;
 use std::path::{Path, PathBuf};
 use tokio::io::{AsyncReadExt, stdin};
 
@@ -271,7 +272,10 @@ impl Input {
         let mut content = String::new();
         let mut stdin = stdin();
 
-        debug!("Reading content from stdin"); // useful info when nothing piped and process blocks
+        if std::io::stdin().is_terminal() {
+            // useful info when nothing piped and process blocks
+            debug!("Reading content from stdin");
+        }
         stdin.read_to_string(&mut content).await?;
 
         let input_content = InputContent {