docs: add Go package doc comments across all packages for pkg.go.dev

swadhinbiswas committed 2 months ago
1a83a56
1 parent d5b4d9b
commit 1a83a56
6 files changed
+39 -0
▼doc.go
+20-0
1
+// Package main provides the entry point and CLI commands for VEET.
2
+//
3
+// VEET (Universal Linux App Uninstaller & Deep-Clean Residual Purger) is a modern,
4
+// zero-latency terminal user interface (TUI) and headless CLI utility for Linux.
5
+// It aggregates installed software across 15+ package managers, universal container
6
+// formats, portable AppImages, and language toolchains, staging each candidate
7
+// residual path (~/.config, ~/.cache, ~/.local/share, /etc, /var/log) for user inspection
8
+// before performing atomic removals with batched privilege elevation.
9
+//
10
+// Installation:
11
+//
12
+// go install github.com/swadhinbiswas/veet@latest
13
+//
14
+// Usage:
15
+//
16
+// veet # Launch interactive terminal UI (default)
17
+// veet scan # List all installed applications across all package managers
18
+// veet scan --json # Output machine-readable JSON inventory
19
+// veet clean <app> # Deep-clean uninstall an application with staged preview
20
+package main
0
21
▼internal/detector/doc.go
+6-0
1
+// Package detector provides concurrent discovery engines for installed Linux applications.
2
+//
3
+// It queries system package managers (pacman, AUR, apt, dnf, zypper), universal application
4
+// sandboxes (Flatpak, Snap), portable application bundles (AppImage), orphaned package queries,
5
+// system logs / journal storage, and global language toolchains (npm, pipx, cargo, gem, go install).
6
+package detector
0
7
▼internal/history/doc.go
+2-0
1
+// Package history provides append-only audit logging and transaction records for VEET.
2
+package history
0
3
▼internal/model/doc.go
+5-0
1
+// Package model defines core data structures, configuration models, and metadata for VEET.
2
+//
3
+// Key types include AppInfo for representing installed packages across sources,
4
+// RemovableFiles for classifying staged file paths, and Config for runtime settings.
5
+package model
0
6
▼internal/ui/doc.go
+2-0
1
+// Package ui implements the interactive terminal user interface using Bubble Tea and Lip Gloss.
2
+package ui
0
3
▼internal/uninstaller/doc.go
+4-0
1
+// Package uninstaller handles residual path staging, safe deletion, and batched sudo execution.
2
+//
3
+// File system operations are abstracted over afero.Fs for safe in-memory unit testing.
4
+package uninstaller
0
5