feat: capture dotfiles in snapshots and show package descriptions (#7)

fullstackjam · fullstackjam · commit 3adda5a0ff41 · 2026-03-18T08:48:34.000+08:00
- Add DotfilesSnapshot to Snapshot struct, capture ~/.dotfiles git
  remote URL during snapshot
- Populate SnapshotDotfiles/DotfilesURL in buildImportConfig so
  snapshot import restores dotfiles via the existing stepDotfiles flow
- Match package names against the embedded catalog in the snapshot
  editor TUI to display descriptions
diff --git a/internal/cli/snapshot.go b/internal/cli/snapshot.go
@@ -712,6 +712,11 @@ func buildImportConfig(edited *snapshot.Snapshot, dryRun bool) *config.Config {
 		Plugins: edited.Shell.Plugins,
 	}
 
+	if edited.Dotfiles.RepoURL != "" {
+		cfg.SnapshotDotfiles = edited.Dotfiles.RepoURL
+		cfg.DotfilesURL = edited.Dotfiles.RepoURL
+	}
+
 	cfg.SnapshotMacOS = make([]config.SnapshotMacOSPref, len(edited.MacOSPrefs))
 	for i, p := range edited.MacOSPrefs {
 		cfg.SnapshotMacOS[i] = config.SnapshotMacOSPref{
diff --git a/internal/cli/snapshot_test.go b/internal/cli/snapshot_test.go
@@ -0,0 +1,70 @@
+package cli
+
+import (
+	"testing"
+
+	"github.com/openbootdotdev/openboot/internal/snapshot"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestBuildImportConfig_DotfilesPopulated(t *testing.T) {
+	snap := &snapshot.Snapshot{
+		Packages: snapshot.PackageSnapshot{
+			Formulae: []string{"git"},
+		},
+		Dotfiles: snapshot.DotfilesSnapshot{
+			RepoURL: "https://github.com/testuser/dotfiles",
+		},
+	}
+
+	cfg := buildImportConfig(snap, false)
+
+	assert.Equal(t, "https://github.com/testuser/dotfiles", cfg.SnapshotDotfiles)
+	assert.Equal(t, "https://github.com/testuser/dotfiles", cfg.DotfilesURL)
+}
+
+func TestBuildImportConfig_EmptyDotfiles(t *testing.T) {
+	snap := &snapshot.Snapshot{
+		Packages: snapshot.PackageSnapshot{
+			Formulae: []string{"git"},
+		},
+	}
+
+	cfg := buildImportConfig(snap, false)
+
+	assert.Empty(t, cfg.SnapshotDotfiles)
+	assert.Empty(t, cfg.DotfilesURL)
+}
+
+func TestBuildImportConfig_GitAndShellPopulated(t *testing.T) {
+	snap := &snapshot.Snapshot{
+		Git: snapshot.GitSnapshot{
+			UserName:  "Test User",
+			UserEmail: "test@example.com",
+		},
+		Shell: snapshot.ShellSnapshot{
+			OhMyZsh: true,
+			Theme:   "robbyrussell",
+			Plugins: []string{"git"},
+		},
+	}
+
+	cfg := buildImportConfig(snap, false)
+
+	require.NotNil(t, cfg.SnapshotGit)
+	assert.Equal(t, "Test User", cfg.SnapshotGit.UserName)
+	require.NotNil(t, cfg.SnapshotShell)
+	assert.True(t, cfg.SnapshotShell.OhMyZsh)
+}
+
+func TestBuildImportConfig_EmptySnapshot(t *testing.T) {
+	snap := &snapshot.Snapshot{}
+
+	cfg := buildImportConfig(snap, false)
+
+	require.NotNil(t, cfg)
+	require.NotNil(t, cfg.SelectedPkgs)
+	assert.Empty(t, cfg.SelectedPkgs)
+	assert.Empty(t, cfg.OnlinePkgs)
+}
diff --git a/internal/installer/installer.go b/internal/installer/installer.go
@@ -873,6 +873,13 @@ func RunFromSnapshot(cfg *config.Config) error {
 		softErrs = append(softErrs, fmt.Errorf("macos: %w", err))
 	}
 
+	if cfg.SnapshotDotfiles != "" {
+		if err := stepDotfiles(cfg); err != nil {
+			ui.Error(fmt.Sprintf("Dotfiles restore failed: %v", err))
+			softErrs = append(softErrs, fmt.Errorf("dotfiles: %w", err))
+		}
+	}
+
 	showCompletion(cfg)
 
 	if len(softErrs) > 0 {
diff --git a/internal/snapshot/capture.go b/internal/snapshot/capture.go
@@ -53,6 +53,11 @@ func Capture() (*Snapshot, error) {
 		return nil, err
 	}
 
+	dotfilesSnap, err := CaptureDotfiles()
+	if err != nil {
+		return nil, err
+	}
+
 	devTools, err := CaptureDevTools()
 	if err != nil {
 		return nil, err
@@ -71,6 +76,7 @@ func Capture() (*Snapshot, error) {
 		MacOSPrefs:    prefs,
 		Shell:         *shellSnap,
 		Git:           *gitSnap,
+		Dotfiles:      *dotfilesSnap,
 		DevTools:      devTools,
 		MatchedPreset: "",
 		CatalogMatch: CatalogMatch{
@@ -134,6 +140,12 @@ func CaptureWithProgress(callback func(step ScanStep)) (*Snapshot, error) {
 		}},
 		{"Shell Environment", func() (interface{}, error) { return CaptureShell() }, func(v interface{}) int { return 1 }},
 		{"Git Configuration", func() (interface{}, error) { return CaptureGit() }, func(v interface{}) int { return 1 }},
+		{"Dotfiles", func() (interface{}, error) { return CaptureDotfiles() }, func(v interface{}) int {
+			if s, ok := v.(*DotfilesSnapshot); ok && s.RepoURL != "" {
+				return 1
+			}
+			return 0
+		}},
 		{"Dev Tools", func() (interface{}, error) { return CaptureDevTools() }, func(v interface{}) int {
 			if s, ok := v.([]DevTool); ok {
 				return len(s)
@@ -169,7 +181,8 @@ func CaptureWithProgress(callback func(step ScanStep)) (*Snapshot, error) {
 	prefs, _ := results[4].([]MacOSPref)
 	shellSnap, _ := results[5].(*ShellSnapshot)
 	gitSnap, _ := results[6].(*GitSnapshot)
-	devTools, _ := results[7].([]DevTool)
+	dotfilesSnap, _ := results[7].(*DotfilesSnapshot)
+	devTools, _ := results[8].([]DevTool)
 
 	if formulae == nil {
 		formulae = []string{}
@@ -192,6 +205,9 @@ func CaptureWithProgress(callback func(step ScanStep)) (*Snapshot, error) {
 	if gitSnap == nil {
 		gitSnap = &GitSnapshot{}
 	}
+	if dotfilesSnap == nil {
+		dotfilesSnap = &DotfilesSnapshot{}
+	}
 	if devTools == nil {
 		devTools = []DevTool{}
 	}
@@ -209,6 +225,7 @@ func CaptureWithProgress(callback func(step ScanStep)) (*Snapshot, error) {
 		MacOSPrefs:    prefs,
 		Shell:         *shellSnap,
 		Git:           *gitSnap,
+		Dotfiles:      *dotfilesSnap,
 		DevTools:      devTools,
 		MatchedPreset: "",
 		CatalogMatch: CatalogMatch{
@@ -403,6 +420,27 @@ func CaptureDevTools() ([]DevTool, error) {
 	return tools, nil
 }
 
+func CaptureDotfiles() (*DotfilesSnapshot, error) {
+	home, err := os.UserHomeDir()
+	if err != nil {
+		return &DotfilesSnapshot{}, nil
+	}
+
+	dotfilesPath := filepath.Join(home, ".dotfiles")
+	if _, err := os.Stat(filepath.Join(dotfilesPath, ".git")); err != nil {
+		return &DotfilesSnapshot{}, nil
+	}
+
+	out, err := exec.Command("git", "-C", dotfilesPath, "remote", "get-url", "origin").Output()
+	if err != nil {
+		return &DotfilesSnapshot{}, nil
+	}
+
+	return &DotfilesSnapshot{
+		RepoURL: strings.TrimSpace(string(out)),
+	}, nil
+}
+
 func sanitizePath(path string) string {
 	home, err := os.UserHomeDir()
 	if err != nil {
diff --git a/internal/snapshot/capture_test.go b/internal/snapshot/capture_test.go
@@ -2,6 +2,8 @@ package snapshot
 
 import (
 	"errors"
+	"os"
+	"path/filepath"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -362,3 +364,37 @@ func TestCaptureWithProgress_HealthEmptyOnSuccess(t *testing.T) {
 
 	assert.Empty(t, failedSteps)
 }
+
+func TestCaptureDotfiles_NoDotfilesDir(t *testing.T) {
+	tmpDir := t.TempDir()
+	t.Setenv("HOME", tmpDir)
+
+	snap, err := CaptureDotfiles()
+	assert.NoError(t, err)
+	require.NotNil(t, snap)
+	assert.Empty(t, snap.RepoURL)
+}
+
+func TestCaptureDotfiles_DotfilesDirExistsButNoGit(t *testing.T) {
+	tmpDir := t.TempDir()
+	t.Setenv("HOME", tmpDir)
+
+	require.NoError(t, os.MkdirAll(filepath.Join(tmpDir, ".dotfiles"), 0755))
+
+	snap, err := CaptureDotfiles()
+	assert.NoError(t, err)
+	require.NotNil(t, snap)
+	assert.Empty(t, snap.RepoURL)
+}
+
+func TestCaptureDotfiles_GitDirExistsButNoRemote(t *testing.T) {
+	tmpDir := t.TempDir()
+	t.Setenv("HOME", tmpDir)
+
+	require.NoError(t, os.MkdirAll(filepath.Join(tmpDir, ".dotfiles", ".git"), 0755))
+
+	snap, err := CaptureDotfiles()
+	assert.NoError(t, err)
+	require.NotNil(t, snap)
+	assert.Empty(t, snap.RepoURL)
+}
diff --git a/internal/snapshot/snapshot.go b/internal/snapshot/snapshot.go
@@ -15,12 +15,17 @@ type Snapshot struct {
 	MacOSPrefs    []MacOSPref     `json:"macos_prefs"`
 	Shell         ShellSnapshot   `json:"shell"`
 	Git           GitSnapshot     `json:"git"`
+	Dotfiles      DotfilesSnapshot `json:"dotfiles"`
 	DevTools      []DevTool       `json:"dev_tools"`
 	MatchedPreset string          `json:"matched_preset"`
 	CatalogMatch  CatalogMatch    `json:"catalog_match"`
 	Health        CaptureHealth   `json:"health"`
 }
 
+type DotfilesSnapshot struct {
+	RepoURL string `json:"repo_url,omitempty"`
+}
+
 type PackageSnapshot struct {
 	Formulae []string `json:"formulae"`
 	Casks    []string `json:"casks"`
diff --git a/internal/ui/snapshot_editor.go b/internal/ui/snapshot_editor.go
@@ -7,6 +7,7 @@ import (
 	"github.com/charmbracelet/bubbles/key"
 	tea "github.com/charmbracelet/bubbletea"
 	"github.com/charmbracelet/lipgloss"
+	"github.com/openbootdotdev/openboot/internal/config"
 	"github.com/openbootdotdev/openboot/internal/snapshot"
 )
 
@@ -70,23 +71,31 @@ type SnapshotEditorModel struct {
 }
 
 func NewSnapshotEditor(snap *snapshot.Snapshot) SnapshotEditorModel {
+	// Build a lookup from the embedded catalog for package descriptions.
+	descMap := make(map[string]string)
+	for _, cat := range config.Categories {
+		for _, pkg := range cat.Packages {
+			descMap[pkg.Name] = pkg.Description
+		}
+	}
+
 	tabs := make([]editorTab, 5)
 
 	formulaeItems := make([]editorItem, len(snap.Packages.Formulae))
 	for i, pkg := range snap.Packages.Formulae {
-		formulaeItems[i] = editorItem{name: pkg, selected: true, itemType: editorItemFormula}
+		formulaeItems[i] = editorItem{name: pkg, description: descMap[pkg], selected: true, itemType: editorItemFormula}
 	}
 	tabs[0] = editorTab{name: "Formulae", icon: "🍺", items: formulaeItems, itemType: editorItemFormula}
 
 	caskItems := make([]editorItem, len(snap.Packages.Casks))
 	for i, pkg := range snap.Packages.Casks {
-		caskItems[i] = editorItem{name: pkg, selected: true, itemType: editorItemCask}
+		caskItems[i] = editorItem{name: pkg, description: descMap[pkg], selected: true, itemType: editorItemCask}
 	}
 	tabs[1] = editorTab{name: "Casks", icon: "📦", items: caskItems, itemType: editorItemCask}
 
 	npmItems := make([]editorItem, len(snap.Packages.Npm))
 	for i, pkg := range snap.Packages.Npm {
-		npmItems[i] = editorItem{name: pkg, selected: true, itemType: editorItemNpm}
+		npmItems[i] = editorItem{name: pkg, description: descMap[pkg], selected: true, itemType: editorItemNpm}
 	}
 	tabs[2] = editorTab{name: "NPM", icon: "📜", items: npmItems, itemType: editorItemNpm}
 
diff --git a/internal/ui/snapshot_editor_test.go b/internal/ui/snapshot_editor_test.go
@@ -726,3 +726,45 @@ func TestSnapshotEditorAddedItemVisualBadge(t *testing.T) {
 	view := m.View()
 	assert.Contains(t, view, "[+]")
 }
+
+func TestNewSnapshotEditorDescriptionFromCatalog(t *testing.T) {
+	// Find a formula in the embedded catalog.
+	var catalogPkg, catalogDesc string
+	for _, cat := range config.Categories {
+		for _, pkg := range cat.Packages {
+			if !pkg.IsCask && !pkg.IsNpm {
+				catalogPkg = pkg.Name
+				catalogDesc = pkg.Description
+				break
+			}
+		}
+		if catalogPkg != "" {
+			break
+		}
+	}
+	require.NotEmpty(t, catalogPkg)
+
+	snap := &snapshot.Snapshot{
+		Packages: snapshot.PackageSnapshot{
+			Formulae: []string{catalogPkg},
+		},
+	}
+
+	m := NewSnapshotEditor(snap)
+
+	require.Len(t, m.tabs[0].items, 1)
+	assert.Equal(t, catalogDesc, m.tabs[0].items[0].description)
+}
+
+func TestNewSnapshotEditorDescriptionEmptyForUnknown(t *testing.T) {
+	snap := &snapshot.Snapshot{
+		Packages: snapshot.PackageSnapshot{
+			Formulae: []string{"completely-unknown-tool-xyz"},
+		},
+	}
+
+	m := NewSnapshotEditor(snap)
+
+	require.Len(t, m.tabs[0].items, 1)
+	assert.Empty(t, m.tabs[0].items[0].description)
+}
