File: doc.go

package info (click to toggle)
golang-github-containers-common 0.33.4%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 856 kB
  • sloc: makefile: 118; sh: 25
file content (56 lines) | stat: -rw-r--r-- 1,430 bytes parent folder | download | duplicates (2)
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
/*
Package report provides helper structs/methods/funcs for formatting output

To format output for an array of structs:

	w := report.NewWriterDefault(os.Stdout)
	defer w.Flush()

	headers := report.Headers(struct {
		ID string
	}{}, nil)
	t, _ := report.NewTemplate("command name").Parse("{{range .}}{{.ID}}{{end}}")
	t.Execute(t, headers)
	t.Execute(t, map[string]string{
		"ID":"fa85da03b40141899f3af3de6d27852b",
	})
	// t.IsTable() == false

or

	w := report.NewWriterDefault(os.Stdout)
	defer w.Flush()

	headers := report.Headers(struct {
		CID string
	}{}, map[string]string{
		"CID":"ID"})
	t, _ := report.NewTemplate("command name").Parse("table {{.CID}}")
	t.Execute(t, headers)
	t.Execute(t,map[string]string{
		"CID":"fa85da03b40141899f3af3de6d27852b",
	})
	// t.IsTable() == true

Helpers:

	if report.IsJSON(cmd.Flag("format").Value.String()) {
		... process JSON and output
	}

Template Functions:

The following template functions are added to the template when parsed:
	- join  strings.Join, {{join .Field separator}}
	- lower strings.ToLower {{ .Field | lower }}
	- split strings.Split {{ .Field | split }}
	- title strings.Title {{ .Field | title }}
	- upper strings.ToUpper {{ .Field | upper }}

report.Funcs() may be used to add additional template functions.
Adding an existing function will replace that function for the life of that template.


Note: Your code should not ignore errors
*/
package report