Skip to content

Commit 27b26b5

Browse files
thaJeztahthaJeztah
authored
Merge pull request #8 from crazy-max/escape-pipe
Escape pipe char for Markdown table
2 parents cf46896 + be85b21 commit 27b26b5

7 files changed

Lines changed: 355 additions & 21 deletions

File tree

‎clidocstool_md.go‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,10 +179,14 @@ func mdCmdOutput(cmd *cobra.Command, old string) (string, error) {
179179
}
180180
name += "`"
181181
name = mdMakeLink(name, f.Name, f, isLink)
182-
fmt.Fprintf(b, "%s | %s |\n", name, f.Usage)
182+
fmt.Fprintf(b, "%s | %s |\n", mdEscapePipe(name), mdEscapePipe(f.Usage))
183183
})
184184
fmt.Fprintln(b, "")
185185
}
186186

187187
return b.String(), nil
188188
}
189+
190+
func mdEscapePipe(s string) string {
191+
return strings.ReplaceAll(s, `|`, `\|`)
192+
}

‎clidocstool_md_test.go‎

Lines changed: 49 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,63 @@ import (
2121
"testing"
2222

2323
"github.com/spf13/cobra"
24+
"github.com/stretchr/testify/assert"
25+
"github.com/stretchr/testify/require"
2426
)
2527

28+
//nolint:errcheck
2629
func TestGenMarkdownTree(t *testing.T) {
2730
c := &cobra.Command{Use: "do [OPTIONS] arg1 arg2"}
2831
s := &cobra.Command{Use: "sub [OPTIONS] arg1 arg2"}
32+
33+
flags := s.Flags()
34+
_ = flags.Bool("push", false, "Shorthand for --output=type=registry")
35+
_ = flags.Bool("load", false, "Shorthand for --output=type=docker")
36+
_ = flags.StringArrayP("tag", "t", []string{}, "Name and optionally a tag in the 'name:tag' format")
37+
flags.SetAnnotation("tag", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#tag-an-image--t"})
38+
_ = flags.StringArray("build-arg", []string{}, "Set build-time variables")
39+
flags.SetAnnotation("build-arg", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#set-build-time-variables---build-arg"})
40+
_ = flags.StringP("file", "f", "", "Name of the Dockerfile (Default is 'PATH/Dockerfile')")
41+
flags.SetAnnotation("file", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#specify-a-dockerfile--f"})
42+
_ = flags.StringArray("label", []string{}, "Set metadata for an image")
43+
_ = flags.StringArray("cache-from", []string{}, "External cache sources (eg. user/app:cache, type=local,src=path/to/dir)")
44+
_ = flags.StringArray("cache-to", []string{}, "Cache export destinations (eg. user/app:cache, type=local,dest=path/to/dir)")
45+
_ = flags.String("target", "", "Set the target build stage to build.")
46+
flags.SetAnnotation("target", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#specifying-target-build-stage---target"})
47+
_ = flags.StringSlice("allow", []string{}, "Allow extra privileged entitlement, e.g. network.host, security.insecure")
48+
_ = flags.StringArray("platform", []string{}, "Set target platform for build")
49+
_ = flags.StringArray("secret", []string{}, "Secret file to expose to the build: id=mysecret,src=/local/secret")
50+
_ = flags.StringArray("ssh", []string{}, "SSH agent socket or keys to expose to the build (format: `default|<id>[=<socket>|<key>[,<key>]]`)")
51+
_ = flags.StringArrayP("output", "o", []string{}, "Output destination (format: type=local,dest=path)")
52+
// not implemented
53+
_ = flags.String("network", "default", "Set the networking mode for the RUN instructions during build")
54+
_ = flags.StringSlice("add-host", []string{}, "Add a custom host-to-IP mapping (host:ip)")
55+
_ = flags.SetAnnotation("add-host", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#add-entries-to-container-hosts-file---add-host"})
56+
_ = flags.String("iidfile", "", "Write the image ID to the file")
57+
// hidden flags
58+
_ = flags.BoolP("quiet", "q", false, "Suppress the build output and print image ID on success")
59+
flags.MarkHidden("quiet")
60+
_ = flags.Bool("squash", false, "Squash newly built layers into a single new layer")
61+
flags.MarkHidden("squash")
62+
_ = flags.String("ulimit", "", "Ulimit options")
63+
flags.MarkHidden("ulimit")
64+
_ = flags.StringSlice("security-opt", []string{}, "Security options")
65+
flags.MarkHidden("security-opt")
66+
_ = flags.Bool("compress", false, "Compress the build context using gzip")
67+
2968
c.AddCommand(s)
3069

3170
tmpdir, err := ioutil.TempDir("", "test-gen-markdown-tree")
32-
if err != nil {
33-
t.Fatalf("Failed to create tmpdir: %s", err.Error())
34-
}
35-
defer os.RemoveAll(tmpdir)
71+
require.NoError(t, err)
3672

37-
if err := GenMarkdownTree(c, tmpdir); err != nil {
38-
t.Fatalf("GenMarkdownTree failed: %s", err.Error())
39-
}
73+
defer os.RemoveAll(tmpdir)
74+
require.NoError(t, GenMarkdownTree(c, tmpdir))
4075

41-
if _, err := os.Stat(filepath.Join(tmpdir, "sub.md")); err != nil {
42-
t.Fatalf("Expected file 'sub.md' to exist")
43-
}
76+
fres := filepath.Join(tmpdir, "sub.md")
77+
require.FileExists(t, fres)
78+
bres, err := ioutil.ReadFile(fres)
79+
require.NoError(t, err)
80+
bexc, err := ioutil.ReadFile("fixtures/sub.md")
81+
require.NoError(t, err)
82+
assert.Equal(t, string(bres), string(bexc))
4483
}

‎clidocstool_yaml_test.go‎

Lines changed: 49 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,63 @@ import (
2121
"testing"
2222

2323
"github.com/spf13/cobra"
24+
"github.com/stretchr/testify/assert"
25+
"github.com/stretchr/testify/require"
2426
)
2527

28+
//nolint:errcheck
2629
func TestGenYamlTree(t *testing.T) {
2730
c := &cobra.Command{Use: "do [OPTIONS] arg1 arg2"}
2831
s := &cobra.Command{Use: "sub [OPTIONS] arg1 arg2", Run: func(cmd *cobra.Command, args []string) {}}
32+
33+
flags := s.Flags()
34+
_ = flags.Bool("push", false, "Shorthand for --output=type=registry")
35+
_ = flags.Bool("load", false, "Shorthand for --output=type=docker")
36+
_ = flags.StringArrayP("tag", "t", []string{}, "Name and optionally a tag in the 'name:tag' format")
37+
flags.SetAnnotation("tag", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#tag-an-image--t"})
38+
_ = flags.StringArray("build-arg", []string{}, "Set build-time variables")
39+
flags.SetAnnotation("build-arg", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#set-build-time-variables---build-arg"})
40+
_ = flags.StringP("file", "f", "", "Name of the Dockerfile (Default is 'PATH/Dockerfile')")
41+
flags.SetAnnotation("file", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#specify-a-dockerfile--f"})
42+
_ = flags.StringArray("label", []string{}, "Set metadata for an image")
43+
_ = flags.StringArray("cache-from", []string{}, "External cache sources (eg. user/app:cache, type=local,src=path/to/dir)")
44+
_ = flags.StringArray("cache-to", []string{}, "Cache export destinations (eg. user/app:cache, type=local,dest=path/to/dir)")
45+
_ = flags.String("target", "", "Set the target build stage to build.")
46+
flags.SetAnnotation("target", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#specifying-target-build-stage---target"})
47+
_ = flags.StringSlice("allow", []string{}, "Allow extra privileged entitlement, e.g. network.host, security.insecure")
48+
_ = flags.StringArray("platform", []string{}, "Set target platform for build")
49+
_ = flags.StringArray("secret", []string{}, "Secret file to expose to the build: id=mysecret,src=/local/secret")
50+
_ = flags.StringArray("ssh", []string{}, "SSH agent socket or keys to expose to the build (format: `default|<id>[=<socket>|<key>[,<key>]]`)")
51+
_ = flags.StringArrayP("output", "o", []string{}, "Output destination (format: type=local,dest=path)")
52+
// not implemented
53+
_ = flags.String("network", "default", "Set the networking mode for the RUN instructions during build")
54+
_ = flags.StringSlice("add-host", []string{}, "Add a custom host-to-IP mapping (host:ip)")
55+
_ = flags.SetAnnotation("add-host", "docs.external.url", []string{"https://docs.docker.com/engine/reference/commandline/build/#add-entries-to-container-hosts-file---add-host"})
56+
_ = flags.String("iidfile", "", "Write the image ID to the file")
57+
// hidden flags
58+
_ = flags.BoolP("quiet", "q", false, "Suppress the build output and print image ID on success")
59+
flags.MarkHidden("quiet")
60+
_ = flags.Bool("squash", false, "Squash newly built layers into a single new layer")
61+
flags.MarkHidden("squash")
62+
_ = flags.String("ulimit", "", "Ulimit options")
63+
flags.MarkHidden("ulimit")
64+
_ = flags.StringSlice("security-opt", []string{}, "Security options")
65+
flags.MarkHidden("security-opt")
66+
_ = flags.Bool("compress", false, "Compress the build context using gzip")
67+
2968
c.AddCommand(s)
3069

3170
tmpdir, err := ioutil.TempDir("", "test-gen-yaml-tree")
32-
if err != nil {
33-
t.Fatalf("Failed to create tmpdir: %s", err.Error())
34-
}
35-
defer os.RemoveAll(tmpdir)
71+
require.NoError(t, err)
3672

37-
if err := GenYamlTree(c, tmpdir); err != nil {
38-
t.Fatalf("GenYamlTree failed: %s", err.Error())
39-
}
73+
defer os.RemoveAll(tmpdir)
74+
require.NoError(t, GenYamlTree(c, tmpdir))
4075

41-
if _, err := os.Stat(filepath.Join(tmpdir, "do_sub.yaml")); err != nil {
42-
t.Fatalf("Expected file 'do_sub.yaml' to exist")
43-
}
76+
fres := filepath.Join(tmpdir, "do_sub.yaml")
77+
require.FileExists(t, fres)
78+
bres, err := ioutil.ReadFile(fres)
79+
require.NoError(t, err)
80+
bexc, err := ioutil.ReadFile("fixtures/do_sub.yaml")
81+
require.NoError(t, err)
82+
assert.Equal(t, string(bres), string(bexc))
4483
}

‎fixtures/do_sub.yaml‎

Lines changed: 218 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,218 @@
1+
command: do sub
2+
usage: do sub [OPTIONS] arg1 arg2 [flags]
3+
pname: do
4+
plink: do.yaml
5+
options:
6+
- option: add-host
7+
value_type: stringSlice
8+
default_value: '[]'
9+
description: Add a custom host-to-IP mapping (host:ip)
10+
details_url: /engine/reference/commandline/build/#add-entries-to-container-hosts-file---add-host
11+
deprecated: false
12+
experimental: false
13+
experimentalcli: false
14+
kubernetes: false
15+
swarm: false
16+
- option: allow
17+
value_type: stringSlice
18+
default_value: '[]'
19+
description: |
20+
Allow extra privileged entitlement, e.g. network.host, security.insecure
21+
deprecated: false
22+
experimental: false
23+
experimentalcli: false
24+
kubernetes: false
25+
swarm: false
26+
- option: build-arg
27+
value_type: stringArray
28+
default_value: '[]'
29+
description: Set build-time variables
30+
details_url: /engine/reference/commandline/build/#set-build-time-variables---build-arg
31+
deprecated: false
32+
experimental: false
33+
experimentalcli: false
34+
kubernetes: false
35+
swarm: false
36+
- option: cache-from
37+
value_type: stringArray
38+
default_value: '[]'
39+
description: |
40+
External cache sources (eg. user/app:cache, type=local,src=path/to/dir)
41+
deprecated: false
42+
experimental: false
43+
experimentalcli: false
44+
kubernetes: false
45+
swarm: false
46+
- option: cache-to
47+
value_type: stringArray
48+
default_value: '[]'
49+
description: |
50+
Cache export destinations (eg. user/app:cache, type=local,dest=path/to/dir)
51+
deprecated: false
52+
experimental: false
53+
experimentalcli: false
54+
kubernetes: false
55+
swarm: false
56+
- option: compress
57+
value_type: bool
58+
default_value: "false"
59+
description: Compress the build context using gzip
60+
deprecated: false
61+
experimental: false
62+
experimentalcli: false
63+
kubernetes: false
64+
swarm: false
65+
- option: file
66+
shorthand: f
67+
value_type: string
68+
description: Name of the Dockerfile (Default is 'PATH/Dockerfile')
69+
details_url: /engine/reference/commandline/build/#specify-a-dockerfile--f
70+
deprecated: false
71+
experimental: false
72+
experimentalcli: false
73+
kubernetes: false
74+
swarm: false
75+
- option: iidfile
76+
value_type: string
77+
description: Write the image ID to the file
78+
deprecated: false
79+
experimental: false
80+
experimentalcli: false
81+
kubernetes: false
82+
swarm: false
83+
- option: label
84+
value_type: stringArray
85+
default_value: '[]'
86+
description: Set metadata for an image
87+
deprecated: false
88+
experimental: false
89+
experimentalcli: false
90+
kubernetes: false
91+
swarm: false
92+
- option: load
93+
value_type: bool
94+
default_value: "false"
95+
description: Shorthand for --output=type=docker
96+
deprecated: false
97+
experimental: false
98+
experimentalcli: false
99+
kubernetes: false
100+
swarm: false
101+
- option: network
102+
value_type: string
103+
default_value: default
104+
description: Set the networking mode for the RUN instructions during build
105+
deprecated: false
106+
experimental: false
107+
experimentalcli: false
108+
kubernetes: false
109+
swarm: false
110+
- option: output
111+
shorthand: o
112+
value_type: stringArray
113+
default_value: '[]'
114+
description: 'Output destination (format: type=local,dest=path)'
115+
deprecated: false
116+
experimental: false
117+
experimentalcli: false
118+
kubernetes: false
119+
swarm: false
120+
- option: platform
121+
value_type: stringArray
122+
default_value: '[]'
123+
description: Set target platform for build
124+
deprecated: false
125+
experimental: false
126+
experimentalcli: false
127+
kubernetes: false
128+
swarm: false
129+
- option: push
130+
value_type: bool
131+
default_value: "false"
132+
description: Shorthand for --output=type=registry
133+
deprecated: false
134+
experimental: false
135+
experimentalcli: false
136+
kubernetes: false
137+
swarm: false
138+
- option: quiet
139+
shorthand: q
140+
value_type: bool
141+
default_value: "false"
142+
description: Suppress the build output and print image ID on success
143+
deprecated: false
144+
experimental: false
145+
experimentalcli: false
146+
kubernetes: false
147+
swarm: false
148+
- option: secret
149+
value_type: stringArray
150+
default_value: '[]'
151+
description: 'Secret file to expose to the build: id=mysecret,src=/local/secret'
152+
deprecated: false
153+
experimental: false
154+
experimentalcli: false
155+
kubernetes: false
156+
swarm: false
157+
- option: security-opt
158+
value_type: stringSlice
159+
default_value: '[]'
160+
description: Security options
161+
deprecated: false
162+
experimental: false
163+
experimentalcli: false
164+
kubernetes: false
165+
swarm: false
166+
- option: squash
167+
value_type: bool
168+
default_value: "false"
169+
description: Squash newly built layers into a single new layer
170+
deprecated: false
171+
experimental: false
172+
experimentalcli: false
173+
kubernetes: false
174+
swarm: false
175+
- option: ssh
176+
value_type: stringArray
177+
default_value: '[]'
178+
description: |
179+
SSH agent socket or keys to expose to the build (format: `default|<id>[=<socket>|<key>[,<key>]]`)
180+
deprecated: false
181+
experimental: false
182+
experimentalcli: false
183+
kubernetes: false
184+
swarm: false
185+
- option: tag
186+
shorthand: t
187+
value_type: stringArray
188+
default_value: '[]'
189+
description: Name and optionally a tag in the 'name:tag' format
190+
details_url: /engine/reference/commandline/build/#tag-an-image--t
191+
deprecated: false
192+
experimental: false
193+
experimentalcli: false
194+
kubernetes: false
195+
swarm: false
196+
- option: target
197+
value_type: string
198+
description: Set the target build stage to build.
199+
details_url: /engine/reference/commandline/build/#specifying-target-build-stage---target
200+
deprecated: false
201+
experimental: false
202+
experimentalcli: false
203+
kubernetes: false
204+
swarm: false
205+
- option: ulimit
206+
value_type: string
207+
description: Ulimit options
208+
deprecated: false
209+
experimental: false
210+
experimentalcli: false
211+
kubernetes: false
212+
swarm: false
213+
deprecated: false
214+
experimental: false
215+
experimentalcli: false
216+
kubernetes: false
217+
swarm: false
218+

0 commit comments

Comments
 (0)