# Sprig: Template functions for Go templates
[![GoDoc](https://img.shields.io/static/v1?label=godoc&message=reference&color=blue)](https://pkg.go.dev/github.com/Masterminds/sprig/v3)
[![Go Report Card](https://goreportcard.com/badge/github.com/Masterminds/sprig)](https://goreportcard.com/report/github.com/Masterminds/sprig)
[![Stability: Sustained](https://masterminds.github.io/stability/sustained.svg)](https://masterminds.github.io/stability/sustained.html)
[![](https://github.com/Masterminds/sprig/workflows/Tests/badge.svg)](https://github.com/Masterminds/sprig/actions)
The Go language comes with a [built-in template
language](http://golang.org/pkg/text/template/), but not
very many template functions. Sprig is a library that provides more than 100 commonly
used template functions.
It is inspired by the template functions found in
[Twig](http://twig.sensiolabs.org/documentation) and in various
JavaScript libraries, such as [underscore.js](http://underscorejs.org/).
## IMPORTANT NOTES
Sprig leverages [mergo](https://github.com/imdario/mergo) to handle merges. In
its v0.3.9 release, there was a behavior change that impacts merging template
functions in sprig. It is currently recommended to use v0.3.10 or later of that package.
Using v0.3.9 will cause sprig tests to fail.
## Package Versions
There are two active major versions of the `sprig` package.
* v3 is currently stable release series on the `master` branch. The Go API should
remain compatible with v2, the current stable version. Behavior change behind
some functions is the reason for the new major version.
* v2 is the previous stable release series. It has been more than three years since
the initial release of v2. You can read the documentation and see the code
on the [release-2](https://github.com/Masterminds/sprig/tree/release-2) branch.
Bug fixes to this major version will continue for some time.
## Usage
**Template developers**: Please use Sprig's [function documentation](http://masterminds.github.io/sprig/) for
detailed instructions and code snippets for the >100 template functions available.
**Go developers**: If you'd like to include Sprig as a library in your program,
our API documentation is available [at GoDoc.org](http://godoc.org/github.com/Masterminds/sprig).
For standard usage, read on.
### Load the Sprig library
To load the Sprig `FuncMap`:
```go
import (
"github.com/Masterminds/sprig/v3"
"html/template"
)
// This example illustrates that the FuncMap *must* be set before the
// templates themselves are loaded.
tpl := template.Must(
template.New("base").Funcs(sprig.FuncMap()).ParseGlob("*.html")
)
```
### Calling the functions inside of templates
By convention, all functions are lowercase. This seems to follow the Go
idiom for template functions (as opposed to template methods, which are
TitleCase). For example, this:
```
{{ "hello!" | upper | repeat 5 }}
```
produces this:
```
HELLO!HELLO!HELLO!HELLO!HELLO!
```
## Principles Driving Our Function Selection
We followed these principles to decide which functions to add and how to implement them:
- Use template functions to build layout. The following
types of operations are within the domain of template functions:
- Formatting
- Layout
- Simple type conversions
- Utilities that assist in handling common formatting and layout needs (e.g. arithmetic)
- Template functions should not return errors unless there is no way to print
a sensible value. For example, converting a string to an integer should not
produce an error if conversion fails. Instead, it should display a default
value.
- Simple math is necessary for grid layouts, pagers, and so on. Complex math
(anything other than arithmetic) should be done outside of templates.
- Template functions only deal with the data passed into them. They never retrieve
data from a source.
- Finally, do not override core Go template functions.
赵闪闪168
- 粉丝: 1726
- 资源: 6943
最新资源
- LLC谐振变器常用控制的闭环仿真 1. 变频控制PFM 2. PFM电压电流双环控制 3. PWM控制,占空比控制 4. Burst控制,间歇控制,着重于轻载调节 5. ADRC,自抗扰控制,相比P
- C语言实例-毕业设计项目:数字时钟模拟程序-开题报告,论文,答辩PPT参考
- C++语言实例-毕业设计项目:图形动画模拟与交互特点-开题报告,论文,答辩PPT参考
- 格子玻尔兹曼LBM三相驱替,油、水、二氧化碳三组分
- STM32同步Buck降压开关电源变器开方案 主控STM32F334,输入12-32V,输出5-28V,最大电流5.5A,才有恒压限流模式,开关频率200kHz,PID控制与2零3极点控制 输出纹波
- 3215_126216780.html
- HTML5实现好看的理发店发廊电商网站模板.zip
- HTML5实现好看的宽屏运动鞋商城网站模板.zip
- HTML5实现好看的流浪动物领养中心网站源码.zip
- HTML5实现好看的绿色大气学校网站源码.zip
- HTML5实现好看的轮滑培训公司网站源码.zip
- HTML5实现好看的律师法律服务网站模板.zip
- HTML5实现好看的绿色网上书城网站源码.zip
- HTML5实现好看的绿色蔬菜网上超市网站模板.zip
- HTML5实现好看的绿色视频剪辑企业网站模板.zip
- HTML5实现好看的绿色游戏评测公司网站模板.zip
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈