chore: frizbee as a feature and remove quotes from output-format (#1062)

* fix: remove quotes from output-format

* chore: add frizbee feature

Author: LoricAndre

.envrc.local

@@ -32,3 +32,6 @@ __pycache__/
 
 # Vagrant
 .vagrant/
+
+.envrc.local
+/public

.gitignore

@@ -13,11 +13,24 @@ edition = "2024"
 rust-version = "1.91"
 default-run = "sk"
 
-[package.metadata.wix]
-upgrade-guid = "6DDAED06-EBE2-41C4-94F5-CB03F2A4B92E"
-path-guid = "05D1A327-19E0-4C82-B5EC-6B28E40C691B"
-license = false
-eula = false
+[lib]
+name = "skim"
+path = "src/lib.rs"
+
+[[bin]]
+name = "sk"
+path = "src/bin/main.rs"
+required-features = ["cli"]
+
+[features]
+# Default is destined to the CLI, not to library usage.
+default = ["cli", "frizbee"]
+# Everyting needed to use skim as a cli (argument parsing, shell integrations...). This should not be needed for most libraries.
+cli = ["dep:clap", "dep:clap_complete", "dep:shlex", "dep:env_logger", "dep:clap_mangen"]
+# Include frizbee as a matching algorithm
+frizbee = ["dep:frizbee"]
+# Enable gungraun (Valgrind-based) benchmarks
+gungraun = ["dep:gungraun"]
 
 [profile.release]
 lto = true
@@ -34,64 +47,51 @@ inherits = "release"
 debug = true
 strip = false
 
-
-[lib]
-name = "skim"
-path = "src/lib.rs"
-
-[[bin]]
-name = "sk"
-path = "src/bin/main.rs"
-required-features = ["cli"]
-
 [dependencies]
 ansi-to-tui = "8.0.1"
-assert_enum_variants = "=0.1.2"
+assert_enum_variants = "0.1.2"
 clap = { version = "4.6.0" , optional = true, features = ["cargo", "derive", "unstable-markdown"] }
 clap_complete = { version = "4.6.0", optional = true }
 clap_complete_nushell = "4.6.0"
-clap_mangen = { version = "=0.3.0", optional = true }
-color-eyre = "=0.6.5"
+clap_mangen = { version = "0.3.0", optional = true }
+color-eyre = "0.6.5"
+# Crossterm's version is selected by ratatui
 crossterm = { version = ">=0.0.0", features = ["event-stream", "use-dev-tty", "libc"] }
-derive_builder = "=0.20.2"
+derive_builder = "0.20.2"
 derive_more = { version = "2.1.1", features = ["debug", "eq"] }
 env_logger = { version = "0.11.10", optional = true, features = ["humantime"] }
-futures = "=0.3.32"
+futures = "0.3.32"
 gungraun = { version = "0.18.1", optional = true }
 indexmap = "2.13.1"
 interprocess = { version = "2.4.0", features = ["tokio"] }
-kanal = "=0.1.1"
+kanal = "0.1.1"
 log = "0.4.29"
 memchr = "2.8.0"
 mimalloc = { version = "0.1.48", features = ["v3"] }
 nix = { version = "0.31.2", features = ["fs", "poll"] }
-portable-pty = "=0.9.0"
+portable-pty = "0.9.0"
 ratatui = "0.30.0"
 regex = "1.12.3"
 roff = "1.1.1"
-ron = "=0.12.1"
+ron = "0.12.1"
 serde = { version = "1.0.228", features = ["derive"] }
-shell-quote = "=0.7.2"
-shlex = { version = "=1.3.0", optional = true }
+shell-quote = "0.7.2"
+shlex = { version = "1.3.0", optional = true }
 tempfile = "3.27.0"
 thiserror = "2.0.18"
 thread_local = "1.1.9"
 tokio = { version = "1.51.0", features = ["macros", "net", "rt-multi-thread", "sync", "time", "tokio-macros"] }
-tokio-util = "=0.7.18"
-tui-term = "=0.3.4"
-unicode-display-width = "=0.3.0"
-unicode-normalization = "=0.1.25"
+tokio-util = "0.7.18"
+tui-term = "0.3.4"
+unicode-display-width = "0.3.0"
+unicode-normalization = "0.1.25"
 which = "8.0.2"
 
 [target.'cfg(any(target_arch = "x86_64", target_arch = "aarch64"))'.dependencies]
-frizbee = { version = "=0.9.0" }
+frizbee = { version = "=0.9.0", optional = true }
 
-[features]
-default = ["cli"]
-# Everyting needed to use skim as a cli (argument parsing, shell integrations...)
-cli = ["dep:clap", "dep:clap_complete", "dep:shlex", "dep:env_logger", "dep:clap_mangen"]
-# Enable gungraun (Valgrind-based) benchmarks
-gungraun = ["dep:gungraun"]
+[build-dependencies]
+cfg_aliases = "0.2.1"
 
 [dev-dependencies]
 criterion = { version = "0.8.2", features = ["async_tokio"] }
@@ -129,3 +129,9 @@ required-features = ["gungraun"]
 name = "cli"
 harness = false
 bench = false
+
+[package.metadata.wix]
+upgrade-guid = "6DDAED06-EBE2-41C4-94F5-CB03F2A4B92E"
+path-guid = "05D1A327-19E0-4C82-B5EC-6B28E40C691B"
+license = false
+eula = false

Cargo.lock

@@ -0,0 +1,11 @@
+use cfg_aliases::cfg_aliases;
+
+fn main() {
+    // Setup cfg aliases
+    cfg_aliases! {
+        // Platforms
+        frizbee_simd: { any(target_arch = "x86_64", target_arch = "aarch64") },
+        // Backends
+        frizbee: { all(feature = "frizbee", frizbee_simd) }
+    }
+}

Cargo.toml

@@ -108,10 +108,15 @@ Start in regex mode instead of fuzzy\-match
 \fB\-\-algo\fR \fI<ALGORITHM>\fR [default: arinae]
 Fuzzy matching algorithm
 
-arinae (ari) Latest algorithm
-`skim_v2` Legacy skim algorithm
-clangd  Used in clangd for keyword completion
-fzy     Algorithm from fzy (<https://github.com/jhawthorn/fzy>)
+\- arinae (ari) Latest algorithm
+
+\- `skim_v2` Legacy skim algorithm
+
+\- clangd  Used in clangd for keyword completion
+
+\- fzy     Algorithm from fzy (<https://github.com/jhawthorn/fzy>)
+
+\- frizbee Algorithm used in the blink.cmp neovim plugin, supported on aarch64 and x86 only
 .br
 
 .br

build.rs

@@ -204,7 +204,7 @@ fn sk_main(mut opts: SkimOptions) -> Result<i32> {
                     &result.current,
                     &result.query,
                     &result.cmd,
-                    true
+                    false
                 ),
                 bin_options.output_ending
             )?;

man/man1/sk.1

@@ -3,7 +3,7 @@ use std::fmt::{Display, Error, Formatter};
 use std::sync::Arc;
 
 use crate::fuzzy_matcher::arinae::ArinaeMatcher;
-#[cfg(any(target_arch = "x86_64", target_arch = "aarch64"))]
+#[cfg(frizbee)]
 use crate::fuzzy_matcher::frizbee::FrizbeeMatcher;
 use crate::fuzzy_matcher::{FuzzyMatcher, clangd::ClangdMatcher, fzy::FzyMatcher, skim::SkimMatcherV2};
 
@@ -17,19 +17,19 @@ use crate::{MatchRange, MatchResult, SkimItem};
 #[cfg_attr(feature = "cli", derive(clap::ValueEnum))]
 #[cfg_attr(feature = "cli", clap(rename_all = "snake_case"))]
 pub enum FuzzyAlgorithm {
-    /// Improved skim fuzzy matching algorithm (v2)
-    SkimV2,
+    /// Arinae: typo-resistant & natural algorithm, default
+    #[cfg_attr(feature = "cli", clap(alias = "ari"))]
+    #[default]
+    Arinae,
     /// Clangd fuzzy matching algorithm
     Clangd,
     /// Fzy matching algorithm (<https://github.com/jhawthorn/fzy>)
     Fzy,
     /// Frizbee matching algorithm, typo resistant (`x86_64` and `aarch64` only)
-    #[cfg(any(target_arch = "x86_64", target_arch = "aarch64"))]
+    #[cfg(frizbee)]
     Frizbee,
-    /// Arinae: typo-resistant & natural algorithm, default
-    #[cfg_attr(feature = "cli", clap(alias = "ari"))]
-    #[default]
-    Arinae,
+    /// Previous skim fuzzy matching algorithm (v2)
+    SkimV2,
 }
 
 const BYTES_1M: usize = 1024 * 1024 * 1024;
@@ -127,7 +127,7 @@ impl FuzzyEngineBuilder {
                 debug!("Initialized Clangd algorithm");
                 Box::new(matcher)
             }
-            #[cfg(any(target_arch = "x86_64", target_arch = "aarch64"))]
+            #[cfg(frizbee)]
             FuzzyAlgorithm::Frizbee => Box::new(FrizbeeMatcher::default().case(self.case).max_typos(max_typos)),
             FuzzyAlgorithm::Fzy => {
                 let matcher = FzyMatcher::default().max_typos(max_typos);

src/bin/main.rs

@@ -7,7 +7,7 @@
 pub mod arinae;
 /// Clangd fuzzy matching algorithm
 pub mod clangd;
-#[cfg(any(target_arch = "x86_64", target_arch = "aarch64"))]
+#[cfg(frizbee)]
 pub mod frizbee;
 /// Fzy fuzzy matching algorithm
 pub mod fzy;

src/engine/fuzzy.rs

@@ -173,10 +173,15 @@ pub struct SkimOptions {
 
     /// Fuzzy matching algorithm
     ///
-    /// arinae (ari) Latest algorithm
-    /// `skim_v2` Legacy skim algorithm
-    /// clangd  Used in clangd for keyword completion
-    /// fzy     Algorithm from fzy (<https://github.com/jhawthorn/fzy>)
+    /// - arinae (ari) Latest algorithm
+    ///
+    /// - `skim_v2` Legacy skim algorithm
+    ///
+    /// - clangd  Used in clangd for keyword completion
+    ///
+    /// - fzy     Algorithm from fzy (<https://github.com/jhawthorn/fzy>)
+    ///
+    /// - frizbee Algorithm used in the blink.cmp neovim plugin, supported on aarch64 and x86 only
     #[cfg_attr(
         feature = "cli",
         arg(