feat: add recurse-submodules option

README.md

@@ -80,11 +80,16 @@ To configure, these options are supported in your `pyproject.toml` file:
 sdist-only = []
 git-only = []
 default-ignore = true
+recurse-submodules = true
 ```
 
 You can add `.gitignore` style lines here, and you can turn off the default
 ignore list, which adds some default git-only files.
 
+By default, check-sdist recursively scans the contents of Git submodules, but
+you can disable this behavior (e.g. to support older Git versions that don't
+have this capability).
+
 ### See also
 
 - [check-manifest](https://github.com/mgedmin/check-manifest): A (currently)

src/check_sdist/__main__.py

@@ -27,9 +27,6 @@ def compare(source_dir: Path, *, isolated: bool, verbose: bool = False) -> int:
     conditions are true.
     """
 
-    sdist = sdist_files(source_dir, isolated) - {"PKG-INFO"}
-    git = git_files(source_dir)
-
     config = {}
     pyproject_toml = source_dir.joinpath("pyproject.toml")
     with contextlib.suppress(FileNotFoundError), pyproject_toml.open("rb") as f:
@@ -39,6 +36,10 @@ def compare(source_dir: Path, *, isolated: bool, verbose: bool = False) -> int:
     sdist_only_patterns = config.get("sdist-only", [])
     git_only_patterns = config.get("git-only", [])
     default_ignore = config.get("default-ignore", True)
+    recurse_submodules = config.get("recurse-submodules", True)
+
+    sdist = sdist_files(source_dir, isolated) - {"PKG-INFO"}
+    git = git_files(source_dir, recurse_submodules=recurse_submodules)
 
     if default_ignore:
         with resources.joinpath("default-ignore.txt").open("r", encoding="utf-8") as f:

src/check_sdist/git.py

@@ -4,10 +4,12 @@
 from pathlib import Path
 
 
-def git_files(source_dir: Path) -> frozenset[str]:
+def git_files(source_dir: Path, recurse_submodules: bool = True) -> frozenset[str]:
     """Return the files that are tracked by git in the source directory."""
 
     cmd = ["git", "ls-files", "--cached"]
+    if recurse_submodules:
+        cmd.append("--recurse-submodules")
     return frozenset(
         subprocess.run(
             cmd,

tests/downstream.toml

@@ -25,3 +25,7 @@ ref = "0.17.0"
 repo = "pybind/pybind11"
 ref = "v2.10.3"
 fail = 2
+
+[[packages]]
+repo = "isce-framework/snaphu-py"
+ref = "v0.3.0"

tests/test_downstream.py

@@ -19,8 +19,14 @@
 )
 def test_packages(repo, ref, fail, tmp_path, monkeypatch):
     monkeypatch.chdir(tmp_path)
-    subprocess.run(
-        ["git", "clone", f"https://github.com/{repo}", "--branch", ref], check=True
-    )
+    cmd = [
+        "git",
+        "clone",
+        f"https://github.com/{repo}",
+        "--branch",
+        ref,
+        "--recurse-submodules",
+    ]
+    subprocess.run(cmd, check=True)
     package_path = tmp_path / repo.split("/")[1]
     assert compare(package_path, isolated=True) == fail