Skip to content

feat(gix): support diff.ignoreSubmodules overrides in status #2107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 9, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions gix/src/status/index_worktree.rs
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ mod submodule_status {

use crate::{
bstr,
bstr::BStr,
bstr::{BStr, BString},
status::{index_worktree::BuiltinSubmoduleStatus, Submodule},
};

Expand Down Expand Up @@ -247,6 +247,8 @@ mod submodule_status {
SubmoduleStatus(#[from] crate::submodule::status::Error),
#[error(transparent)]
IgnoreConfig(#[from] crate::submodule::config::Error),
#[error("The value of 'diff.submoduleIgnore' was invalid: '{actual}'")]
DiffSubmoduleIgnoreConfig { actual: BString },
}

impl gix_status::index_as_worktree::traits::SubmoduleStatus for BuiltinSubmoduleStatus {
Expand Down Expand Up @@ -275,7 +277,23 @@ mod submodule_status {
return Ok(None);
};
let (ignore, check_dirty) = match self.mode {
Submodule::AsConfigured { check_dirty } => (sm.ignore()?.unwrap_or_default(), check_dirty),
Submodule::AsConfigured { check_dirty } => {
// diff.ignoreSubmodules is the global setting, and if it exists, it overrides the submodule's own ignore setting.
let global_ignore = repo.config_snapshot().string("diff.ignoreSubmodules");
if let Some(ignore_str) = global_ignore {
let ignore = ignore_str
.as_ref()
.try_into()
.map_err(|_| Error::DiffSubmoduleIgnoreConfig {
actual: ignore_str.into_owned(),
})?;
(ignore, check_dirty)
} else {
// If no global ignore is set, use the submodule's ignore setting.
let ignore = sm.ignore()?.unwrap_or_default();
(ignore, check_dirty)
}
}
Submodule::Given { ignore, check_dirty } => (ignore, check_dirty),
};
let status = sm.status(ignore, check_dirty)?;
Expand Down
5 changes: 3 additions & 2 deletions gix/src/status/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ where
/// How to obtain a submodule's status.
#[derive(Copy, Clone, Debug, Ord, PartialOrd, Eq, PartialEq, Hash)]
pub enum Submodule {
/// Use the ['ignore' value](crate::Submodule::ignore) to determine which submodules
/// participate in the status query, and to which extent.
/// Use the `diff.submoduleIgnore` configuration to determine, or if not set,
/// use the submodule's own ['ignore' value](crate::Submodule::ignore) to determine
/// which submodules participate in the status query, and to which extent.
AsConfigured {
/// If `true`, default `false`, the computation will stop once the first in a ladder operations
/// ordered from cheap to expensive shows that the submodule is dirty.
Expand Down
Loading