feat: git_discover::is_git() can detect submodule dirs correctly en…

…ough. (#482) We currently detect them as possibly bare, which could be improved if we allow ourselves to see `.git/modules` as `submodule` always.
Byron · Aug 17, 2022 · aa6fd97 · aa6fd97
1 parent 9133141
commit aa6fd97
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/git-discover/src/is.rs b/git-discover/src/is.rs
@@ -118,7 +118,22 @@ pub fn git(git_dir: impl AsRef<Path>) -> Result<crate::repository::Kind, crate::
             if bare(git_dir) {
                 crate::repository::Kind::Bare
             } else {
-                crate::repository::Kind::WorkTree { linked_git_dir: None }
+                let mut last_comp = None;
+                if git_dir.file_name() != Some(OsStr::new(DOT_GIT_DIR))
+                    && git_dir.components().rev().any(|c| {
+                        if c.as_os_str() == OsStr::new(DOT_GIT_DIR) {
+                            true
+                        } else {
+                            last_comp = Some(c.as_os_str());
+                            false
+                        }
+                    })
+                    && last_comp == Some(OsStr::new("modules"))
+                {
+                    crate::repository::Kind::Bare
+                } else {
+                    crate::repository::Kind::WorkTree { linked_git_dir: None }
+                }
             }
         }
     })

diff --git a/git-discover/src/repository.rs b/git-discover/src/repository.rs
@@ -98,6 +98,7 @@ pub enum Kind {
     /// A bare repository does not have a work tree, that is files on disk beyond the `git` repository itself.
     ///
     /// Note that this is merely a guess at this point as we didn't read the configuration yet.
+    /// It might also be the clone of a submodule in `.git/modules` which has its worktree configured with `core.worktree`.
     Bare,
     /// A `git` repository along with a checked out files in a work tree.
     WorkTree {

diff --git a/git-discover/tests/upwards/mod.rs b/git-discover/tests/upwards/mod.rs
@@ -291,7 +291,6 @@ mod submodules {
     }
 
     #[test]
-    #[ignore]
     fn by_their_module_git_dir() -> crate::Result {
         let dir = git_testtools::scripted_fixture_repo_read_only("make_submodules.sh")?;
         let modules = dir.join("with-submodules").join(".git").join("modules");