feat: make blob-diffing a feature so it can be turned off by adding the blob feature (enabled by default)

Author: Byron

Cargo.lock

@@ -11,6 +11,9 @@ rust-version = "1.65"
 autotests = false
 
 [features]
+default = ["blob"]
+## Enable diffing of blobs using imara-diff.
+blob = ["dep:imara-diff"]
 ## Data structures implement `serde::Serialize` and `serde::Deserialize`.
 serde = ["dep:serde", "gix-hash/serde", "gix-object/serde"]
 ## Make it possible to compile to the `wasm32-unknown-unknown` target.
@@ -23,6 +26,13 @@ doctest = false
 gix-hash = { version = "^0.11.4", path = "../gix-hash" }
 gix-object = { version = "^0.34.0", path = "../gix-object" }
 thiserror = "1.0.32"
-imara-diff = "0.1.3"
+imara-diff = { version = "0.1.3", optional = true }
 serde = { version = "1.0.114", optional = true, default-features = false, features = ["derive"]}
 getrandom = { version = "0.2.8", optional = true, default-features = false, features = ["js"] }
+
+document-features = { version = "0.2.0", optional = true }
+
+[package.metadata.docs.rs]
+all-features = true
+features = ["document-features"]
+rustdoc-args = ["--cfg", "docsrs"]

gix-diff/Cargo.toml

@@ -1,9 +1,16 @@
 //! Algorithms for diffing various git object types and for generating patches, highly optimized for performance.
+//! ## Feature Flags
+#![cfg_attr(
+feature = "document-features",
+cfg_attr(doc, doc = ::document_features::document_features!())
+)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms)]
 #![forbid(unsafe_code)]
 
 ///
 pub mod tree;
 
 ///
+#[cfg(feature = "blob")]
 pub mod blob;

gix-diff/src/lib.rs

@@ -99,6 +99,7 @@ check:
     cargo check -p gix-config-value
     cargo check -p gix-config --all-features
     cargo check -p gix-config
+    cargo check -p gix-diff --no-default-features
     cargo check -p gix-transport
     cargo check -p gix-transport --features blocking-client
     cargo check -p gix-transport --features async-client