✨ Add markdown support for Option.description

raycharius · Jun 29, 2020 · c0c60d8 · c0c60d8
1 parent bbc8e7f
commit c0c60d8
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log
 
+## v1.3.1 – 2020-06-30
+
+* Add support for markdown for the `description` property of the `Options` `Bit` object.
+
 ## v1.2.1 – 2020-06-27
 
 * Fix issue where Slack timestamp format not permitted for `ts` and `threadTs` parameters of the `Message` surface object.

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "slack-block-builder",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "Maintainable code for interactive Slack messages, modals and home tabs. A must-have for the Slack Block Kit framework.",
   "author": {
     "name": "Ray East",
@@ -36,7 +36,11 @@
     "message-builder",
     "block-builder",
     "slack-block-builder",
-    "block-kit"
+    "block-kit",
+    "blocks",
+    "botkit",
+    "bolt",
+    "slack-bolt"
   ],
   "scripts": {
     "test": "jest",

diff --git a/src/bits/option.js b/src/bits/option.js
@@ -100,8 +100,12 @@ class Option extends Bit {
 
   build({ isMarkdown } = { isMarkdown: false }) {
     const augmentedProps = {
-      text: isMarkdown ? BuilderHelper.getMarkdownObject(this.props.text) : BuilderHelper.getPlainTextObject(this.props.text),
-      description: BuilderHelper.getPlainTextObject(this.props.description),
+      text: isMarkdown
+        ? BuilderHelper.getMarkdownObject(this.props.text)
+        : BuilderHelper.getPlainTextObject(this.props.text),
+      description: isMarkdown
+        ? BuilderHelper.getMarkdownObject(this.props.description)
+        : BuilderHelper.getPlainTextObject(this.props.description),
     };
 
     return this.getResult(OptionDto, augmentedProps);

diff --git a/tests/props/description.js b/tests/props/description.js
@@ -12,7 +12,7 @@ module.exports = (params) => {
     method: props.description,
     property: props.description,
     param: paramMap.description,
-    mutated: types.PlainTextObject,
+    mutated: params.expectMarkdown ? types.MarkdownObject : types.PlainTextObject,
   };
 
   return [