feat(experiment): inline sample descriptions in plain text

[zimeg]

Changelog

Nothing for this time 🍀 ✨

Summary

This PR inlines sample descriptions in plain text for the samples command and moves docs reference to help text and also removes emojis from descriptions to avoid output issues.

Preview

Before

After

Requirements

• I've read and understood the Contributing Guidelines and have done my best effort to follow them.
• I've read and agree to the Code of Conduct.

[codecov]

Codecov Report

❌ Patch coverage is 68.42105% with 6 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (main@2ddf970). Learn more about missing BASE report.
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
cmd/project/create_samples.go	40.00%	5 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #400   +/-   ##
=======================================
  Coverage        ?   67.98%           
=======================================
  Files           ?      218           
  Lines           ?    18068           
  Branches        ?        0           
=======================================
  Hits            ?    12284           
  Misses          ?     4631           
  Partials        ?     1153           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[zimeg]

Notes and questions for the kind reader 🧠 💡

[zimeg]

🔭 note: These descriptions aren't used for create selections so it's removed with these changes!

🪬 question: I notice samples does use descriptions and this causes outputs between "values" and "descriptions" different and am curious if we'd prefer to match that here?

slack-cli/cmd/project/create_template.go

Lines 34 to 99 in 2ad9485

	func getSelectionOptions(clients *shared.ClientFactory, categoryID string) []promptObject {
	if strings.TrimSpace(categoryID) == "" {
	categoryID = "slack-cli#getting-started"
	}
	// App categories and templates
	templatePromptObjects := map[string]([]promptObject){
	"slack-cli#getting-started": []promptObject{
	{
	Title: fmt.Sprintf("Bolt for JavaScript %s", style.Secondary("Node.js")),
	Repository: "slack-samples/bolt-js-starter-template",
	},
	{
	Title: fmt.Sprintf("Bolt for Python %s", style.Secondary("Python")),
	Repository: "slack-samples/bolt-python-starter-template",
	},
	},
	"slack-cli#automation-apps": {
	{
	Title: fmt.Sprintf("Bolt for JavaScript %s", style.Secondary("Node.js")),
	Repository: "slack-samples/bolt-js-custom-function-template",
	},
	{
	Title: fmt.Sprintf("Bolt for Python %s", style.Secondary("Python")),
	Repository: "slack-samples/bolt-python-custom-function-template",
	},
	{
	Title: fmt.Sprintf("Deno Slack SDK %s", style.Secondary("Deno")),
	Repository: "slack-samples/deno-starter-template",
	},
	},
	"slack-cli#ai-apps": {
	{
	Title: fmt.Sprintf("Bolt for JavaScript %s", style.Secondary("Node.js")),
	Repository: "slack-samples/bolt-js-assistant-template",
	},
	{
	Title: fmt.Sprintf("Bolt for Python %s", style.Secondary("Python")),
	Repository: "slack-samples/bolt-python-assistant-template",
	},
	},
	}
	return templatePromptObjects[categoryID]
	}
	func getSelectionOptionsForCategory(clients *shared.ClientFactory) []promptObject {
	return []promptObject{
	{
	Title: fmt.Sprintf("Starter app %s", style.Secondary("Getting started Slack app")),
	Repository: "slack-cli#getting-started",
	},
	{
	Title: fmt.Sprintf("AI Agent app %s", style.Secondary("Slack agents and assistants")),
	Repository: "slack-cli#ai-apps",
	},
	{
	Title: fmt.Sprintf("Automation app %s", style.Secondary("Custom steps and workflows")),
	Repository: "slack-cli#automation-apps",
	},
	{
	Title: "View more samples",
	Repository: viewMoreSamples,
	},
	}
	}

[zimeg]

🐭 note: It'd be curious in a different separator but am unsure what reads best for most descriptions...

[srtaalej]

selection and code looks a lot cleaner 🙌 thanks for making these updates ❤️
i will say though the inline description with "-" feels a bit dense visually — especially when scanning a longer list.
i think itd be worth it to explore (in a followup pr) a subtler separator or dimming the description text to create more visual hierarchy between the option name and its description 🤔

[zimeg]

@srtaalej Super appreciate the kind review! I do agree it's dense but we might merge this with line wraps supported well too.

Do of course share follow up to formatting more in upcoming change! 🍀 ✨

[mwbrooks]

Nice improvement

suggestion: The survey prompts use a nice style where the description is grey. Visually, it's easy to separate the Option ("Starter App") from Description ("Some description about the app"). This update loses the grey text, which makes it a lot harder to distinguish what the option is.