-
Notifications
You must be signed in to change notification settings - Fork 96
/
doc.go
278 lines (277 loc) · 7.17 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
package hero
// Hero is a handy, fast and powerful go template engine, which pre-compiles the html templtes to go code.
// It has been used in production environment in [bthub.io](http://bthub.io).
//
// [](https://godoc.org/github.com/shiyanhui/hero)
// [](https://goreportcard.com/report/github.com/shiyanhui/hero)
//
// [中文文档](https://github.com/shiyanhui/hero/blob/master/README_CN.md)
//
// - [Features](#features)
// - [Install](#install)
// - [Usage](#usage)
// - [Quick Start](#quick-start)
// - [Template Syntax](#template-syntax)
// - [License](#license)
//
// ## Features
//
// - High performance.
// - Easy to use.
// - Powerful. template `Extend` and `Include` supported.
// - Auto compiling when files change.
//
// ## Performance
//
// Hero is the fastest and least-memory used among currently known template engines
// in the benchmark. For more details and benchmarks please come to [github.com/SlinSo/goTemplateBenchmark](https://github.com/SlinSo/goTemplateBenchmark).
//
// <img src='http://i.imgur.com/93D7T5C.png' width="600">
// <img src='http://i.imgur.com/EIGtYyF.png' width="600">
//
// ## Install
//
// go get github.com/shiyanhui/hero
// go install github.com/shiyanhui/hero/hero
//
// ## Usage
//
// ```shell
// hero [options]
//
// options:
// - source: the html template file or dir.
// - dest: generated golang files dir, it will be the same with source if not set.
// - pkgname: the generated template package name, default is `template`.
// - watch: whether automic compile when the source files change.
//
// example:
// hero -source="./"
// hero -source="$GOPATH/src/app/template" -watch
// ```
//
// ## Quick Start
//
// Assume that we are going to render a user list `userlist.html`. `index.html`
// is the layout, and `user.html` is an item in the list.
//
// And assumes that they are all under `$GOPATH/src/app/template`
//
// ### index.html
//
// ```html
// <!DOCTYPE html>
// <html>
// <head>
// <meta charset="utf-8">
// </head>
//
// <body>
// <%@ body { %>
// <% } %>
// </body>
// </html>
// ```
//
// ### users.html
//
// ```html
// <%: func UserList(userList []string) *bytes.Buffer %>
//
// <%~ "index.html" %>
//
// <%@ body { %>
// <% for _, user := range userList { %>
// <ul>
// <%+ "user.html" %>
// </ul>
// <% } %>
// <% } %>
// ```
//
// ### user.html
//
// ```html
// <li>
// <%= user %>
// </li>
// ```
//
// Then we compile the templates to go code.
//
// ```shell
// hero -source="$GOPATH/src/app/template"
// ```
//
// We will get three new `.go` files under `$GOPATH/src/app/template`,
// i.e. `index.html.go`, `user.html.go` and `userlist.html.go`.
//
// Then we write a http server in `$GOPATH/src/app/main.go`.
//
// ### main.go
//
// ```go
// package main
//
// import (
// "net/http"
//
// "app/template"
//
// "github.com/shiyanhui/hero"
// )
//
// func main() {
// http.HandleFunc("/users", func(w http.ResponseWriter, req *http.Request) {
// var userList = []string {
// "Alice",
// "Bob",
// "Tom",
// }
//
// buffer := template.UserList(userList)
// defer hero.PutBuffer(buffer)
//
// w.Write(buffer.Bytes())
// })
//
// http.ListenAndServe(":8080", nil)
// }
// ```
//
// At last, start the server and visit `http://localhost:8080/users` in your browser, we will get what we want!
//
// ## Template syntax
//
// There are only nine necessary kinds of statements, which are:
//
// - Function Definition `<%: func define %>`
// - Function definition statement defines the function which represents a html file.
// - The function defined should return one and only one parameter `*bytes.Buffer`.
// - Example:`<%: func UserList(userList []string) *bytes.Buffer %>`, which we have mentioned in quick start.
//
// - Extend `<%~ "parent template" %>`
// - Extend statement states the parent template the current template extends.
// - The parent template should be quoted with `""`.
// - Example: `<%~ "index.html" >`, which we have mentioned in quick start, too.
//
// - Include `<%+ "sub template" %>`
// - Include statement includes a sub-template to the current template. It works like `#include` in `C++`.
// - The sub-template should be quoted with `""`.
// - Example: `<%+ "user.html" >`, which we also have mentioned in quick start.
//
// - Import `<%! go code %>`
// - Import statement imports the packages used in the defined function, and it also contains everything that is outside of the defined function.
// - Import statement will NOT be inherited by child template.
// - Example:
//
// ```go
// <%!
// import (
// "fmt"
// "strings"
// )
//
// var a int
//
// const b = "hello, world"
//
// func Add(a, b int) int {
// return a + b
// }
//
// type S struct {
// Name string
// }
//
// func (s S) String() string {
// return s.Name
// }
// %>
// ```
//
// - Block `<%@ blockName { %> <% } %>`
//
// - Block statement represents a block. Child template overwrites blocks to extend parent template.
//
// - Example:
//
// ```html
// <!DOCTYPE html>
// <html>
// <head>
// <meta charset="utf-8">
// </head>
//
// <body>
// <%@ body { %>
// <% } %>
// </body>
// </html>
// ```
//
// - Code `<% go code %>`
//
// - Code statement states all code inside the defined function. It's just go code.
//
// - Example:
//
// ```go
// <% for _, user := userList { %>
// <% if user != "Alice" { %>
// <%= user %>
// <% } %>
// <% } %>
//
// <%
// a, b := 1, 2
// c := Add(a, b)
// %>
// ```
//
// - Raw Value `<%==[t] variable %>`
//
// - Raw Value statement will convert the variable to string.
// - `t` is the type of varible, hero will find suitable converting method by `t`. Condidates of `t` are:
// - `b`: bool
// - `i`: int, int8, int16, int32, int64
// - `u`: byte, uint, uint8, uint16, uint32, uint64
// - `f`: float32, float64
// - `s`: string
// - `bs`: []byte
// - `v`: interface
//
// Note:
// - If `t` is not set, the value of `t` is `s`.
// - Had better not use `v`, cause when `t=v`, the converting method is `fmt.Sprintf("%v", variable)` and it is very slow.
// - Example:
//
// ```go
// <%== "hello" %>
// <%==i 34 %>
// <%==u Add(a, b) %>
// <%==s user.Name %>
// ```
//
// - Escaped Value `<%=[t] variable %>`
//
// - Escaped Value statement is similar with Raw Value statement, but after converting, it will escaped it with `html.EscapesString`.
// - `t` is the same with that of `Raw Value Statement`.
// - Example:
//
// ```go
// <%= a %>
// <%=i a + b %>
// <%=u Add(a, b) %>
// <%=bs []byte{1, 2} %>
// ```
//
// - Note `<%# note %>`
//
// - Note statement add notes to the template.
// - It will not be added to the generated go source.
// - Example: `<# this is just a note example>`.
//
// ## License
//
// Hero is licensed under the Apache License.