daisy

Documentation

Overview

Package daisy is an example flower that copies, expanding the template, one file at install time and one file at configure time.

Index

• Constants
• type Conf
• type Flower
  • func (fl *Flower) Configure() error
  • func (fl *Flower) Description() string
  • func (fl *Flower) Embedded() []string
  • func (fl *Flower) Init() error
  • func (fl *Flower) Install() error
  • func (fl *Flower) String() string
• type Inst

Constants

const (
	InstallPlainFileSrc = "embedded/inst1.txt"
	InstallTmplFileSrc  = "embedded/inst2.txt.tmpl"
	ConfigTmplFileSrc   = "embedded/config1.txt.tmpl"
)

Input paths in the source fs.

const (
	InstallPlainFileDst = "inst1.txt"
	InstallTmplFileDst  = "inst2.txt"
	ConfigTmplFileDst   = "config1.txt"
)

Output paths in the destination fs, relative to the customizable Flower.DstDir.

const Name = "daisy"

Types

type Conf

type Conf struct {
	Environment string // dynamic setting
	GossipKey   string // Secret
}

type Flower

type Flower struct {
	Inst
	Conf
}

func (*Flower) Configure

func (fl *Flower) Configure() error

func (*Flower) Description

func (fl *Flower) Description() string

func (*Flower) Embedded

func (fl *Flower) Embedded() []string

func (*Flower) Init

func (fl *Flower) Init() error

func (*Flower) Install

func (fl *Flower) Install() error

func (*Flower) String

func (fl *Flower) String() string

type Inst

type Inst struct {
	// Base directory into which all files will be installed.
	DstDir     string `default:"/tmp/daisy"`
	PetalColor string `default:"white"`
	Perennial  bool   `default:"true"`
	Fsys       fs.FS
}