dotfiles

Documentation

Overview

Package dotfiles wraps around deploying dotfiles

Index

• Constants
• func Do(s Settings) error
• type Settings

Constants

const (
	// CompletionsMode indicates to generate completions
	CompletionsMode = "completions"
	// DeployMode indicates file deployment
	DeployMode = "deploy"
	// DiffMode indicates showing a diff
	DiffMode = "diff"
	// ListMode will list the effective files
	ListMode = "ls-files"
	// DryRunArg is the argumnent to outline changes (not make them)
	DryRunArg = "dry-run"
	// ForceArg will force write all files
	ForceArg = "force"
	// VerboseArg will enable verbose diffing
	VerboseArg = "verbose"
	// OverwriteArg will overwrite differing files
	OverwriteArg = "overwrite"
)

Functions

func Do

func Do(s Settings) error

Do will execute dotfiles activities

Types

type Settings

type Settings struct {
	Mode      string
	Overwrite bool
	Force     bool
	DryRun    bool
	Verbose   bool
	Writer    io.Writer
}

Settings are dotfiles arguments/input settngs