templatedir

README

templatedir

Package templatedir render a whole directory containing go templates files.

Documentation

• See examples of use.
• Read the API docs on go.dev.

Contributing

• Pull request are welcome!
• Open an issue if you find a bug.
• If you want to request a new feature or need help, starts a new discussion.
• Read contribution guidelines.

License

MIT Licensed

© 2021 Parro's Go Packages

Documentation

Overview

Package templatedir provide two functions that allow to render a whole directory of go templates to itself or to another directory.

Index

• func RenderTo(srcfs fs.FS, destfsys writefs.WriteFS, args interface{}) error
• type Args
  • func DefaultArgs() (Args, error)
  • func (a *Args) InitFromOSEnv()
  • func (a Args) String() string
• type FS
  • func (fsys *FS) DoSomething(number int) (bool, error)
  • func (fsys *FS) Glob(pattern string) ([]string, error)
  • func (fsys *FS) MkDir(name string, perm fs.FileMode) error
  • func (fsys *FS) Open(name string) (fs.File, error)
  • func (fsys *FS) OpenFile(name string, flag int, perm fs.FileMode) (writefs.FileWriter, error)
  • func (fsys *FS) ReadDir(name string) ([]fs.DirEntry, error)
  • func (fsys *FS) ReadFile(name string) ([]byte, error)
  • func (fsys *FS) Remove(name string) error
  • func (fsys *FS) Stat(name string) (fs.FileInfo, error)
  • func (fsys *FS) Sub(dir string) (fs.FS, error)
• type SyncErrors
  • func (errs SyncErrors) Close() error
  • func (errs SyncErrors) Failed() bool
  • func (errs SyncErrors) SetFailedOnErr(err error) bool

Examples

• DefaultArgs

Functions

func RenderTo

func RenderTo(srcfs fs.FS, destfsys writefs.WriteFS, args interface{}) error

RenderTo ...

Types

type Args

type Args map[string]interface{}

Args ...

func DefaultArgs

func DefaultArgs() (Args, error)

DefaultArgs ...

Example

This example show how to use templatedir.Func()

package main

import (
	"embed"
	"fmt"
	"io/fs"

	"github.com/parrogo/templatedir"
)

//go:embed fixtures
var fixtureRootFS embed.FS
var fixtureFS, _ = fs.Sub(fixtureRootFS, "fixtures")

// This example show how to use templatedir.Func()
func main() {
	args, err := templatedir.DefaultArgs()
	if err != nil {
		panic(err)
	}
	fmt.Println(args["RepoName"])
	fmt.Println(args["Author"])
}

Output:

templatedir
parrogo

func (*Args) InitFromOSEnv

func (a *Args) InitFromOSEnv()

InitFromOSEnv ...

func (Args) String

func (a Args) String() string

type FS

type FS struct {
	mock.Mock
}

FS mocks

func (*FS) DoSomething

func (fsys *FS) DoSomething(number int) (bool, error)

DoSomething is a method on MyMockedObject that implements some interface and just records the activity, and returns what the Mock object tells it to.

In the real object, this method would do something useful, but since this is a mocked object - we're just going to stub it out.

NOTE: This method is not being tested here, code that uses this object is.

func (*FS) Glob

func (fsys *FS) Glob(pattern string) ([]string, error)

Glob implements fs.GlobFS

func (*FS) MkDir

func (fsys *FS) MkDir(name string, perm fs.FileMode) error

MkDir implements writefs.MkDirFS

func (*FS) Open

func (fsys *FS) Open(name string) (fs.File, error)

Open implements fs.FS

func (*FS) OpenFile

func (fsys *FS) OpenFile(name string, flag int, perm fs.FileMode) (writefs.FileWriter, error)

OpenFile implements writefs.WriteFS

func (*FS) ReadDir

func (fsys *FS) ReadDir(name string) ([]fs.DirEntry, error)

ReadDir implements fs.ReadDirFS

func (*FS) ReadFile

func (fsys *FS) ReadFile(name string) ([]byte, error)

ReadFile implements fs.ReadFileFS

func (*FS) Remove

func (fsys *FS) Remove(name string) error

Remove implements writefs.RemoveFS

func (*FS) Stat

func (fsys *FS) Stat(name string) (fs.FileInfo, error)

Stat implements fs.StatFS

func (*FS) Sub

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

Sub implements fs.SubFS

type SyncErrors

type SyncErrors chan error

SyncErrors ...

func (SyncErrors) Close

func (errs SyncErrors) Close() error

Close ...

func (SyncErrors) Failed

func (errs SyncErrors) Failed() bool

Failed ...

func (SyncErrors) SetFailedOnErr

func (errs SyncErrors) SetFailedOnErr(err error) bool

SetFailedOnErr ...