create

Documentation

Index

• Variables
• func NewExtensionProject(extension core.Extension) error
• func NewTemplateEngine(extension core.Extension, shared, project FS) *templateEngine
• func ReadTemplateFile(path string) ([]byte, error)
• func UniversalPath(paths ...string) universalPath
• type CopyFileTask
  • func (t CopyFileTask) Run() error
  • func (t CopyFileTask) Undo() error
• type CreateProject
  • func (e CreateProject) Run() error
  • func (ext CreateProject) Undo() error
• type FS
  • func (_fs FS) WalkDir(walk WalkDirFunc) error
• type InstallDependencies
  • func (path InstallDependencies) Run() error
  • func (path InstallDependencies) Undo() error
• type MakeDir
  • func (path MakeDir) Run() error
  • func (path MakeDir) Undo() error
• type Process
  • func NewProcess(tasks ...Task) Process
  • func (p *Process) Add(task Task)
  • func (p *Process) Run() (err error)
  • func (p *Process) Undo() (err error)
• type ReaderFunc
• type RenderTask
  • func (t RenderTask) Run() error
  • func (t RenderTask) Undo() error
• type Rule
  • func LookupRule(ext core.Extension, source *SourceFileReference, target *TargetFileReference) Rule
• type Rules
• type Runner
• type SourceFileReference
  • func NewSourceFileReference(fs fs.FS, path ...string) *SourceFileReference
  • func (p SourceFileReference) FilePath() string
  • func (r *SourceFileReference) InferTarget(projectDir string) *TargetFileReference
  • func (r *SourceFileReference) IsDir() bool
  • func (r *SourceFileReference) IsTemplate() bool
  • func (r *SourceFileReference) Open(read ReaderFunc) error
  • func (p SourceFileReference) Path() string
  • func (p SourceFileReference) Rename(name string) universalPath
• type TargetFileReference
  • func NewTargetFileReference(fs fs.FS, path ...string) *TargetFileReference
  • func (p TargetFileReference) FilePath() string
  • func (r *TargetFileReference) Open(write WriterFunc) (err error)
  • func (p TargetFileReference) Path() string
  • func (r *TargetFileReference) Rename(name string) *TargetFileReference
• type Task
• type WalkDirFunc
• type WriterFunc

Variables

var Command = func(dir, executable string, args ...string) (runner Runner) {
	cmd := exec.Command(executable, args...)
	cmd.Dir = dir
	return cmd
}

var LookPath = exec.LookPath

Functions

func NewExtensionProject

func NewExtensionProject(extension core.Extension) error

func NewTemplateEngine

func NewTemplateEngine(extension core.Extension, shared, project FS) *templateEngine

func ReadTemplateFile

func ReadTemplateFile(path string) ([]byte, error)

func UniversalPath

func UniversalPath(paths ...string) universalPath

Types

type CopyFileTask

type CopyFileTask struct {
	Source *SourceFileReference
	Target *TargetFileReference
}

func (CopyFileTask) Run

func (t CopyFileTask) Run() error

func (CopyFileTask) Undo

func (t CopyFileTask) Undo() error

type CreateProject

type CreateProject core.Extension

func (CreateProject) Run

func (e CreateProject) Run() error

func (CreateProject) Undo

func (ext CreateProject) Undo() error

type FS

type FS struct {
	fs.FS
}

func (FS) WalkDir

func (_fs FS) WalkDir(walk WalkDirFunc) error

type InstallDependencies

type InstallDependencies string

InstallDependencies is a process.Task for installing the JavaScript packages required by an extension. It's automatically choose which package manager to use.

func (InstallDependencies) Run

func (path InstallDependencies) Run() error

func (InstallDependencies) Undo

func (path InstallDependencies) Undo() error

type MakeDir

type MakeDir string

MakeDir is a process.Task that creates a directory.

func (MakeDir) Run

func (path MakeDir) Run() error

func (MakeDir) Undo

func (path MakeDir) Undo() error

type Process

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

func NewProcess

func NewProcess(tasks ...Task) Process

func (*Process) Add

func (p *Process) Add(task Task)

func (*Process) Run

func (p *Process) Run() (err error)

func (*Process) Undo

func (p *Process) Undo() (err error)

type ReaderFunc

type ReaderFunc func(r io.Reader) error

type RenderTask

type RenderTask struct {
	Source    *SourceFileReference
	Target    *TargetFileReference
	Extension core.Extension
	*template.Template
}

func (RenderTask) Run

func (t RenderTask) Run() error

func (RenderTask) Undo

func (t RenderTask) Undo() error

type Rule

type Rule func(ext core.Extension, source *SourceFileReference, target *TargetFileReference) *TargetFileReference

func LookupRule

func LookupRule(ext core.Extension, source *SourceFileReference, target *TargetFileReference) Rule

type Rules

type Rules map[string]Rule

type Runner

type Runner interface {
	Run() error
	CombinedOutput() ([]byte, error)
}

type SourceFileReference

type SourceFileReference struct {
	fs.FS
	// contains filtered or unexported fields
}

func NewSourceFileReference

func NewSourceFileReference(fs fs.FS, path ...string) *SourceFileReference

func (SourceFileReference) FilePath

func (p SourceFileReference) FilePath() string

func (*SourceFileReference) InferTarget

func (r *SourceFileReference) InferTarget(projectDir string) *TargetFileReference

func (*SourceFileReference) IsDir

func (r *SourceFileReference) IsDir() bool

func (*SourceFileReference) IsTemplate

func (r *SourceFileReference) IsTemplate() bool

func (*SourceFileReference) Open

func (r *SourceFileReference) Open(read ReaderFunc) error

func (SourceFileReference) Path

func (p SourceFileReference) Path() string

func (SourceFileReference) Rename

func (p SourceFileReference) Rename(name string) universalPath

type TargetFileReference

type TargetFileReference struct {
	fs.FS
	// contains filtered or unexported fields
}

func NewTargetFileReference

func NewTargetFileReference(fs fs.FS, path ...string) *TargetFileReference

func (TargetFileReference) FilePath

func (p TargetFileReference) FilePath() string

func (*TargetFileReference) Open

func (r *TargetFileReference) Open(write WriterFunc) (err error)

func (TargetFileReference) Path

func (p TargetFileReference) Path() string

func (*TargetFileReference) Rename

func (r *TargetFileReference) Rename(name string) *TargetFileReference

type Task

type Task interface {
	Run() error
	Undo() error
}

type WalkDirFunc

type WalkDirFunc func(ref *SourceFileReference) error

type WriterFunc

type WriterFunc func(w io.Writer) error