You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Name of your project. This will be used to name the github repos as well as in other parts of the generated code.
97
97
98
98
[]() | |
99
99
--- | ---
100
100
Required | True
101
101
Type | String
102
102
103
-
## context<aname="context"></a>
103
+
## Context<aname="context"></a>
104
104
A key value map of global context parameters to use in the templates.
105
105
106
106
[]() | |
107
107
--- | ---
108
108
Required | False
109
109
Type | Map[String]
110
110
111
-
## modules<aname="modules"></a>
111
+
## Modules<aname="modules"></a>
112
112
List of modules template modules to import
113
113
114
114
[]() | |
115
115
--- | ---
116
116
Required | True
117
117
Type | Map[Module]
118
118
119
-
## source<aname="module-source"></a>
119
+
## Source<aname="module-source"></a>
120
120
We are using go-getter to parse the sources, we you can use any URL or file formats that [go-getter](https://github.com/hashicorp/go-getter#url-format) supports.
121
121
122
122
[]() | |
123
123
--- | ---
124
124
Required | True
125
125
Type | String
126
126
127
-
## module<aname="module-params"></a>
127
+
## Params<aname="module-params"></a>
128
128
Module parameters to use during templating
129
129
130
130
[]() | |
131
131
--- | ---
132
132
Required | True
133
133
Type | String
134
134
135
-
## output<aname="module-output"></a>
135
+
## Output<aname="module-output"></a>
136
136
Template output directory that the current module should write to.
137
137
138
138
[]() | |
139
139
--- | ---
140
140
Required | False
141
141
Type | String
142
142
143
-
## output<aname="module-overwrite"></a>
143
+
## Overwrite<aname="module-overwrite"></a>
144
144
Whether to overwrite existing files when generating files from templates
145
145
146
146
[]() | |
@@ -163,15 +163,15 @@ template:
163
163
output: web-app
164
164
```
165
165
166
-
## name<aname="module-name"></a>
166
+
## Name<aname="module-name"></a>
167
167
Name of your module. This will be used as the default module directory as well as a display name in the prompts.
168
168
169
169
[]() | |
170
170
--- | ---
171
171
Required | True
172
172
Type | String
173
173
174
-
## description<aname="module-description"></a>
174
+
## Description<aname="module-description"></a>
175
175
Short description of the module
176
176
177
177
[]() | |
@@ -186,23 +186,23 @@ Template configurations
186
186
Required | False
187
187
Type | Map
188
188
189
-
## extension<aname="template-extension"></a>
189
+
## Extension<aname="template-extension"></a>
190
190
File extension to signify that a file is a template. If this is defined, non-template files will not be parsed and will be copied over directly. The default value is `.tmplt`
191
191
192
192
[]() | |
193
193
--- | ---
194
194
Required | False
195
195
Type | Map
196
196
197
-
## delimiters<aname="template-delimiters"></a>
197
+
## Delimiters<aname="template-delimiters"></a>
198
198
An pair of delimiters that the template engine should use. The default values are: `{{`, `}}`
199
199
200
200
[]() | |
201
201
--- | ---
202
202
Required | False
203
203
Type | Map[String]
204
204
205
-
## output<aname="template-output"></a>
205
+
## Output<aname="template-output"></a>
206
206
The default template output directory that you want the template engine to write to. This will be overwritten by the
207
207
208
208
[]() | |
@@ -233,7 +233,7 @@ The message that will be presented to the user
233
233
Required | False
234
234
Type | String
235
235
236
-
## options<aname="prompt-label"></a>
236
+
## Options<aname="prompt-options"></a>
237
237
A list of options to select from. If not given, then it will be rendered as a text input prompt.
0 commit comments