dotfile

package
v1.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 12, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source 
const CryptSuffix = ".crypt"

CryptSuffix marks a repository file whose content is encrypted. It is appended to the dot_-encoded name and never appears in the home path.

Variables

This section is empty.

Functions

func HomePath added in v1.7.0 

func HomePath(homeDir, target string) string

HomePath normalizes a user-supplied dotfile target to an absolute path under homeDir. It accepts a "~/" prefix, an absolute path, or a bare name.

func TransformPath 

func TransformPath(home, repo string, p string) (string, error)

TransformPath transforms a home-relative dotfile path to a repo path. ~/.zshrc -> <repo>/dot_zshrc ~/.config/nvim/init.lua -> <repo>/dot_config/nvim/init.lua

Types

type Pair 

type Pair struct {
	Src       string
	Dst       string
	Encrypted bool
}

Pair is a source→destination file mapping. For an encrypted file Src carries the CryptSuffix while Dst is the plain home path.

func Collect 

func Collect(dir, homeDir string, skipProfiles bool) ([]Pair, error)

Collect walks dir recursively and returns Pairs mapping src→dst. Only files whose top-level path segment starts with dot_ are collected. The .git directory is always skipped. When skipProfiles is true, a top-level profiles directory is skipped as well; this is used when dir is the repository root so that profile overlays are not pulled into the base set. A file with the CryptSuffix maps to the same home path as its plain twin; both present in one layer is an error because there is no sane winner.

func FilterPairs 

func FilterPairs(pairs []Pair, homeDir string, targets []string) ([]Pair, error)

FilterPairs returns only the pairs whose destination matches one of the given targets. Targets are interpreted as home-directory paths and may use a "~/" prefix or be bare dotfile names starting with ".". Returns an error if any target cannot be matched to a pair.

func Merge 

func Merge(pairs []Pair) []Pair

Merge deduplicates pairs so later entries (profile) win over earlier (base) for the same destination path.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.