fix(okidoc-md): use unist-builder@1.0.2.

- fix `unist-builder` usages - update `@depracated` rendering
wix-incubator · Aug 20, 2018 · efd9d46 · efd9d46
1 parent add6a3e
commit efd9d46
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 6 deletions.
diff --git a/packages/okidoc-md/package.json b/packages/okidoc-md/package.json
@@ -39,7 +39,7 @@
     "precinct": "^4.0.0",
     "remark": "^9.0.0",
     "remark-html": "^7.0.0",
-    "unist-builder": "1.0.2",
+    "unist-builder": "^1.0.3",
     "yamljs": "^0.3.0"
   },
   "devDependencies": {

diff --git a/packages/okidoc-md/src/buildMarkdown/__snapshots__/buildMarkdown.spec.js.snap b/packages/okidoc-md/src/buildMarkdown/__snapshots__/buildMarkdown.spec.js.snap
@@ -161,7 +161,7 @@ exports[`buildMarkdown for API class should render markdown for methods with @de
 
 ## doShow()
 
-DEPRECATED!
+**DEPRECATED!**
 
 use method \`show()\`
 

diff --git a/packages/okidoc-md/src/buildMarkdown/buildMarkdownAST/parseMarkdown.js b/packages/okidoc-md/src/buildMarkdown/buildMarkdownAST/parseMarkdown.js
@@ -1,7 +1,17 @@
 import remark from 'remark';
 
 function parseMarkdown(markdown) {
-  return remark().parse(markdown);
+  const markdownAST = remark().parse(markdown);
+
+  // NOTE: unwrap from `root` node
+  if (markdownAST.children.length === 1) {
+    return markdownAST.children[0];
+  }
+
+  return {
+    type: 'paragraph',
+    children: markdownAST.children,
+  };
 }
 
 export default parseMarkdown;
diff --git a/packages/okidoc-md/src/buildMarkdown/buildMarkdownAST/renderComment.js b/packages/okidoc-md/src/buildMarkdown/buildMarkdownAST/renderComment.js
@@ -81,15 +81,15 @@ function renderExamplesAndNotes(comment) {
         return memo.concat(
           exampleCaption
             ? [
-                u('blockquote', parseMarkdown(exampleCaption)),
+                u('blockquote', [parseMarkdown(exampleCaption)]),
                 u('code', { lang: 'javascript' }, exampleCode),
               ]
             : [u('code', { lang: 'javascript' }, exampleCode)],
         );
       }
 
       if (tag.title === 'note') {
-        return memo.concat([u('blockquote', parseMarkdown(tag.description))]);
+        return memo.concat([u('blockquote', [parseMarkdown(tag.description)])]);
       }
 
       return memo;
@@ -100,7 +100,9 @@ function renderExamplesAndNotes(comment) {
 function renderDeprecated(comment) {
   return (
     !!comment.deprecated &&
-    [u('text', u('strong', 'DEPRECATED!'))].concat(comment.deprecated.children)
+    [u('strong', [u('text', 'DEPRECATED!')])].concat(
+      comment.deprecated.children,
+    )
   );
 }