README
¶
ttouch
Unix touch with JavaScript driven templates.
Templates
The templating engine runs on the otto JavaScript runtime which targets ES5.
Templates are searched for in .ttouch directories staring in your current
working directory down to the root.
Templates are named all lowercase {ext}.js or {filename}.js - for example md.js for all .md files, or readme.md.js to match README.md. Filename matches take precidence over extension matches.
The template string is the result of the final execution of the JS file. For example, a dead simple template could be:
"#!/bin/sh\n";
If you want a little more control or clarity, you can wrap that in a function call:
(function () {
return "#!/bin/sh\n";
})();
Documentation
¶
Index ¶
- Variables
- func Asset(name string) ([]byte, error)
- func AssetDir(name string) ([]string, error)
- func AssetInfo(name string) (os.FileInfo, error)
- func AssetNames() []string
- func MustAsset(name string) []byte
- func New(envflags interface{}) *templater
- func RestoreAsset(dir, name string) error
- func RestoreAssets(dir, name string) error
- type JSFlags
Constants ¶
This section is empty.
Variables ¶
var ErrTemplateNotFound = errors.New("tempate not found")
ErrTemplateNotFound is returned when no template was found for the given type in any of the template locations
Functions ¶
func Asset ¶
Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.
func AssetDir ¶
AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:
data/
foo.txt
img/
a.png
b.png
then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.
func AssetInfo ¶
AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.
func MustAsset ¶
MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.
func RestoreAsset ¶
RestoreAsset restores an asset under the given directory
func RestoreAssets ¶
RestoreAssets restores an asset under the given directory recursively
Source Files
Directories