Skip to content
internal/index
Updated Edit
On this page

Package index manages per-invocation temporary git indexes so each safegit invocation stages into its own index seeded from HEAD, avoiding contention.

#internal/index

#internal/index

Package index manages per-invocation temporary git indexes so each safegit invocation stages into its own index seeded from HEAD, avoiding contention. No safegit operation writes to the shared .git/index; all staging goes through temporary indexes created here.

#TmpIndex

Go go
type TmpIndex struct

TmpIndex represents a per-invocation temporary index directory.

#New

Go go
func New(ctx context.Context, baseDir string, treeish string) (*TmpIndex, error)

New creates a temporary index directory under baseDir/tmp/ and seeds the index from the given treeish.

#NewEmpty

Go go
func NewEmpty(baseDir string) (*TmpIndex, error)

NewEmpty creates a temporary index directory with an empty index (no tree). Used for root commits in repos with no prior commits. baseDir has the same meaning as in New.

#NewFromFile

Go go
func NewFromFile(baseDir, srcIndexPath string) (*TmpIndex, error)

NewFromFile creates a temporary index directory whose index starts as a byte copy of an existing index file -- in practice the repository's shared .git/index, which is where git records a conflict resolution the operator has staged. Copying is what keeps safegit's promise never to write to that file: the copy is what gets staged into and written out as a tree, and the original is only ever read.

The copy carries whatever the source held, unmerged stage entries included; a caller that copies a conflicted index and then asks for a tree gets git's own refusal to write one, which is the honest answer.

#GarbageCollectPlan

Go go
func GarbageCollectPlan(safegitDir string) ([]string, error)

GarbageCollectPlan reports the tmp directories whose owning PID is no longer alive, as full PATHS, and removes nothing.

It is the whole scanner: the caller decides what to do with what it found. That split is what lets safegit doctor diagnose with it, preview with it, and repair with it -- the repair removing each planned path through the effects handle, so a dry run records the removals it would make instead of making them, and machine mode carries them. A scanner that removed as it walked could not be asked what it would do without doing it.

#TmpIndex.Cleanup

Go go
func (t *TmpIndex) Cleanup() error

Cleanup removes the temporary index directory.

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