golang/ent
1
0
Fork 0
mirror of https://github.com/ent/ent.git synced 2026-05-04 08:30:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc: update examples for custom templates

Browse Source
This commit is contained in:
Ariel Mashraki
2020-09-15 15:30:11 +03:00
committed by Ariel Mashraki
parent e26e99b643
commit c6f9d25d8e
2 changed files with 49 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
doc/md/templates.md
View File

@@ -7,9 +7,10 @@ title: External Templates
If the template name is already defined by `entc`, it will override the existing one. Otherwise, it will write the
execution output to a file with the same name as the template. For example:
`node.tmpl` - This template example will be written in a file named: `ent/node.go`.
`stringer.tmpl` - This template example will be written in a file named: `ent/stringer.go`.
```gotemplate
{{ define "node" }}
{{ define "stringer" }}
{{/* Add the base header for the generated file */}}
{{ $pkg := base $.Config.Package }}
@@ -29,6 +30,32 @@ execution output to a file with the same name as the template. For example:
{{ end }}
```
`debug.tmpl` - This template example will be written in a file named: `ent/debug.go`.
```gotemplate
{{ define "debug" }}
{{/* A template that adds the functionality for running each client <T> in debug mode */}}
{{/* Add the base header for the generated file */}}
{{ $pkg := base $.Config.Package }}
{{ template "header" $ }}
{{/* Loop over all nodes and add option the "Debug" method */}}
{{ range $n := $.Nodes }}
{{ $client := print $n.Name "Client" }}
func (c *{{ $client }}) Debug() *{{ $client }} {
if c.debug {
return c
}
cfg := config{driver: dialect.Debug(c.driver, c.log), log: c.log, debug: true, hooks: c.hooks}
return &{{ $client }}{config: cfg}
}
{{ end }}
{{ end }}
```
In order to override an existing template, use its name. For example:
```gotemplate
{{/* A template for adding additional fields to specific types. */}}
@@ -98,9 +125,12 @@ func (User) Fields() []ent.Field {
## Examples
A custom template for implementing the `Node` API for GraphQL -
- A custom template for implementing the `Node` API for GraphQL -
[Github](https://github.com/facebook/ent/blob/master/entc/integration/template/ent/template/node.tmpl).
- An example for executing external templates with custom functions. See [configuration](https://github.com/facebook/ent/blob/master/examples/entcpkg/ent/entc.go) and its
[README](https://github.com/facebook/ent/blob/master/examples/entcpkg) file.
## Documentation
Templates are executed on either a specific node-type or the entire schema graph. For API