tpl

Documentation

Index

• Variables
• func GitURL(data []byte) string
• func Package2url(str string) string
• func ShortName(str string) string
• func Walk(dir Dir, path string, yield func(string, fs.DirEntry) error) error
• func WriteTemplate(files embed.FS)
• type Dir
• type DirEntry
  • func NewDirEntry(path string) *DirEntry
  • func (p *DirEntry) Open(path string) (fs.File, error)
  • func (p *DirEntry) ReadDir(path string) ([]fs.DirEntry, error)
  • func (p *DirEntry) String() string
• type Env
  • func NewEnv() *Env
  • func NewEnvByDir(arg string) *Env
  • func NewEnvByFile(arg, ext string) *Env
  • func NewEnvByGo(arg string) *Env
  • func (p *Env) Bytes(files fs.FS, path string) []byte

Examples

• Walk

Variables

var ConfigPath = filepath.Join(lo.Must1(os.UserHomeDir()), ".config", "go-cli")

nolint: gochecknoglobals

Functions

func GitURL

func GitURL(data []byte) string

func Package2url

func Package2url(str string) string

func ShortName

func ShortName(str string) string

func Walk

func Walk(dir Dir, path string, yield func(string, fs.DirEntry) error) error

Example

ExampleWalk is an example function.

package main

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

	"github.com/xuender/go-cli/tpl"
)

//go:embed files
var _files embed.FS

// ExampleWalk is an example function.
func main() {
	err := tpl.Walk(_files, ".", func(path string, entry fs.DirEntry) error {
		fmt.Println(path, entry.Name())

		return nil
	})

	fmt.Println(err)

}

Output:

files/a/aa aaa
files/b bb
files c
<nil>

func WriteTemplate

func WriteTemplate(files embed.FS)

Types

type Dir

type Dir interface {
	ReadDir(string) ([]fs.DirEntry, error)
	Open(string) (fs.File, error)
}

type DirEntry

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

func NewDirEntry

func NewDirEntry(path string) *DirEntry

func (*DirEntry) Open

func (p *DirEntry) Open(path string) (fs.File, error)

func (*DirEntry) ReadDir

func (p *DirEntry) ReadDir(path string) ([]fs.DirEntry, error)

func (*DirEntry) String

func (p *DirEntry) String() string

type Env

type Env struct {
	Year      string
	User      string
	Package   string
	Name      string
	Path      string
	Test      string
	License   string
	BuildTime string
	Version   string
}

func NewEnv

func NewEnv() *Env

func NewEnvByDir

func NewEnvByDir(arg string) *Env

func NewEnvByFile

func NewEnvByFile(arg, ext string) *Env

func NewEnvByGo

func NewEnvByGo(arg string) *Env

func (*Env) Bytes

func (p *Env) Bytes(files fs.FS, path string) []byte