Skip to content

Conversation

zimeg
Copy link
Member

@zimeg zimeg commented Jul 11, 2025

Summary

This PR adds the markdown block to @slack/types.

Requirements

@zimeg zimeg added this to the [email protected] milestone Jul 11, 2025
@zimeg zimeg self-assigned this Jul 11, 2025
@zimeg zimeg added semver:minor enhancement M-T: A feature request for new functionality area:typescript issues that specifically impact using the package from typescript projects pkg:types applies to `@slack/types` labels Jul 11, 2025
Copy link

codecov bot commented Jul 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.71%. Comparing base (5bcef49) to head (5df47d2).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2296   +/-   ##
=======================================
  Coverage   92.71%   92.71%           
=======================================
  Files          38       38           
  Lines       10607    10607           
  Branches      683      683           
=======================================
  Hits         9834     9834           
  Misses        761      761           
  Partials       12       12           
Flag Coverage Δ
cli-hooks 95.23% <ø> (ø)
cli-test 94.74% <ø> (ø)
oauth 77.39% <ø> (ø)
socket-mode 61.87% <ø> (ø)
web-api 97.97% <ø> (ø)
webhook 96.66% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@zimeg
Copy link
Member Author

zimeg commented Jul 11, 2025

📝 Testing notes for the kind reviewers can use changes to the sample of slack-samples/bolt-js-assistant-template#47 and this PR:

$ npm pack  # Package these changes before testing the sample app
$ cd
$ slack create asdf -t slack-samples/bolt-js-assistant-template -b zimeg-feat-markdown-block
$ cd asdf
$ npm run check                                         # Attempt the type check test
$ npm install ../path/to/node-slack-sdk/packages/types  # Install these changes
$ npm run check                                         # Confirm the sample passes the type check

Copy link
Contributor

@WilliamBergamin WilliamBergamin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice 💯

| ActionsBlock
| ContextBlock
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alphabetical 🙏

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was not sure where else to add a new block! 😉

@zimeg
Copy link
Member Author

zimeg commented Jul 12, 2025

@WilliamBergamin Thanks for the fast review! I'll merge this now but will plan for a soonish release 🚢 💨

@zimeg zimeg merged commit e694d58 into main Jul 12, 2025
57 checks passed
@zimeg zimeg deleted the zimeg-feat-types-markdown-block branch July 12, 2025 01:13
@pedropaccola
Copy link

Please do release it!

@zimeg
Copy link
Member Author

zimeg commented Aug 6, 2025

@pedropaccola Thanks for the bump - we'll aim to release this after #2330 lands. In this meantime I might recommend using regular JSON for the block:

{
  "type": "markdown",
  "text": "**Lots of information here!!**",
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:typescript issues that specifically impact using the package from typescript projects enhancement M-T: A feature request for new functionality pkg:types applies to `@slack/types` semver:minor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants