feat: Add examples to sdk source

newrelic · Jun 15, 2020 · 12b7930 · 12b7930
1 parent 51558e5
commit 12b7930
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/plugins/gatsby-source-newrelic-sdk/src/docInfo.js b/plugins/gatsby-source-newrelic-sdk/src/docInfo.js
@@ -1,4 +1,6 @@
-module.exports.getComponentDoc = (name, sdk) => {
+const { getExamples } = require('./exampleInfo');
+
+exports.getComponentDoc = (name, sdk) => {
   const component = sdk[name];
 
   if (!component) {
@@ -9,10 +11,11 @@ module.exports.getComponentDoc = (name, sdk) => {
     name,
     usage: `import { ${name} } from 'nr1'`,
     description: component.__docs__.text,
+    examples: getExamples(component),
   };
 };
 
-module.exports.getApiDoc = (name, sdk) => {
+exports.getApiDoc = (name, sdk) => {
   const api = sdk[name];
 
   if (!api) {
@@ -23,5 +26,6 @@ module.exports.getApiDoc = (name, sdk) => {
     name,
     usage: `import { ${name} } from 'nr1'`,
     description: api.__docs__.text,
+    examples: getExamples(api),
   };
 };
diff --git a/plugins/gatsby-source-newrelic-sdk/src/exampleInfo.js b/plugins/gatsby-source-newrelic-sdk/src/exampleInfo.js
@@ -0,0 +1,11 @@
+const IGNORED_PREVIEWS = ['Dropdown', 'Modal', 'Tooltip'];
+
+exports.getExamples = (component) => {
+  return (component.__docs__.tags.examples || []).map(
+    ({ label, options, sourceCode }) => ({
+      label,
+      sourceCode,
+      preview: IGNORED_PREVIEWS.includes(component.name) ? false : options.live,
+    })
+  );
+};