Feat/scaffold templates from arg

internal/cmd/generate_resources.go

@@ -78,7 +78,7 @@ func (cmd *GenerateResourcesCommand) Help() string {
 	return strBuilder.String()
 }
 
-func (a *GenerateResourcesCommand) Synopsis() string {
+func (cmd *GenerateResourcesCommand) Synopsis() string {
 	return "Generate code for resources from an Intermediate Representation (IR) JSON file."
 }
 

internal/cmd/scaffold_data_source.go

@@ -26,6 +26,7 @@ type ScaffoldDataSourceCommand struct {
 	flagOutputFile          string
 	flagPackageName         string
 	flagForceOverwrite      bool
+	flagTemplatePath        string
 }
 
 func (cmd *ScaffoldDataSourceCommand) Flags() *flag.FlagSet {
@@ -36,6 +37,8 @@ func (cmd *ScaffoldDataSourceCommand) Flags() *flag.FlagSet {
 	fs.StringVar(&cmd.flagOutputDir, "output-dir", ".", "directory path to output scaffolded code file")
 	fs.StringVar(&cmd.flagOutputFile, "output-file", "", "file name and extension to write scaffolded code to, default will use the --name flag with '_data_source.go' suffix")
 	fs.StringVar(&cmd.flagPackageName, "package", "provider", "name of Go package for scaffolded code file")
+	fs.StringVar(&cmd.flagTemplatePath, "template", "", "path to template file for scaffolded code file")
+
 	return fs
 }
 
@@ -77,7 +80,7 @@ func (cmd *ScaffoldDataSourceCommand) Help() string {
 	return strBuilder.String()
 }
 
-func (a *ScaffoldDataSourceCommand) Synopsis() string {
+func (cmd *ScaffoldDataSourceCommand) Synopsis() string {
 	return "Create scaffolding code for a Terraform Plugin Framework data source."
 }
 
@@ -110,7 +113,7 @@ func (cmd *ScaffoldDataSourceCommand) runInternal(_ context.Context) error {
 		return fmt.Errorf("'%s' is not a valid Terraform data source identifier", cmd.flagDataSourceNameSnake)
 	}
 
-	goBytes, err := scaffold.DataSourceBytes(dataSourceIdentifier, cmd.flagPackageName)
+	goBytes, err := scaffold.DataSourceBytes(dataSourceIdentifier, cmd.flagPackageName, cmd.flagTemplatePath)
 	if err != nil {
 		return fmt.Errorf("error creating scaffolding data source Go code: %w", err)
 	}

internal/cmd/scaffold_resource.go

@@ -26,6 +26,7 @@ type ScaffoldResourceCommand struct {
 	flagOutputFile        string
 	flagPackageName       string
 	flagForceOverwrite    bool
+	flagTemplatePath      string
 }
 
 func (cmd *ScaffoldResourceCommand) Flags() *flag.FlagSet {
@@ -36,6 +37,8 @@ func (cmd *ScaffoldResourceCommand) Flags() *flag.FlagSet {
 	fs.StringVar(&cmd.flagOutputDir, "output-dir", ".", "directory path to output scaffolded code file")
 	fs.StringVar(&cmd.flagOutputFile, "output-file", "", "file name and extension to write scaffolded code to, default will use the --name flag with '_resource.go' suffix")
 	fs.StringVar(&cmd.flagPackageName, "package", "provider", "name of Go package for scaffolded code file")
+	fs.StringVar(&cmd.flagTemplatePath, "template", "", "path to template file for scaffolded code file")
+
 	return fs
 }
 
@@ -77,7 +80,7 @@ func (cmd *ScaffoldResourceCommand) Help() string {
 	return strBuilder.String()
 }
 
-func (a *ScaffoldResourceCommand) Synopsis() string {
+func (cmd *ScaffoldResourceCommand) Synopsis() string {
 	return "Create scaffolding code for a Terraform Plugin Framework resource."
 }
 
@@ -110,7 +113,7 @@ func (cmd *ScaffoldResourceCommand) runInternal(_ context.Context) error {
 		return fmt.Errorf("'%s' is not a valid Terraform resource identifier", cmd.flagResourceNameSnake)
 	}
 
-	goBytes, err := scaffold.ResourceBytes(resourceIdentifier, cmd.flagPackageName)
+	goBytes, err := scaffold.ResourceBytes(resourceIdentifier, cmd.flagPackageName, cmd.flagTemplatePath)
 	if err != nil {
 		return fmt.Errorf("error creating scaffolding resource Go code: %w", err)
 	}

internal/scaffold/data_source.go

@@ -5,14 +5,26 @@ package scaffold
 
 import (
 	"bytes"
+	"os"
 	"text/template"
 
 	"github.com/hashicorp/terraform-plugin-codegen-framework/internal/schema"
 )
 
 // DataSourceBytes will create scaffolding Go code bytes for a Terraform Plugin Framework data source
-func DataSourceBytes(dataSourceIdentifier schema.FrameworkIdentifier, packageName string) ([]byte, error) {
-	t, err := template.New("data_source_scaffold").Parse(dataSourceScaffoldGoTemplate)
+func DataSourceBytes(dataSourceIdentifier schema.FrameworkIdentifier, packageName, templatePath string) ([]byte, error) {
+	templateStr := dataSourceScaffoldGoTemplate
+
+	if templatePath != "" {
+		file, err := os.ReadFile(templatePath)
+		if err != nil {
+			return nil, err
+		}
+
+		templateStr = string(file)
+	}
+
+	t, err := template.New("data_source_scaffold").Parse(templateStr)
 	if err != nil {
 		return nil, err
 	}

internal/scaffold/resource.go

@@ -5,14 +5,26 @@ package scaffold
 
 import (
 	"bytes"
+	"os"
 	"text/template"
 
 	"github.com/hashicorp/terraform-plugin-codegen-framework/internal/schema"
 )
 
 // ResourceBytes will create scaffolding Go code bytes for a Terraform Plugin Framework resource
-func ResourceBytes(resourceIdentifier schema.FrameworkIdentifier, packageName string) ([]byte, error) {
-	t, err := template.New("resource_scaffold").Parse(resourceScaffoldGoTemplate)
+func ResourceBytes(resourceIdentifier schema.FrameworkIdentifier, packageName, templatePath string) ([]byte, error) {
+	templateStr := resourceScaffoldGoTemplate
+
+	if templatePath != "" {
+		file, err := os.ReadFile(templatePath)
+		if err != nil {
+			return nil, err
+		}
+
+		templateStr = string(file)
+	}
+
+	t, err := template.New("resource_scaffold").Parse(templateStr)
 	if err != nil {
 		return nil, err
 	}
@@ -24,11 +36,13 @@ func ResourceBytes(resourceIdentifier schema.FrameworkIdentifier, packageName st
 		NameSnake   string
 		NameCamel   string
 		NamePascal  string
+		NameKebab   string
 	}{
 		PackageName: packageName,
 		NameSnake:   string(resourceIdentifier),
 		NameCamel:   resourceIdentifier.ToCamelCase(),
 		NamePascal:  resourceIdentifier.ToPascalCase(),
+		NameKebab:   resourceIdentifier.ToKebabCase(),
 	}
 
 	err = t.Execute(&buf, templateData)

internal/schema/framework_identifier.go

@@ -91,6 +91,13 @@ func (identifier FrameworkIdentifier) ToPrefixPascalCase(prefix string) string {
 	return pascalCase
 }
 
+// ToKebabCase will return kebab case formatted string of the identifier.
+// Example:
+//   - example_resource_thing -> example-resource-thing
+func (identifier FrameworkIdentifier) ToKebabCase() string {
+	return strings.ReplaceAll(identifier.ToString(), "_", "-")
+}
+
 // ToString returns the FrameworkIdentifier as a string without any formatting.
 // Example:
 //   - example_resource_thing -> example_resource_thing