README
¶
A general-purpose project scaffolding library and tool inspired by cookiecutter
Scaffolder evaluates the scaffolding files at the given destination against ctx using the following rules:
- Templates are evaluated using the Go template engine.
- Both path names and file contents are evaluated.
- If a file name ends with
.tmpl, the.tmplsuffix is removed. - If a file or directory name evalutes to the empty string it will be excluded.
- If a file named
template.jsexists in the root of the template directory, all functions defined in this file will be available as Go template functions. - Directory and file names in templates can be expanded multiple times
using the
pushfunction. This function takes two arguments, the file/directory name and the context to use when evaluating templates within the file/directory.
Examples
Multiple directories
template/
{{ range .Modules }}{{ push .Name . }}{{ end }}/
file.txt
Documentation
¶
Overview ¶
Package scaffolder is a general purpose file-system based scaffolding tool inspired by cookiecutter.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrSkip = errors.New("skip directory")
ErrSkip can be returned by WalkDir callbacks to skip a file or directory.
Functions ¶
Types ¶
type AfterEachExtensionFunc ¶ added in v0.7.0
AfterEachExtensionFunc is a convenience type for creating an Extension.AfterEach from a function.
func (AfterEachExtensionFunc) AfterEach ¶ added in v0.7.0
func (f AfterEachExtensionFunc) AfterEach(path string) error
func (AfterEachExtensionFunc) Extend ¶ added in v0.7.0
func (f AfterEachExtensionFunc) Extend(mutableConfig *Config) error
type Config ¶ added in v0.6.0
type Config struct {
Context any
Funcs FuncMap
Exclude []string
// contains filtered or unexported fields
}
Config for the scaffolding.
type ExtensionFunc ¶ added in v0.6.0
ExtensionFunc is a convenience type for creating an Extension.Extend from a function.
func (ExtensionFunc) AfterEach ¶ added in v0.6.0
func (f ExtensionFunc) AfterEach(path string) error
func (ExtensionFunc) Extend ¶ added in v0.6.0
func (f ExtensionFunc) Extend(mutableConfig *Config) error
type FuncMap ¶ added in v0.6.0
FuncMap is a map of functions to use in scaffolding templates.
The key is the function name and the value is a function taking a single argument and returning either `string` or `(string, error)`.
type Option ¶
type Option func(*scaffoldOptions)
Option is a function that modifies the behaviour of the scaffolder.
func AfterEach ¶ added in v0.6.0
AfterEach configures Scaffolder to call "after" for each file or directory created.
Useful for setting file permissions, etc.
Each AfterEach function is called in order.
func Exclude ¶ added in v0.3.0
Exclude the given regex paths from scaffolding.
Matching occurs before template evaluation and .tmpl suffix removal.
Source Files
Directories