diff --git a/cmd/docs/templates/schema.tmpl b/cmd/docs/templates/schema.tmpl index a715d41e..dd86899c 100644 --- a/cmd/docs/templates/schema.tmpl +++ b/cmd/docs/templates/schema.tmpl @@ -8,7 +8,7 @@ | `version` | `string` | | Version of the recipe. Must be valid [semver](https://semver.org/). | | `description` | `string` | | Description of what the recipe does | | `sources` | `[]string` | | A list of URLs to source code for this recipe. | -| `templateExtension` | `string` | | Extension of files in `sources` that are considered templates and are processed with the template engine. Must start with a period if not empty. | +| `templateExtension` | `string` | | File extension of files in "templates" directory which should be templated. Files not matched by this extension will be copied as-is. If left empty (the default), all files will be templated. | | `initHelp` | `string` | | A message which will be showed to an user after a succesful recipe execution. Can be used to guide the user what should be done next in the project directory. | | `ignorePatterns` | `[]string` | | Glob patterns for ignoring generated files from future recipe upgrades. Ignored files will not be regenerated even if their templates change in future versions of the recipe. | | `vars` | [`[]Variable`](#variable) | | An array of variables which can be used in templates. The user will be prompted to provide the value for the variable if not predefined with `--set` flag. | diff --git a/pkg/recipe/metadata.go b/pkg/recipe/metadata.go index b7beab3c..91d03fae 100644 --- a/pkg/recipe/metadata.go +++ b/pkg/recipe/metadata.go @@ -36,9 +36,9 @@ type Metadata struct { // of the recipe. IgnorePatterns []string `yaml:"ignorePatterns,omitempty"` - // File extension for which files in Sources should be templated. Files not matched by - // this extension will be copied as-is. If empty (the default) all files will be - // templated. + // File extension of files in "templates" directory which should be templated. + // Files not matched by this extension will be copied as-is. + // If left empty (the default), all files will be templated. TemplateExtension string `yaml:"templateExtension,omitempty"` }