FilesExpand file tree

v3-development-master

/

template.go

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

120 lines (92 loc) · 3.64 KB

v3-development-master

/

template.go

Copy path

Top

File metadata and controls

• Code
• Blame

120 lines (92 loc) · 3.64 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

package cli

// AppHelpTemplate is the text template for the Default help topic.

// cli.go uses text/template to render templates. You can

// render custom help text by setting this variable.

var AppHelpTemplate = `NAME:

{{.Name}}{{if .Usage}} - {{.Usage}}{{end}}

USAGE:

{{if .UsageText}}{{.UsageText}}{{else}}{{.HelpName}} {{if .VisibleFlags}}[global options]{{end}}{{if .Commands}} command [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}{{if .Version}}{{if not .HideVersion}}

VERSION:

{{.Version}}{{end}}{{end}}{{if .Description}}

DESCRIPTION:

{{.Description}}{{end}}{{if len .Authors}}

AUTHOR{{with $length := len .Authors}}{{if ne 1 $length}}S{{end}}{{end}}:

{{range $index, $author := .Authors}}{{if $index}}

{{end}}{{$author}}{{end}}{{end}}{{if .VisibleCommands}}

COMMANDS:{{range .VisibleCategories}}{{if .Name}}

{{.Name}}:{{range .VisibleCommands}}

{{join .Names ", "}}{{"\t"}}{{.Usage}}{{end}}{{else}}{{range .VisibleCommands}}

{{join .Names ", "}}{{"\t"}}{{.Usage}}{{end}}{{end}}{{end}}{{end}}{{if .VisibleFlags}}

GLOBAL OPTIONS:

{{range $index, $option := .VisibleFlags}}{{if $index}}

{{end}}{{$option}}{{end}}{{end}}{{if .Copyright}}

COPYRIGHT:

{{.Copyright}}{{end}}

`

// CommandHelpTemplate is the text template for the command help topic.

// cli.go uses text/template to render templates. You can

// render custom help text by setting this variable.

var CommandHelpTemplate = `NAME:

{{.HelpName}} - {{.Usage}}

USAGE:

{{if .UsageText}}{{.UsageText}}{{else}}{{.HelpName}}{{if .VisibleFlags}} [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}{{if .Category}}

CATEGORY:

{{.Category}}{{end}}{{if .Description}}

DESCRIPTION:

{{.Description}}{{end}}{{if .VisibleFlags}}

OPTIONS:

{{range .VisibleFlags}}{{.}}

{{end}}{{end}}

`

// SubcommandHelpTemplate is the text template for the subcommand help topic.

// cli.go uses text/template to render templates. You can

// render custom help text by setting this variable.

var SubcommandHelpTemplate = `NAME:

{{.HelpName}} - {{.Usage}}

USAGE:

{{if .UsageText}}{{.UsageText}}{{else}}{{.HelpName}} command{{if .VisibleFlags}} [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}{{end}}{{if .Description}}

DESCRIPTION:

{{.Description}}{{end}}

COMMANDS:{{range .VisibleCategories}}{{if .Name}}

{{.Name}}:{{range .VisibleCommands}}

{{join .Names ", "}}{{"\t"}}{{.Usage}}{{end}}{{else}}{{range .VisibleCommands}}

{{join .Names ", "}}{{"\t"}}{{.Usage}}{{end}}{{end}}{{end}}{{if .VisibleFlags}}

OPTIONS:

{{range .VisibleFlags}}{{.}}

{{end}}{{end}}

`

var MarkdownDocTemplate = `% {{ .App.Name }} 8

# NAME

{{ .App.Name }}{{ if .App.Usage }} - {{ .App.Usage }}{{ end }}

# SYNOPSIS

{{ .App.Name }}

{{ if .SynopsisArgs }}

` + "```" + `

{{ range $v := .SynopsisArgs }}{{ $v }}{{ end }}` + "```" + `

{{ end }}{{ if .App.UsageText }}

# DESCRIPTION

{{ .App.UsageText }}

{{ end }}

**Usage**:

` + "```" + `

{{ .App.Name }} [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]

` + "```" + `

{{ if .GlobalArgs }}

# GLOBAL OPTIONS

{{ range $v := .GlobalArgs }}

{{ $v }}{{ end }}

{{ end }}{{ if .Commands }}

# COMMANDS

{{ range $v := .Commands }}

{{ $v }}{{ end }}{{ end }}`

var FishCompletionTemplate = `# {{ .App.Name }} fish shell completion

function __fish_{{ .App.Name }}_no_subcommand --description 'Test if there has been any subcommand yet'

for i in (commandline -opc)

if contains -- $i{{ range $v := .AllCommands }} {{ $v }}{{ end }}

return 1

end

end

return 0

end

{{ range $v := .Completions }}{{ $v }}

{{ end }}`