feat(output): implement YAML and JSON output

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Features
 
+- Add `--yaml` flag for YAML format output. 
 
 ## Bugfixes
 

Cargo.toml

@@ -5,19 +5,13 @@ description = "fd is a simple, fast and user-friendly alternative to find."
 exclude = ["/benchmarks/*"]
 homepage = "https://github.com/sharkdp/fd"
 documentation = "https://docs.rs/fd-find"
-keywords = [
-    "search",
-    "find",
-    "file",
-    "filesystem",
-    "tool",
-]
+keywords = ["search", "find", "file", "filesystem", "tool"]
 license = "MIT OR Apache-2.0"
 name = "fd-find"
 readme = "README.md"
 repository = "https://github.com/sharkdp/fd"
 version = "10.3.0"
-edition= "2021"
+edition = "2021"
 rust-version = "1.77.2"
 
 [badges.appveyor]
@@ -49,6 +43,7 @@ jiff = "0.2.14"
 # For now, pin the `home` crate to less than 0.5.11, to ensure it works on older versions of rust
 # TODO: when we upgrade past rust 1.85, remove this dependency
 home = "=0.5.9"
+base64 = "0.22.1"
 
 [dependencies.clap]
 version = "4.5.48"
@@ -60,7 +55,11 @@ default-features = false
 features = ["nu-ansi-term"]
 
 [target.'cfg(unix)'.dependencies]
-nix = { version = "0.30.1", default-features = false, features = ["signal", "user", "hostname"] }
+nix = { version = "0.30.1", default-features = false, features = [
+    "signal",
+    "user",
+    "hostname",
+] }
 
 [target.'cfg(all(unix, not(target_os = "redox")))'.dependencies]
 libc = "0.2"
@@ -71,13 +70,14 @@ libc = "0.2"
 # This has to be kept in sync with src/main.rs where the allocator for
 # the program is set.
 [target.'cfg(all(not(windows), not(target_os = "android"), not(target_os = "macos"), not(target_os = "freebsd"), not(target_os = "openbsd"), not(target_os = "illumos"), not(all(target_env = "musl", target_pointer_width = "32")), not(target_arch = "riscv64")))'.dependencies]
-tikv-jemallocator = {version = "0.6.0", optional = true}
+tikv-jemallocator = { version = "0.6.0", optional = true }
 
 [dev-dependencies]
 diff = "0.1"
 tempfile = "3.23"
 filetime = "0.2"
 test-case = "3.3"
+serde_json = "1.0.145"
 
 [profile.release]
 lto = true

doc/fd.1

@@ -503,6 +503,23 @@ Maximum number of arguments to pass to the command given with -X. If the number
 greater than the given size, the command given with -X is run again with remaining arguments. A
 batch size of zero means there is no limit (default), but note that batching might still happen
 due to OS restrictions on the maximum length of command lines.
+.TP
+.BI "\-\-output "
+Specify a structured format to use for the output. The value can be plain (default), json, jsonl, or
+yaml.
+
+Currently, the default is "plain", and if the option is used without an argument "plain"
+is used. The available options are:
+.RS
+.IP plain
+Output the results as plain text (default).
+.IP json
+Output the results as a JSON array.
+.IP jsonl
+Output the results as JSON Lines (as known as NDJSON).
+.IP yaml
+Output the results as YAML.
+.RE
 .SH PATTERN SYNTAX
 The regular expression syntax used by fd is documented here:
 

src/cli.rs

@@ -647,6 +647,18 @@ pub struct Opts {
     )]
     search_path: Vec<PathBuf>,
 
+    /// Print results in a certain format so you can pipe it to tools.
+    #[arg(
+        long,
+        value_name = "output",
+        value_enum,
+        default_value_t = OutputFormat::Plain,
+        conflicts_with("format"),
+        conflicts_with("list_details"),
+        help = "Print results in a certain format so you can pipe it to tools."
+    )]
+    pub output: OutputFormat,
+
     /// By default, relative paths are prefixed with './' when -x/--exec,
     /// -X/--exec-batch, or -0/--print0 are given, to reduce the risk of a
     /// path starting with '-' being treated as a command line option. Use
@@ -824,6 +836,20 @@ pub enum HyperlinkWhen {
     Never,
 }
 
+#[derive(Copy, Clone, PartialEq, Eq, Debug, ValueEnum)]
+pub enum OutputFormat {
+    /// Plain text output (default)
+    Plain,
+    /// JSON output
+    Json,
+    /// JSONL (JSON Lines, as known as Newline Delimited JSON) output
+    #[value(alias = "ndjson")]
+    Jsonl,
+    /// YAML output
+    #[value(alias = "yml")]
+    Yaml,
+}
+
 // there isn't a derive api for getting grouped values yet,
 // so we have to use hand-rolled parsing for exec and exec-batch
 pub struct Exec {

src/config.rs

@@ -3,6 +3,7 @@ use std::{path::PathBuf, sync::Arc, time::Duration};
 use lscolors::LsColors;
 use regex::bytes::RegexSet;
 
+use crate::cli::OutputFormat;
 use crate::exec::CommandSet;
 use crate::filetypes::FileTypes;
 #[cfg(unix)]
@@ -130,6 +131,9 @@ pub struct Config {
 
     /// Whether or not to use hyperlinks on paths
     pub hyperlink: bool,
+
+    /// The output format to use
+    pub output: OutputFormat,
 }
 
 impl Config {

src/main.rs

@@ -326,6 +326,7 @@ fn construct_config(mut opts: Opts, pattern_regexps: &[String]) -> Result<Config
         actual_path_separator,
         max_results: opts.max_results(),
         strip_cwd_prefix: opts.strip_cwd_prefix(|| !(opts.null_separator || has_command)),
+        output: opts.output,
     })
 }