manifest

type EmbedFSProvider ¶

type EmbedFSProvider struct {
	// contains filtered or unexported fields
}

EmbedFSProvider is an wrapper for embed.FS that provides implementation of provider interface accepted by projector.Generator.

func NewEmbedFSProvider(fs *embed.FS, root string) *EmbedFSProvider

func (e *EmbedFSProvider) Get(filename string) ([]byte, error)

type File ¶

type File struct {
	Path   string `toml:"path"`
	Output string `toml:"output"`
}

File is actually mapping between template file and output file. Also template syntax allowed in Output field.

func (f File) Validate() error

type Manifest ¶

type Manifest struct {
	Name        string `toml:"name"`
	Author      string `toml:"author"`
	URL         string `toml:"url,omitempty"`
	Version     string `toml:"version"`
	Description string `toml:"description"`
	Steps       Steps  `toml:"steps"`
}

Manifest contains all metadata related to project template and actual steps of project generation.

func Load(p provider, path string) (*Manifest, error)

func (m Manifest) Validate() error

type RealFSProvider ¶

type RealFSProvider struct {
	// contains filtered or unexported fields
}

RealFSProvider is an wrapper for file system that provides implementation of provider interface accepted by projector.Generator.

func NewRealFSProvider(root string) *RealFSProvider

func (r *RealFSProvider) Get(filename string) ([]byte, error)

type Step ¶

type Step struct {
	Name       string `toml:"name"`
	IsOptional bool   `toml:"optional"`
	Files      []File `toml:"files"`
	Shell      string `toml:"shell"`
}

Step contains template files to output mapping and/or shell script to execute.

func (s Step) Validate() error

type Steps ¶ added in v0.3.0

type Steps []Step

func (s Steps) Get(name string) (*Step, error)