STAC-22599: Add --display-name to sts stackpack scaffold command

Author: viliakov

.gitignore

@@ -21,3 +21,5 @@ result
 .gocache/
 release-notes.md
 release-notes.json
+
+CLAUDE.*.md

cmd/stackpack/stackpack_scaffold.go

@@ -13,10 +13,10 @@ import (
 )
 
 const (
-	defaultTemplateGitHubRepo = "stackvista/stac-22599" // Default path in GitHub repo for templates
-	defaultTemplateGitHubRef  = "main"                  // Default branch for GitHub templates
-	defaultTemplateGitHubPath = "templates"             // Default path in GitHub repo for templates
-	defaultTemplateName       = "generic"               // Default template name to use
+	defaultTemplateGitHubRepo = "StackVista/stackpack-templates" // Default path in GitHub repo for templates
+	defaultTemplateGitHubRef  = "main"                           // Default branch for GitHub templates
+	defaultTemplateGitHubPath = "templates"                      // Default path in GitHub repo for templates
+	defaultTemplateName       = "generic"                        // Default template name to use
 )
 
 type ScaffoldArgs struct {
@@ -31,6 +31,7 @@ type ScaffoldArgs struct {
 	// Common flags
 	DestinationDir string
 	Name           string
+	DisplayName    string
 	TemplateName   string
 	Force          bool
 }
@@ -68,6 +69,7 @@ sts stackpack scaffold --template-github-repo stackvista/my-templates --name my-
 	// Common flags
 	cmd.Flags().StringVar(&args.DestinationDir, "destination-dir", "", "Target directory where scaffolded files will be created. If not specified, uses current working directory")
 	cmd.Flags().StringVar(&args.Name, "name", "", "Name of the stackpack (required)")
+	cmd.Flags().StringVar(&args.DisplayName, "display-name", "", "Name that's displayed on both the StackPack listing page and on the title of the StackPack page. If not provided, the value of --name will be used")
 	cmd.Flags().StringVar(&args.TemplateName, "template-name", defaultTemplateName, fmt.Sprintf("Name of the template subdirectory to use (default: %s)", defaultTemplateName))
 	cmd.Flags().BoolVar(&args.Force, "force", false, "Overwrite existing files without prompting")
 
@@ -110,8 +112,13 @@ func RunStackpackScaffoldCommand(args *ScaffoldArgs) func(cli *di.Deps, cmd *cob
 		}
 
 		// Create template context
+		displayName := args.DisplayName
+		if displayName == "" {
+			displayName = args.Name
+		}
 		context := scaffold.TemplateContext{
 			Name:         args.Name,
+			DisplayName:  displayName,
 			TemplateName: args.TemplateName,
 		}
 

cmd/stackpack/stackpack_scaffold_test.go

@@ -419,9 +419,10 @@ func TestStackpackScaffoldCommand_TemplateContextPassedCorrectly(t *testing.T) {
 	err = os.MkdirAll(customTemplateDir, 0755)
 	require.NoError(t, err)
 
-	// Create a test template file with both Name and TemplateName variables
+	// Create a test template file with Name, DisplayName, and TemplateName variables
 	templateFile := filepath.Join(customTemplateDir, "config.yaml")
 	templateContent := `name: <<.Name>>
+display_name: <<.DisplayName>>
 template: <<.TemplateName>>
 `
 	err = os.WriteFile(templateFile, []byte(templateContent), 0644)
@@ -450,6 +451,7 @@ template: <<.TemplateName>>
 	require.NoError(t, err)
 
 	expectedContent := `name: my-awesome-stackpack
+display_name: my-awesome-stackpack
 template: custom-template
 `
 	assert.Equal(t, expectedContent, string(content))
@@ -546,6 +548,85 @@ func TestDisplayNextSteps(t *testing.T) {
 	assert.Contains(t, allOutput, "Build your stackpack")
 }
 
+func TestStackpackScaffoldCommand_DisplayNameFallback(t *testing.T) {
+	// Create temporary directories for testing
+	tempDir, err := os.MkdirTemp("", "stackpack-scaffold-displayname-test-*")
+	require.NoError(t, err)
+	defer os.RemoveAll(tempDir)
+
+	// Create a mock template structure
+	templateDir := filepath.Join(tempDir, "templates")
+	customTemplateDir := filepath.Join(templateDir, "custom-template")
+	err = os.MkdirAll(customTemplateDir, 0755)
+	require.NoError(t, err)
+
+	// Create a test template file with DisplayName variable
+	templateFile := filepath.Join(customTemplateDir, "test-displayname.yaml")
+	templateContent := `name: <<.Name>>
+display_name: <<.DisplayName>>
+`
+	err = os.WriteFile(templateFile, []byte(templateContent), 0644)
+	require.NoError(t, err)
+
+	// Create destination directory
+	destDir := filepath.Join(tempDir, "destination")
+	err = os.MkdirAll(destDir, 0755)
+	require.NoError(t, err)
+
+	tests := []struct {
+		name                string
+		args                []string
+		expectedDisplayName string
+		description         string
+	}{
+		{
+			name: "with display-name flag provided",
+			args: []string{
+				"--name", "my-stackpack",
+				"--display-name", "My Awesome StackPack",
+				"--template-local-dir", templateDir,
+				"--template-name", "custom-template",
+				"--destination-dir", destDir,
+			},
+			expectedDisplayName: "My Awesome StackPack",
+			description:         "Should use provided display name",
+		},
+		{
+			name: "without display-name flag - should fallback to name",
+			args: []string{
+				"--name", "my-stackpack-fallback",
+				"--template-local-dir", templateDir,
+				"--template-name", "custom-template",
+				"--destination-dir", destDir,
+			},
+			expectedDisplayName: "my-stackpack-fallback",
+			description:         "Should fallback to name when display-name not provided",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			cli, cmd := setupStackpackScaffoldCmd(t)
+
+			_, err := di.ExecuteCommandWithContext(&cli.Deps, cmd, tt.args...)
+			defer removeStackPack()
+			require.NoError(t, err, tt.description)
+
+			// Verify the template variables were substituted correctly
+			createdFile := filepath.Join(destDir, "test-displayname.yaml")
+			content, err := os.ReadFile(createdFile)
+			require.NoError(t, err)
+
+			// Check that DisplayName was correctly used
+			assert.Contains(t, string(content), "display_name: "+tt.expectedDisplayName, tt.description)
+
+			// Clean up for next test iteration
+			_ = os.RemoveAll(destDir)
+			_ = os.MkdirAll(destDir, 0755)
+		})
+	}
+}
+
 func removeStackPack() {
 	_ = os.RemoveAll("src")
 	_ = os.Remove("version.sbt")

pkg/scaffold/scaffolder.go

@@ -18,6 +18,7 @@ const (
 // TemplateContext holds the variables for template rendering
 type TemplateContext struct {
 	Name         string // Stackpack name (e.g. "my-stackpack")
+	DisplayName  string // Display name for the stackpack
 	TemplateName string // Template name used for scaffolding
 }
 

pkg/scaffold/scaffolder_test.go

@@ -55,7 +55,7 @@ func (m *MockPrinter) PrintWarn(message string) {
 
 func TestNewScaffolder(t *testing.T) {
 	mockSource := &MockTemplateSource{stringResult: "mock-source"}
-	context := TemplateContext{Name: "test-name", TemplateName: "test-template"}
+	context := TemplateContext{Name: "test-name", DisplayName: "test-name", TemplateName: "test-template"}
 	mockPrinter := &MockPrinter{}
 
 	scaffolder := NewScaffolder(mockSource, "/test/dest", context, true, mockPrinter, false)
@@ -87,7 +87,7 @@ func TestScaffolder_validateArgs(t *testing.T) {
 	}{
 		{
 			name:      "valid args",
-			context:   TemplateContext{Name: "test-name", TemplateName: "test-template"},
+			context:   TemplateContext{Name: "test-name", DisplayName: "test-name", TemplateName: "test-template"},
 			sourceErr: nil,
 			wantErr:   false,
 		},