scaffold

package

v0.0.0-...-c845b1b Latest Latest Go to latest Published: Sep 19, 2023 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/olafal0/rescaffold

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func ApplyTemplate(src io.Reader, dst io.Writer, replacer func(string) string) (checksum string, err error)
func Generate(lockfile *config.Lockfile, scaffoldSource, outdir string) error
func LiteralMatchReplacer(manifest *config.Manifest, vars map[string]string) func(string) string
func LoadVarsInteractive(manifestVars map[string]*config.ManifestVar, lockfileVars map[string]string) (map[string]string, error)
func RegexpLoopReplacer(manifest *config.Manifest, vars map[string]string) (func(string) string, error)
func RegexpReplacer(manifest *config.Manifest, vars map[string]string) (func(string) string, error)
func Remove(lockfile *config.Lockfile, scaffoldSource, outdir string) error
func Upgrade(lockfile *config.Lockfile, scaffoldSource, outdir string) error
type Scaffold
- func LoadFromDir(dirName string) (*Scaffold, error)
type ScaffoldFile

Constants ¶

This section is empty.

Variables ¶

View Source

var Modifiers = map[string]func(string) string{
	"titlecase": cases.Title(language.English).String,
	"lowercase": strings.ToLower,
	"uppercase": strings.ToUpper,
}

Functions ¶

func ApplyTemplate ¶

func ApplyTemplate(src io.Reader, dst io.Writer, replacer func(string) string) (checksum string, err error)

func Generate ¶

func Generate(lockfile *config.Lockfile, scaffoldSource, outdir string) error

func LiteralMatchReplacer ¶

func LiteralMatchReplacer(manifest *config.Manifest, vars map[string]string) func(string) string

LiteralMatchReplacer returns a function that will perform template replacement on a string or substring, using the configured delimiters and vars. This function supports zero or one modifiers per variable.

func LoadVarsInteractive ¶

func LoadVarsInteractive(manifestVars map[string]*config.ManifestVar, lockfileVars map[string]string) (map[string]string, error)

LoadVarsInteractive loads vars from lockfile, and prompts the user for any vars that are in the manifest but not in the lockfile.

func RegexpLoopReplacer ¶

func RegexpLoopReplacer(manifest *config.Manifest, vars map[string]string) (func(string) string, error)

func RegexpReplacer ¶

func RegexpReplacer(manifest *config.Manifest, vars map[string]string) (func(string) string, error)

func Remove ¶

func Remove(lockfile *config.Lockfile, scaffoldSource, outdir string) error

func Upgrade ¶

func Upgrade(lockfile *config.Lockfile, scaffoldSource, outdir string) error

Types ¶

type Scaffold ¶

type Scaffold struct {
	Files    []ScaffoldFile
	Manifest *config.Manifest
	Vars     map[string]string
}

func LoadFromDir ¶

func LoadFromDir(dirName string) (*Scaffold, error)

type ScaffoldFile ¶

type ScaffoldFile struct {
	// RelativePath is the file path relative to the root of the scaffold directory
	RelativePath string
	// FullPath is the absolute path to the file
	FullPath string
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL