Skip to content

chore: extract types for templates #517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 24, 2025
Merged

chore: extract types for templates #517

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ecb0dd
chore: extract types for templates
remyleone Sep 1, 2025
ede767e
Merge branch 'main' into extract_types
SBGoods Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 63 additions & 57 deletions internal/provider/template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,66 @@ type (
docTemplate string
)

type ResourceTemplateType struct {
Type string
Name string
Description string

HasExample bool
ExampleFile string

HasImport bool
ImportFile string

HasImportIDConfig bool
ImportIDConfigFile string

HasImportIdentityConfig bool
ImportIdentityConfigFile string
IdentitySchemaMarkdown string

ProviderName string
ProviderShortName string

SchemaMarkdown string

RenderedProviderName string
}

type ProviderTemplateType struct {
Description string

HasExample bool
ExampleFile string

ProviderName string
ProviderShortName string
SchemaMarkdown string

RenderedProviderName string
}

type FunctionTemplateType struct {
Type string
Name string
Description string
Summary string

HasExample bool
ExampleFile string

ProviderName string
ProviderShortName string

FunctionSignatureMarkdown string
FunctionArgumentsMarkdown string

HasVariadic bool
FunctionVariadicArgumentMarkdown string

RenderedProviderName string
}

func newTemplate(providerDir, name, text string) (*template.Template, error) {
tmpl := template.New(name)
titleCaser := cases.Title(language.Und)
Expand Down Expand Up @@ -132,18 +192,7 @@ func (t providerTemplate) Render(providerDir, providerName, renderedProviderName
return "", nil
}

return renderStringTemplate(providerDir, "providerTemplate", s, struct {
Description string

HasExample bool
ExampleFile string

ProviderName string
ProviderShortName string
SchemaMarkdown string

RenderedProviderName string
}{
return renderStringTemplate(providerDir, "providerTemplate", s, ProviderTemplateType{
Description: schema.Block.Description,

HasExample: exampleFile != "" && fileExists(exampleFile),
Expand Down Expand Up @@ -189,31 +238,7 @@ func (t resourceTemplate) Render(providerDir, name, providerName, renderedProvid
return "", fmt.Errorf("unable to render: an identity import example (%q) was provided for a resource (%q) that does not support resource identity", importIdentityConfigFile, name)
}

return renderStringTemplate(providerDir, "resourceTemplate", s, struct {
Type string
Name string
Description string

HasExample bool
ExampleFile string

HasImport bool
ImportFile string

HasImportIDConfig bool
ImportIDConfigFile string

HasImportIdentityConfig bool
ImportIdentityConfigFile string
IdentitySchemaMarkdown string

ProviderName string
ProviderShortName string

SchemaMarkdown string

RenderedProviderName string
}{
return renderStringTemplate(providerDir, "resourceTemplate", s, ResourceTemplateType{
Type: typeName,
Name: name,
Description: schema.Block.Description,
Expand Down Expand Up @@ -261,26 +286,7 @@ func (t functionTemplate) Render(providerDir, name, providerName, renderedProvid
return "", nil
}

return renderStringTemplate(providerDir, "resourceTemplate", s, struct {
Type string
Name string
Description string
Summary string

HasExample bool
ExampleFile string

ProviderName string
ProviderShortName string

FunctionSignatureMarkdown string
FunctionArgumentsMarkdown string

HasVariadic bool
FunctionVariadicArgumentMarkdown string

RenderedProviderName string
}{
return renderStringTemplate(providerDir, "resourceTemplate", s, FunctionTemplateType{
Type: typeName,
Name: name,
Description: signature.Description,
Expand Down
Loading