Skip to content
internal/submodule
Updated Edit
On this page

Package submodule enumerates initialized and deinitialized git submodules, detects parent repos, checks for nesting, and resolves paths through symlinks.

#internal/submodule

#internal/submodule

Package submodule enumerates initialized and deinitialized git submodules, detects parent repos, checks for nesting, and resolves paths through symlinks.

This package intentionally does NOT import internal/git, which would create an import cycle. Its git calls still go through internal/gitexec, safegit's single git-execution boundary: gitexec is a leaf package (standard library only), so both this package and internal/git can route through it.

#ErrNestedSubmodules

Go go
var ErrNestedSubmodules = errors.New("nested submodules detected")

ErrNestedSubmodules is returned when a submodule itself contains submodules.

#SubmoduleInfo

Go go
type SubmoduleInfo struct

SubmoduleInfo describes a discovered submodule within a parent repository.

#Parent

Go go
type Parent struct

Parent describes the superproject a submodule is checked out inside.

WorkTree is carried alongside GitDir because several things a parent owns live in the work tree rather than the git directory -- its committed hook store above all -- and a caller handed only the git directory cannot find them without re-asking git.

#Enumerate

Go go
func Enumerate(ctx context.Context, parentGitDir string) ([]SubmoduleInfo, error)

Enumerate discovers all submodules in a repo. parentGitDir is the absolute path to the parent's .git directory (e.g. "/repo/.git").

Initialized submodules are found via git submodule foreach. Deinitialized submodules are found by walking .git/modules/. The two sets are merged with initialized taking precedence in case of overlap.

Returns an empty slice (not error) if no submodules exist.

#CheckNested

Go go
func CheckNested(ctx context.Context, parentGitDir string) error

CheckNested verifies that no initialized submodule itself contains nested submodules (indicated by a .gitmodules file in the submodule's working tree).

#DetectParent

Go go
func DetectParent(ctx context.Context) (parent Parent, ok bool)

DetectParent checks whether the current working directory is inside a git submodule and returns information about the parent repo.

Returns ok=false if not inside a submodule. Returns the immediate parent only; callers recurse if needed for nested submodules.

More tools from this site

  • claudestream Drive Claude Code from Python: run it as a subprocess and read its output as typed events, with async and sync sessions, sandbox policies, and tools you define in Python
  • claudewheel A TUI Claude Code Launcher that lets you have more than one profile, manage sessions lifecycle, pick the exact CC version, model to use (even older unlisted ones), pick which GitHub account to use, etc.
  • dirstat Fast, single-binary directory statistics CLI: every file under a tree grouped by format, with counts, sizes, and lines of code, as a colored terminal table or as JSON
  • fastware A batteries-included ASGI framework: msgspec JSON, a managed Granian server, dependency injection, SSE, WebSockets, auth, and a test client
  • go-toml-edit Zero-dep TOML editing library for Go with comment preservation
  • howmuchleft The fastest Claude Code statusline: context window, 5-hour, and weekly limit usage as three customizable gradient bars, rendering in about 6 ms
  • orxtra
  • pgdesign
  • predraw Declarative rendering pipeline: describe a scene in JSON and get SVG, PNG and WebP out, with light and dark style tokens, reusable components and text converted to path outlines
  • reposummary Turn a git repository's history into a Markdown journal: pick a time window or revision range and get a readable digest of what changed, optionally narrated by an LLM
  • rlsbl Release orchestration and project scaffolding CLI that bumps versions, validates a structured JSONL changelog, tags only the commit CI verified, and publishes to npm, PyPI, Go and more
  • saferm Command-line replacement for rm that archives every deletion with a mandatory reason and the context it ran in, so deleted files can be listed, inspected and restored
  • selfdoc Static Site Generator that builds a project's documentation site directly from its source code, so the docs can never drift from the code they describe, with SEO/AEO, first-class blog, search, and cross-project linking built in
  • strictcli
  • stricttest An always-on test-isolation floor: a pytest plugin and a Go env-hygiene module that make a test suite structurally unable to reach real credentials, the real HOME, the network, or the development repository.
  • wesktop A Python framework that turns an ASGI web app into a desktop application, serving it from a local Granian server and displaying it in a native OS window via pywebview
Search