chore: add --stdin-paths and -stdin-paths0

Author: dpc

crates/typos-cli/src/bin/typos-cli/args.rs

@@ -44,9 +44,17 @@ impl Default for Format {
 #[command(group = clap::ArgGroup::new("mode").multiple(false))]
 pub(crate) struct Args {
     /// Paths to check with `-` for stdin
-    #[arg(default_value = ".")]
+    #[arg(default_value = ".", group = "source")]
     pub(crate) path: Vec<std::path::PathBuf>,
 
+    /// Read the list of newline separated paths from stdin
+    #[arg(long, group = "source")]
+    pub(crate) stdin_paths: bool,
+
+    /// Read the list of '\0' separated paths from stdin
+    #[arg(long, group = "source")]
+    pub(crate) stdin_paths0: bool,
+
     /// Custom config file
     #[arg(short = 'c', long = "config")]
     pub(crate) custom_config: Option<std::path::PathBuf>,
@@ -104,6 +112,12 @@ pub(crate) struct Args {
     pub(crate) verbose: clap_verbosity_flag::Verbosity,
 }
 
+impl Args {
+    pub fn is_using_stdin_paths(&self) -> bool {
+        self.stdin_paths || self.stdin_paths0
+    }
+}
+
 #[derive(Debug, Clone, clap::Args)]
 #[command(rename_all = "kebab-case")]
 pub(crate) struct FileArgs {

crates/typos-cli/src/bin/typos-cli/main.rs

@@ -1,4 +1,5 @@
-use std::io::Write;
+use std::io::{Read as _, Write as _};
+use std::path::PathBuf;
 
 use clap::Parser;
 
@@ -156,8 +157,29 @@ fn run_checks(args: &args::Args) -> proc_exit::ExitResult {
 
     let mut typos_found = false;
     let mut errors_found = false;
-    for path in args.path.iter() {
+
+    let stdin_paths = if args.stdin_paths {
+        Some(
+            std::io::stdin()
+                .lines()
+                .map(|res| res.map(PathBuf::from))
+                .collect::<Result<_, _>>()
+                .with_code(proc_exit::sysexits::IO_ERR)?,
+        )
+    } else if args.stdin_paths0 {
+        Some(unix_read_paths_from_stdin()?)
+    } else {
+        None
+    };
+
+    // Note: stdin_paths and args.path are mutually exclusive, enforced by clap
+    for path in stdin_paths.as_ref().unwrap_or(&args.path) {
+        // Note paths are passed through stdin, `-` is treated like a normal path
         let cwd = if path == std::path::Path::new("-") {
+            if args.is_using_stdin_paths() {
+                return proc_exit::sysexits::USAGE_ERR
+                    .with_message("Can't use `-` (stdin) while using stdin provided paths");
+            };
             global_cwd.clone()
         } else if path.is_file() {
             let mut cwd = path
@@ -269,6 +291,39 @@ fn run_checks(args: &args::Args) -> proc_exit::ExitResult {
     }
 }
 
+#[cfg(target_family = "unix")]
+fn unix_read_paths_from_stdin() -> Result<Vec<PathBuf>, proc_exit::Exit> {
+    use std::ffi::OsString;
+    use std::os::unix::ffi::OsStringExt;
+
+    let mut buf = Vec::new();
+    std::io::stdin()
+        .read_to_end(&mut buf)
+        .with_code(proc_exit::sysexits::IO_ERR)?;
+
+    let (mut paths, rest) = buf.into_iter().fold(
+        (vec![], vec![]),
+        |(mut paths, mut cur_path): (Vec<PathBuf>, Vec<u8>), byte| {
+            if byte == 0 {
+                paths.push(PathBuf::from(OsString::from_vec(cur_path)));
+                (paths, vec![])
+            } else {
+                cur_path.push(byte);
+                (paths, cur_path)
+            }
+        },
+    );
+    if !rest.is_empty() {
+        paths.push(PathBuf::from(OsString::from_vec(rest)));
+    }
+    Ok(paths)
+}
+
+#[cfg(not(target_family = "unix"))]
+fn unix_read_paths_from_stdin() -> Result<Vec<PathBuf>, proc_exit::Exit> {
+    proc_exit::sysexits::CONFIG_ERR.with_message("Reading zero-separated paths is not supported on Windows. PRs are welcome.")
+}
+
 fn init_logging(level: Option<log::Level>) {
     if let Some(level) = level {
         let mut builder = env_logger::Builder::new();

crates/typos-cli/tests/cli_tests.rs

@@ -1,5 +1,7 @@
 #[test]
 #[cfg(feature = "dict")]
 fn cli_tests() {
-    trycmd::TestCases::new().case("tests/cmd/*.toml");
+    trycmd::TestCases::new()
+        .case("tests/cmd/*.toml")
+        .case("tests/cmd/*.trycmd");
 }

crates/typos-cli/tests/cmd/stdin-paths.in/_typos.toml

@@ -0,0 +1,8 @@
+[files]
+extend-exclude = ["_typos.toml"]
+
+[default.extend-identifiers]
+hello = "goodbye"
+
+[type.fail]
+extend-glob = ["*.fail"]

crates/typos-cli/tests/cmd/stdin-paths.in/a.fail

@@ -0,0 +1 @@
+hello

crates/typos-cli/tests/cmd/stdin-paths.in/b.fail

@@ -0,0 +1 @@
+hello

crates/typos-cli/tests/cmd/stdin-paths.in/c.fail

@@ -0,0 +1 @@
+hello

crates/typos-cli/tests/cmd/stdin-paths.in/d.fail

@@ -0,0 +1 @@
+hello

crates/typos-cli/tests/cmd/stdin-paths.toml

@@ -0,0 +1,22 @@
+bin.name = "typos"
+args = "--stdin-paths"
+stdin = """
+b.fail
+d.fail
+"""
+stdout = """
+error: `hello` should be `goodbye`
+  --> b.fail:1:1
+  |
+1 | hello
+  | ^^^^^
+  |
+error: `hello` should be `goodbye`
+  --> d.fail:1:1
+  |
+1 | hello
+  | ^^^^^
+  |
+"""
+stderr = ""
+status.code = 2

crates/typos-cli/tests/cmd/stdin-paths0.in/_typos.toml

@@ -0,0 +1,8 @@
+[files]
+extend-exclude = ["_typos.toml"]
+
+[default.extend-identifiers]
+hello = "goodbye"
+
+[type.fail]
+extend-glob = ["*.fail"]