feat: output a list of samples for a language with the samples command

[zimeg]

Changelog

All available samples can be listed with the slack samples --list command. The --language flag might be found useful in filtering these outputs.

Summary

This PR adds a --list flag to the samples command.

Preview

📸

Reviewers

The following filters might be useful in experimentation! 🦠

$ slack samples --list
$ slack samples --list --language deno
$ slack samples --list --language java
$ slack samples --list --language node
$ slack samples --list --language bolt-js
$ slack samples --list --language bolt-ts
$ slack samples --list --language python
$ slack samples --list --language go

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 70.52632% with 28 lines in your changes missing coverage. Please review.
✅ Project coverage is 63.00%. Comparing base (c85c86c) to head (d2e22de).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
cmd/project/samples.go	81.25%	8 Missing and 4 partials ⚠️
cmd/project/create_samples.go	57.69%	11 Missing ⚠️
cmd/project/create_template.go	0.00%	5 Missing ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #192 +/- ##
==========================================
+ Coverage 62.95% 63.00% +0.05% 
==========================================
Files 212 212 Lines 21782 21848 +66 ==========================================
+ Hits 13713 13766 +53 - Misses 7006 7018 +12 - Partials 1063 1064 +1 

☔ 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]

🌚 Quick notes for amazing reviewers follow!

[zimeg]

👁️‍🗨️ note: We avoid attempting prompts in a non-interactive environment and instead list samples!

🗣️ note: The changes of #193 make this behavior more clear IMO since flag substitutes will then have matching prompts or the create command should be used.

[mwbrooks]

📝 Nice feature! I personally enjoy the flat list more than the interactive one.

❓ Curious where this feature idea came from?

🧪 While testing, I noticed that the order isn't sorted on my side. Is that happening on your side too? Also, I left a suggestion to remove the emojis since they don't have a strong meaning.

[mwbrooks]

question: Are you noticing that the repos aren't sorted?

[zimeg]

@mwbrooks This confused me too but these might find order from the stars? ⭐

I wonder if showing the number of stars would be helpful? I might expect this to prefix the sample, but am not sure at all if that'd be right:

⭐ 60 - deno-timesheet-approval
Collect timesheet information from users and store it in a Google Sheet
https://github.com/slack-samples/deno-timesheet-approval

[mwbrooks]

thought: While the emojis are a nice touch, I found them a little confusing. I spent some time trying to understand the meaning behind the emoji. I think it would be better to not include the emojis.

[zimeg]

@mwbrooks Oops! Returning to this now! It's confusing without obvious meaning... I agree! This was changed to use different emojis in da1d105 that separate "template" apps from "example" samples:

I'm curious what no emojis would look like though? I found this "column" ordering to be perhaps confusing in context with long lines. Perhaps we revisit app descriptions later? Or change these outputs elsewise?

[mwbrooks]

Thanks for taking the time to look back into this! Since the samples command has low usage, I think we can start by including the lengthy descriptions and revisit it later.

[zimeg]

❓ Curious where this feature idea came from?

@mwbrooks Thanks for reviewing and sharing suggestions alike! I made some updates in above commits and comments that reorder outputs to make things more clear I hope.

I was hoping for a quick filter of current samples for similar outputs as the pages of docs.slack.dev/samples 🤖

Although I notice now we filter moreso by runtime without a "sample" and "template" option. I think this is alright to continue with but am open to all suggestion! Will rerequest a kind review! 🙏 ✨

[mwbrooks]

I'm curious what no emojis would look like though?

Personally, I'd lean toward no emojis. I think the nuances between examples and templates is difficult to understand. They're all sample apps and the more important filter is the framework language.

My two cents is to remove the emojis all together or use the same emoji for all samples.

✅ Tossing an approval on this one. Overall, it's moving the samples command in a better direction. Thanks @zimeg!

[zimeg]

@mwbrooks Once again, thanks for the kind review 🙏 ✨

My two cents is to remove the emojis all together or use the same emoji for all samples.

As a fast change to use one emoji I put together d2e22de but I'm hoping we can revisit outputs in future iteration 👾

Let's merge this now with follow up later! 🚢