Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

drydock

package module

Go to main page

Versions in this module

v1

v1.2.1

Apr 19, 2024

v1.2.0

Apr 19, 2024

Changes in this version

+ func Render(files ...File) string

v1.1.1

Apr 19, 2024

v1.1.0

Apr 19, 2024

Changes in this version

type WritableFS

+ func MkpWritableDirFS(dir string) (WritableFS, error)

v1.0.1

Mar 20, 2024

v1.0.0

Mar 20, 2024

Changes in this version

+ var ErrCleaningOutputDir = errors.New("error cleaning output dir")

+ var ErrMissingFS = errors.New("missing FS")

+ type DirFSGenerator struct

+ CleanDir bool

+ ErrorOnExistingDir bool

+ ErrorOnExistingFile bool

+ NoCreateOutputDir bool

+ OutputDir string

+ func (g *DirFSGenerator) Generate(ctx context.Context, files ...File) error

+ type Directory interface

+ Entries func() ([]File, error)

+ func Dir(name string, entries ...File) Directory

+ func DirP(name string, entries ...File) Directory

+ type FSGenerator struct

+ CleanDir bool

+ ErrorOnExistingDir bool

+ ErrorOnExistingFile bool

+ FS WritableFS

+ func (g *FSGenerator) Generate(ctx context.Context, files ...File) error

+ type File interface

+ Name func() string

+ func FileFromTemplate(name string, template Template, data any) File

+ func ModifyFile[E any](name string, parse func([]byte, any) error, mod func(*E) ([]byte, error)) File

+ func PlainFile(name string, contents string) File

+ func TemplateFile(name string, template string, data any) File

+ type IsNewFile interface

+ IsNewFile func() bool

+ type Template interface

+ Execute func(w io.Writer, data any) error

+ type WritableFS interface

+ CreateTemp func(dir string, pattern string) (WritableFile, error)

+ Mkdir func(name string, perm fs.FileMode) error

+ Remove func(path string) error

+ RemoveAll func(path string) error

+ Rename func(oldpath string, newpath string) error

+ func MkWritableDirFS(dir string) (WritableFS, error)

+ func NewWritableDirFS(dir string) WritableFS

+ type WritableFile interface

+ Name func() string

+ type WritableMapFS fstest.MapFS

+ func (fsys WritableMapFS) CreateTemp(dir string, pattern string) (WritableFile, error)

+ func (fsys WritableMapFS) Glob(pattern string) ([]string, error)

+ func (fsys WritableMapFS) Mkdir(name string, perm fs.FileMode) error

+ func (fsys WritableMapFS) Open(name string) (fs.File, error)

+ func (fsys WritableMapFS) ReadDir(name string) ([]fs.DirEntry, error)

+ func (fsys WritableMapFS) ReadFile(name string) ([]byte, error)

+ func (fsys WritableMapFS) Remove(path string) error

+ func (fsys WritableMapFS) RemoveAll(dir string) error

+ func (fsys WritableMapFS) Rename(oldpath string, newpath string) error

+ func (fsys WritableMapFS) Stat(name string) (fs.FileInfo, error)

+ func (fsys WritableMapFS) Sub(dir string) (fs.FS, error)

+ type WriterToFile interface

+ WriteToFile func(rootFS WritableFS, filename string, w io.Writer) (n int64, err error)