feat: add excludes feature to make exclude-checks possible.

Author: Byron

gix/Cargo.toml

@@ -51,15 +51,24 @@ default = ["max-performance-safe", "comfort", "basic", "extras"]
 basic = ["blob-diff", "revision"]
 
 ## Various additional features and capabilities that are not necessarily part of what most users would need.
-extras = ["worktree-stream", "worktree-archive", "revparse-regex", "mailmap"]
+extras = ["worktree-stream", "worktree-archive", "revparse-regex", "mailmap", "excludes", "attributes", "worktree-mutation"]
 
 ## Various progress-related features that improve the look of progress message units.
 comfort = ["gix-features/progress-unit-bytes", "gix-features/progress-unit-human-numbers"]
 
 #! #### Components
 #!
 #! A component is a distinct feature which may be comprised of one or more methods around a particular topic.
-#! Providers of libraries should only activate
+#! Providers of libraries should only activate the components they need.
+
+## Various ways to alter the worktree makeup by checkout and reset.
+worktree-mutation = ["attributes", "dep:gix-worktree-state"]
+
+## Retrieve a worktree stack for querying exclude information
+excludes = ["dep:gix-ignore", "dep:gix-worktree"]
+
+## Query attributes and excludes. Enables access to pathspecs, worktree checkouts, filter-pipelines and submodules.
+attributes = ["excludes", "dep:gix-filter", "dep:gix-pathspec", "dep:gix-attributes", "dep:gix-submodule", "gix-worktree?/attributes"]
 
 ## Add support for mailmaps, as way of determining the final name of commmiters and authors.
 mailmap = ["dep:gix-mailmap"]
@@ -76,13 +85,13 @@ revparse-regex = ["regex", "revision"]
 blob-diff = ["gix-diff/blob"]
 
 ## Make it possible to turn a tree into a stream of bytes, which can be decoded to entries and turned into various other formats.
-worktree-stream = ["gix-worktree-stream"]
+worktree-stream = ["gix-worktree-stream", "attributes"]
 
 ## Create archives from a tree in the repository, similar to what `git archive` does.
 ##
 ## Note that we disable all default features which strips it off all container support, like `tar` and `zip`.
 ## Your application should add it as dependency and re-activate the desired features.
-worktree-archive = ["gix-archive", "worktree-stream"]
+worktree-archive = ["gix-archive", "worktree-stream", "attributes"]
 
 #! #### Mutually Exclusive Network Client
 #!
@@ -91,11 +100,11 @@ worktree-archive = ["gix-archive", "worktree-stream"]
 #! Making a choice here also affects which crypto-library ends up being used.
 
 ## Make `gix-protocol` available along with an async client.
-async-network-client = ["gix-protocol/async-client", "gix-pack/streaming-input"]
+async-network-client = ["gix-protocol/async-client", "gix-pack/streaming-input", "attributes"]
 ## Use this if your crate uses `async-std` as runtime, and enable basic runtime integration when connecting to remote servers via the `git://` protocol.
 async-network-client-async-std = ["async-std", "async-network-client", "gix-transport/async-std"]
 ## Make `gix-protocol` available along with a blocking client, providing access to the `file://`, git://` and `ssh://` transports.
-blocking-network-client = ["gix-protocol/blocking-client", "gix-pack/streaming-input"]
+blocking-network-client = ["gix-protocol/blocking-client", "gix-pack/streaming-input", "attributes"]
 ## Stacks with `blocking-network-client` to provide support for HTTP/S using **curl**, and implies blocking networking as a whole, making the `https://` transport avaialble.
 blocking-http-transport-curl = ["blocking-network-client", "gix-transport/http-client-curl"]
 ## Stacks with `blocking-network-client` to provide support for HTTP/S using **reqwest**, and implies blocking networking as a whole, making the `https://` transport avaialble.
@@ -155,10 +164,10 @@ serde = [   "dep:serde",
     "gix-index/serde",
     "gix-mailmap?/serde",
     "gix-url/serde",
-    "gix-attributes/serde",
-    "gix-ignore/serde",
+    "gix-attributes?/serde",
+    "gix-ignore?/serde",
     "gix-revision/serde",
-    "gix-worktree/serde",
+    "gix-worktree?/serde",
     "gix-commitgraph/serde",
     "gix-credentials/serde"]
 
@@ -182,7 +191,7 @@ gix-validate = { version = "^0.8.0", path = "../gix-validate" }
 gix-sec = { version = "^0.9.0", path = "../gix-sec" }
 gix-date = { version = "^0.7.4", path = "../gix-date" }
 gix-refspec = { version = "^0.16.0", path = "../gix-refspec" }
-gix-filter = { version = "^0.3.0", path = "../gix-filter" }
+gix-filter = { version = "^0.3.0", path = "../gix-filter", optional = true }
 
 gix-config = { version = "^0.28.0", path = "../gix-config" }
 gix-odb = { version = "^0.51.0", path = "../gix-odb" }
@@ -202,18 +211,18 @@ gix-mailmap = { version = "^0.17.0", path = "../gix-mailmap", optional = true }
 gix-features = { version = "^0.33.0", path = "../gix-features", features = ["progress", "once_cell"] }
 gix-trace = { version = "^0.1.3", path = "../gix-trace" }
 
-gix-attributes = { version = "^0.17.0", path = "../gix-attributes" }
-gix-ignore = { version = "^0.6.0", path = "../gix-ignore" }
 gix-glob = { version = "^0.11.0", path = "../gix-glob" }
 gix-credentials = { version = "^0.18.0", path = "../gix-credentials" }
 gix-prompt = { version = "^0.6.0", path = "../gix-prompt" }
 gix-index = { version = "^0.23.1", path = "../gix-index" }
-gix-worktree = { version = "^0.25.0", path = "../gix-worktree" }
-gix-worktree-state = { version = "^0.2.0", path = "../gix-worktree-state" }
+gix-attributes = { version = "^0.17.0", path = "../gix-attributes", optional = true }
+gix-ignore = { version = "^0.6.0", path = "../gix-ignore", optional = true }
+gix-worktree = { version = "^0.25.0", path = "../gix-worktree", optional = true, default-features = false }
+gix-worktree-state = { version = "^0.2.0", path = "../gix-worktree-state", optional = true }
 gix-hashtable = { version = "^0.3.0", path = "../gix-hashtable" }
 gix-commitgraph = { version = "^0.19.0", path = "../gix-commitgraph" }
-gix-pathspec = { version = "^0.1.0", path = "../gix-pathspec" }
-gix-submodule = { version = "^0.2.0", path = "../gix-submodule" }
+gix-pathspec = { version = "^0.1.0", path = "../gix-pathspec", optional = true }
+gix-submodule = { version = "^0.2.0", path = "../gix-submodule", optional = true }
 
 gix-worktree-stream = { version = "^0.3.0", path = "../gix-worktree-stream", optional = true }
 gix-archive = { version = "^0.3.0", path = "../gix-archive", default-features = false, optional = true }

gix/src/clone/fetch/mod.rs

@@ -149,7 +149,7 @@ impl PrepareFetch {
     }
 
     /// Similar to [`fetch_only()`][Self::fetch_only()`], but passes ownership to a utility type to configure a checkout operation.
-    #[cfg(feature = "blocking-network-client")]
+    #[cfg(all(feature = "worktree-mutation", feature = "blocking-network-client"))]
     pub fn fetch_then_checkout<P>(
         &mut self,
         progress: P,

gix/src/clone/mod.rs

@@ -122,6 +122,7 @@ impl PrepareFetch {
 /// A utility to collect configuration on how to perform a checkout into a working tree, and when dropped without checking out successfully
 /// the fetched repository will be dropped.
 #[must_use]
+#[cfg(feature = "worktree-mutation")]
 pub struct PrepareCheckout {
     /// A freshly initialized repository which is owned by us, or `None` if it was handed to the user
     pub(self) repo: Option<crate::Repository>,
@@ -165,4 +166,5 @@ mod access_feat {
 pub mod fetch;
 
 ///
+#[cfg(feature = "worktree-mutation")]
 pub mod checkout;

gix/src/config/cache/access.rs

@@ -1,7 +1,6 @@
 #![allow(clippy::result_large_err)]
 use std::{borrow::Cow, path::PathBuf, time::Duration};
 
-use gix_attributes::Source;
 use gix_lock::acquire::Fail;
 
 use crate::{
@@ -10,13 +9,11 @@ use crate::{
     config::{
         boolean,
         cache::util::{ApplyLeniency, ApplyLeniencyDefaultValue},
-        checkout_options,
-        tree::{gitoxide, Checkout, Core, Key},
+        tree::{Core, Key},
         Cache,
     },
-    filter, remote,
+    remote,
     repository::identity,
-    Repository,
 };
 
 /// Access
@@ -116,6 +113,7 @@ impl Cache {
     }
 
     /// The path to the user-level excludes file to ignore certain files in the worktree.
+    #[cfg(feature = "excludes")]
     pub(crate) fn excludes_file(&self) -> Option<Result<PathBuf, gix_config::path::interpolate::Error>> {
         self.trusted_file_path("core", None, Core::EXCLUDES_FILE.name)?
             .map(std::borrow::Cow::into_owned)
@@ -159,21 +157,23 @@ impl Cache {
     /// Collect everything needed to checkout files into a worktree.
     /// Note that some of the options being returned will be defaulted so safe settings, the caller might have to override them
     /// depending on the use-case.
+    #[cfg(feature = "worktree-mutation")]
     pub(crate) fn checkout_options(
         &self,
-        repo: &Repository,
+        repo: &crate::Repository,
         attributes_source: gix_worktree::stack::state::attributes::Source,
-    ) -> Result<gix_worktree_state::checkout::Options, checkout_options::Error> {
+    ) -> Result<gix_worktree_state::checkout::Options, crate::config::checkout_options::Error> {
+        use crate::config::tree::gitoxide;
         let git_dir = repo.git_dir();
         let thread_limit = self.apply_leniency(
             self.resolved
                 .integer_filter_by_key("checkout.workers", &mut self.filter_config_section.clone())
-                .map(|value| Checkout::WORKERS.try_from_workers(value)),
+                .map(|value| crate::config::tree::Checkout::WORKERS.try_from_workers(value)),
         )?;
         let capabilities = self.fs_capabilities()?;
         let filters = {
             let collection = Default::default();
-            let mut filters = gix_filter::Pipeline::new(&collection, filter::Pipeline::options(repo)?);
+            let mut filters = gix_filter::Pipeline::new(&collection, crate::filter::Pipeline::options(repo)?);
             if let Ok(mut head) = repo.head() {
                 let ctx = filters.driver_context_mut();
                 ctx.ref_name = head.referent_name().map(|name| name.as_bstr().to_owned());
@@ -217,6 +217,7 @@ impl Cache {
         })
     }
 
+    #[cfg(feature = "excludes")]
     pub(crate) fn assemble_exclude_globals(
         &self,
         git_dir: &std::path::Path,
@@ -236,12 +237,14 @@ impl Cache {
         ))
     }
     // TODO: at least one test, maybe related to core.attributesFile configuration.
+    #[cfg(feature = "attributes")]
     pub(crate) fn assemble_attribute_globals(
         &self,
         git_dir: &std::path::Path,
         source: gix_worktree::stack::state::attributes::Source,
         attributes: crate::open::permissions::Attributes,
     ) -> Result<(gix_worktree::stack::state::Attributes, Vec<u8>), config::attribute_stack::Error> {
+        use gix_attributes::Source;
         let configured_or_user_attributes = match self
             .trusted_file_path("core", None, Core::ATTRIBUTES_FILE.name)
             .transpose()?
@@ -276,9 +279,11 @@ impl Cache {
         Ok((state, buf))
     }
 
+    #[cfg(feature = "attributes")]
     pub(crate) fn pathspec_defaults(
         &self,
     ) -> Result<gix_pathspec::Defaults, gix_pathspec::defaults::from_environment::Error> {
+        use crate::config::tree::gitoxide;
         let res = gix_pathspec::Defaults::from_environment(&mut |name| {
             let key = [
                 &gitoxide::Pathspec::ICASE,
@@ -303,6 +308,7 @@ impl Cache {
         }
     }
 
+    #[cfg(any(feature = "attributes", feature = "excludes"))]
     pub(crate) fn xdg_config_path(
         &self,
         resource_file_name: &str,

gix/src/config/mod.rs

@@ -119,6 +119,7 @@ pub mod diff {
 }
 
 ///
+#[cfg(feature = "attributes")]
 pub mod checkout_options {
     /// The error produced when collecting all information needed for checking out files into a worktree.
     #[derive(Debug, thiserror::Error)]
@@ -520,6 +521,7 @@ pub(crate) struct Cache {
     /// If true, we should default what's possible if something is misconfigured, on case by case basis, to be more resilient.
     /// Also available in options! Keep in sync!
     pub lenient_config: bool,
+    #[cfg_attr(not(feature = "worktree-mutation"), allow(dead_code))]
     attributes: crate::open::permissions::Attributes,
     environment: crate::open::permissions::Environment,
     // TODO: make core.precomposeUnicode available as well.