perf: Generate component description to markdown

fix #26
vuese · Jan 13, 2019 · 752f2b1 · 752f2b1
1 parent 96d6b12
commit 752f2b1
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/packages/cli/lib/genMarkdownTemp.ts b/packages/cli/lib/genMarkdownTemp.ts
@@ -4,6 +4,10 @@ export default function(parserRes: ParserResult) {
   let templateStr = '# [name]\n\n'
   let original = templateStr
 
+  if (parserRes.componentDesc && parserRes.componentDesc.length) {
+    templateStr += `${parserRes.componentDesc.join('')}\n\n`
+  }
+
   templateStr += parserRes.props ? genBaseTemplate('props') : ''
   templateStr += parserRes.events ? genBaseTemplate('events') : ''
   templateStr += parserRes.slots ? genBaseTemplate('slots') : ''

diff --git a/packages/parser/__test__/__fixtures__/all.vue b/packages/parser/__test__/__fixtures__/all.vue
@@ -9,6 +9,7 @@
 </template>
 
 <script>
+// This is a description of the component
 export default {
   props: {
     // The name of the form, up to 8 characters