feat(docs): include usages in the markdown (#1254)

Author: manucorporat

src/compiler/docs/generate-readme-docs.ts

@@ -3,6 +3,7 @@ import { AUTO_GENERATE_COMMENT, NOTE } from './constants';
 import { propsToMarkdown } from './markdown-props';
 import { eventsToMarkdown } from './markdown-events';
 import { methodsToMarkdown } from './markdown-methods';
+import { usageToMarkdown } from './markdown-usage';
 import { stylesToMarkdown } from './markdown-css-props';
 
 export async function generateReadmeDocs(config: d.Config, compilerCtx: d.CompilerCtx, readmeOutputs: d.OutputTargetDocsReadme[], docs: d.JsonDocs) {
@@ -39,6 +40,7 @@ export function generateMarkdown(userContent: string, cmp: d.JsonDocsComponent)
     AUTO_GENERATE_COMMENT,
     '',
     '',
+    ...usageToMarkdown(cmp.usage),
     ...propsToMarkdown(cmp.props),
     ...eventsToMarkdown(cmp.events),
     ...methodsToMarkdown(cmp.methods),

src/compiler/docs/markdown-usage.ts

@@ -0,0 +1,45 @@
+import * as d from '../../declarations';
+import { captializeFirstLetter } from '../../util/helpers';
+
+export function usageToMarkdown(usages: d.JsonDocsUsage) {
+  const content: string[] = [];
+  const merged = mergeUsages(usages);
+  if (merged.length === 0) {
+    return content;
+  }
+
+  content.push(`## Usage`);
+
+  merged.forEach(({name, text}) => {
+    content.push('');
+    content.push(`### ${captializeFirstLetter(name)}`);
+    content.push('');
+    content.push(text);
+    content.push('');
+  }),
+
+  content.push('');
+  content.push('');
+
+  return content;
+}
+
+export function mergeUsages(usages: d.JsonDocsUsage) {
+  const keys = Object.keys(usages);
+  const map = new Map<string, string[]>();
+  keys.forEach(key => {
+    const usage = usages[key].trim();
+    const array = map.get(usage) || [];
+    array.push(key);
+    map.set(usage, array);
+  });
+  const merged: {name: string, text: string}[] = [];
+  map.forEach((value, key) => {
+    merged.push({
+      name: value.join(' / '),
+      text: key
+    });
+  });
+  return merged;
+}
+