Add multiline prompt config support (#216)

* add multiline response support * update mdlint with present docker image --------- Co-authored-by: Gabriel Saliev <[email protected]>
vmware-tanzu · Oct 16, 2024 · 2641f40 · 2641f40
1 parent 7278b25
commit 2641f40
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/component/prompt.go b/component/prompt.go
@@ -29,6 +29,9 @@ type PromptConfig struct {
 	// Sensitive information.
 	Sensitive bool
 
+	// Multiline response
+	Multiline bool
+
 	// Help for the prompt.
 	Help string
 }
@@ -90,6 +93,13 @@ func buildPrompt(p *PromptConfig, enableMultiSelect bool) survey.Prompt {
 			Help:    p.Help,
 		}
 	}
+	if p.Multiline {
+		return &survey.Multiline{
+			Message: p.Message,
+			Default: p.Default,
+			Help:    p.Help,
+		}
+	}
 	return &survey.Input{
 		Message: p.Message,
 		Default: p.Default,

diff --git a/component/prompt_test.go b/component/prompt_test.go
@@ -31,6 +31,22 @@ func Test_translatePromptConfig_Sensitive(t *testing.T) {
 	assert.True(ok)
 }
 
+func Test_PromptConfig_WithMultilineResponse(t *testing.T) {
+	assert := assert.New(t)
+
+	promptConfig := PromptConfig{
+		Message:   "Write me a poem",
+		Default:   "Foo bar,\nbar foo",
+		Sensitive: false,
+		Help:      "Help will be given to those who need it",
+		Multiline: true,
+	}
+	prompt := buildPrompt(&promptConfig, true)
+	assert.NotNil(prompt)
+	_, ok := prompt.(*survey.Multiline)
+	assert.True(ok)
+}
+
 func Test_translatePromptConfig_OptionsSelect(t *testing.T) {
 	assert := assert.New(t)
 

diff --git a/hack/check/check-mdlint.sh b/hack/check/check-mdlint.sh
@@ -16,5 +16,5 @@ cd "$(dirname "${BASH_SOURCE[0]}")/../.."
 # Additional configuration can be found in the .markdownlintrc file at
 # the root of the repo.
 docker run --rm -v "$(pwd)":/build \
-  gcr.io/cluster-api-provider-vsphere/extra/mdlint:0.23.2 /md/lint \
+  ghcr.io/vmware-tanzu/tanzu-cli/ci-images/mdlint:0.23.2 /md/lint \
   -i **/CHANGELOG.md .