inst

README

inst

file install package

Installation

$ go get github.com/gnue/inst

Usage

import "github.com/gnue/inst"

Examples

Install

//var templ = template.Must(template.New("config").Parse("name: {{.Name}}\n"))
var Pkg = &inst.Pkg{
    //Template:        templ,
    Template:        &Template{},
    Locals:          []string{"$XDG_CONFIG_HOME", "$HOME/.config"},
    Globals:         []string{"/usr/local/etc"},
    InstallAction:   nil,
    UninstallAction: nil,
}

type Config struct {
    Name string
}

Pkg.Install("config.txt", 0644, &Config{Name: "Alice"}, inst.Local, false)

install file

Uninstall

package main

import (
	"github.com/gnue/inst"
)

func main() {
	var Pkg = &inst.Pkg{
		Locals:  []string{"$XDG_CONFIG_HOME", "$HOME/.config"},
		Globals: []string{"/usr/local/etc"},
	}

	Pkg.Uninstall("config.txt", inst.Local)
}

uninstall file

Author

gnue

License

MIT

Documentation

Overview

file install package

Index

• Constants
• Variables
• func EmptyEnvs(a []string) []string
• func EmptyVars(s string) []string
• func FindDir(dirs []string, mkdir bool) string
• func Vars(s string) []string
• type Locate
• type PathError
  • func (e *PathError) Error() string
• type Pkg
  • func New(t Template, dirs ...string) *Pkg
  • func (pkg *Pkg) Create(fname string, mode os.FileMode, data interface{}) (err error)
  • func (pkg *Pkg) Install(name string, mode os.FileMode, data interface{}, loc Locate, force bool) (fname string, err error)
  • func (pkg *Pkg) InstallPath(loc Locate, mkdir bool) (string, error)
  • func (pkg *Pkg) Uninstall(name string, loc Locate) (fname string, err error)
• type Template

Constants

const (
	Local = Locate(iota)
	Global
)

Variables

var (
	ErrNoInstallPath = errors.New("no install path")
)

Functions

func EmptyEnvs

func EmptyEnvs(a []string) []string

func EmptyVars

func EmptyVars(s string) []string

func FindDir

func FindDir(dirs []string, mkdir bool) string

func Vars

func Vars(s string) []string

Types

type Locate

type Locate int

type PathError

type PathError struct {
	Op   string
	Path string
	Err  error
}

func (*PathError) Error

func (e *PathError) Error() string

type Pkg

type Pkg struct {
	Template        Template
	Locals          []string
	Globals         []string
	InstallAction   func(fname string, loc Locate) error
	UninstallAction func(fname string, loc Locate) error
}

func New

func New(t Template, dirs ...string) *Pkg

func (*Pkg) Create

func (pkg *Pkg) Create(fname string, mode os.FileMode, data interface{}) (err error)

func (*Pkg) Install

func (pkg *Pkg) Install(name string, mode os.FileMode, data interface{}, loc Locate, force bool) (fname string, err error)

func (*Pkg) InstallPath

func (pkg *Pkg) InstallPath(loc Locate, mkdir bool) (string, error)

func (*Pkg) Uninstall

func (pkg *Pkg) Uninstall(name string, loc Locate) (fname string, err error)

type Template

type Template interface {
	Execute(wr io.Writer, data interface{}) error
}