Merge pull request newrelic#8 from newrelic/jerel/migrate-existing

Migrate hidden docs

Author: jerelmiller

.gitignore

@@ -1,3 +1,6 @@
 node_modules/
 .cache/
 public
+
+# dotenv environment variable files
+.env*

codemods/browserLandingPageBlockquote.js

@@ -0,0 +1,36 @@
+const visit = require('unist-util-visit');
+const { hasClassName, isMdxElement } = require('./utils/mdxast');
+const u = require('unist-builder');
+
+const isIcon = (name, node) =>
+  isMdxElement('i', node) && hasClassName(`fa-${name}`, node);
+
+const browserLandingPageBlockquote = () => (tree) => {
+  visit(
+    tree,
+    (node) => isIcon('quote-left', node),
+    (node, idx, parent) => {
+      const phrasing = parent.children[idx + 1];
+
+      // We are assuming the only instance of the quote-left/quote-right icons
+      // occur on the browser landing page, where there is a single paragraph
+      // of text between the opening quote and the closing quote.
+      parent.children[idx + 1] = u('blockquote', [phrasing]);
+      parent.children.splice(idx, 1);
+
+      return visit.EXIT;
+    }
+  );
+
+  visit(
+    tree,
+    (node) => isIcon('quote-right', node),
+    (_node, idx, parent) => {
+      parent.children.splice(idx, 1);
+
+      return visit.EXIT;
+    }
+  );
+};
+
+module.exports = browserLandingPageBlockquote;

codemods/buttons.js

@@ -0,0 +1,47 @@
+const visit = require('unist-util-visit');
+const {
+  removeAttribute,
+  addAttribute,
+  hasClassName,
+  findAttribute,
+} = require('./utils/mdxast');
+
+const VARIANT = /\bbtn-((?!lg)[a-z]+\b)/;
+const VARIANTS = { primary: 'primary', secondary: 'link' };
+
+const buttons = () => (tree, file) => {
+  visit(
+    tree,
+    (node) => {
+      return hasClassName('btn', node);
+    },
+    (a) => {
+      const className = findAttribute('className', a);
+      const href = findAttribute('href', a);
+
+      const [, variant] = className.match(VARIANT) || [];
+      const themeVariant = VARIANTS[variant];
+      a.name = 'Button';
+
+      if (href) {
+        a.name = 'ButtonLink';
+        addAttribute('to', href, a);
+      }
+
+      removeAttribute('className', a);
+      removeAttribute('href', a);
+
+      if (themeVariant) {
+        addAttribute('variant', themeVariant, a);
+      } else {
+        file.message(
+          `Unknown variant '${variant}'`,
+          a.position.start,
+          'buttons'
+        );
+      }
+    }
+  );
+};
+
+module.exports = buttons;

codemods/callouts.js

@@ -0,0 +1,43 @@
+const visit = require('unist-util-visit');
+const {
+  addAttribute,
+  isMdxBlockElement,
+  removeAttribute,
+} = require('./utils/mdxast');
+
+const SPECIAL_VARIANTS = {
+  permissions: 'tip',
+  note: 'tip',
+  pricing: 'tip',
+};
+
+const callouts = () => (tree) => {
+  visit(
+    tree,
+    (node) => {
+      return (
+        isMdxBlockElement('div', node) &&
+        node.attributes.some(
+          (attr) => attr.name === 'className' && attr.value.includes('callout-')
+        )
+      );
+    },
+    (div) => {
+      const { value: className } = div.attributes.find(
+        (attr) => attr.name === 'className'
+      );
+      const callout = className
+        .split(/\s+/)
+        .find((className) => className.startsWith('callout-'));
+
+      const variant = callout.replace('callout-', '');
+
+      div.name = 'Callout';
+
+      addAttribute('variant', SPECIAL_VARIANTS[variant] || variant, div);
+      removeAttribute('className', div);
+    }
+  );
+};
+
+module.exports = callouts;

codemods/clamshells.js

@@ -0,0 +1,50 @@
+const visit = require('unist-util-visit');
+const toString = require('mdast-util-to-string');
+const {
+  removeAttribute,
+  isMdxBlockElement,
+  isPlainText,
+  hasClassName,
+  removeChild,
+  setAttribute,
+} = require('./utils/mdxast');
+const toJSXExpression = require('./utils/to-jsx-expression');
+
+const clamshells = () => (tree, file) => {
+  visit(
+    tree,
+    (node) =>
+      isMdxBlockElement('dl', node) && hasClassName('clamshell-list', node),
+    (dl) => {
+      dl.name = 'CollapserGroup';
+      removeAttribute('className', dl);
+
+      visit(
+        dl,
+        (node, _idx, parent) => isMdxBlockElement('dt', node) && parent === dl,
+        (dt, idx) => {
+          const dd = dl.children[idx + 1];
+
+          setAttribute(
+            'title',
+            isPlainText(dt) ? toString(dt) : toJSXExpression(dt, file),
+            dt
+          );
+
+          dt.name = 'Collapser';
+          dt.children = dd.children;
+        }
+      );
+
+      visit(
+        dl,
+        (node, _idx, parent) => isMdxBlockElement('dd', node) && parent === dl,
+        (dd) => {
+          removeChild(dd, dl);
+        }
+      );
+    }
+  );
+};
+
+module.exports = clamshells;

codemods/codeBlocks.js

@@ -0,0 +1,21 @@
+const visit = require('unist-util-visit');
+const { isMdxElement, findAttribute } = require('./utils/mdxast');
+const toString = require('mdast-util-to-string');
+
+const codeBlocks = () => (tree) => {
+  visit(
+    tree,
+    (node) => isMdxElement('pre', node),
+    (pre) => {
+      const code = Buffer.from(toString(pre), 'base64').toString('utf-8');
+      const language = findAttribute('language', pre);
+
+      pre.type = 'code';
+      pre.lang = language;
+      pre.value = code;
+      delete pre.children;
+    }
+  );
+};
+
+module.exports = codeBlocks;

codemods/collapseLandingPageTileGrids.js

@@ -0,0 +1,27 @@
+const visit = require('unist-util-visit');
+const { isMdxBlockElement, removeChild } = require('./utils/mdxast');
+
+const collapseLandingPageTileGrids = () => (tree, file) => {
+  if (file.data.doc.type !== 'landing_page') {
+    return;
+  }
+
+  visit(
+    tree,
+    (_node, _idx, parent) => parent === tree,
+    (node, idx, parent) => {
+      const previous = idx && parent.children[idx - 1];
+
+      if (previous && isTileGrid(node) && isTileGrid(previous)) {
+        previous.children = previous.children.concat(node.children);
+        removeChild(node, parent);
+
+        return idx;
+      }
+    }
+  );
+};
+
+const isTileGrid = (node) => isMdxBlockElement('LandingPageTileGrid', node);
+
+module.exports = collapseLandingPageTileGrids;

codemods/exampleBoxes.js

@@ -0,0 +1,77 @@
+const visit = require('unist-util-visit');
+const { select } = require('unist-util-select');
+const {
+  isMdxBlockElement,
+  isPlainText,
+  hasClassName,
+  removeAttribute,
+  removeChild,
+  setAttribute,
+} = require('./utils/mdxast');
+const toString = require('mdast-util-to-string');
+const toJSXExpression = require('./utils/to-jsx-expression');
+
+const isExampleBox = (node) =>
+  isMdxBlockElement('dl', node) && hasClassName('example-box', node);
+
+const exampleBoxes = () => (tree, file) => {
+  visit(
+    tree,
+    (node) => isExampleBox(node) && node.children.length === 1,
+    (dl) => {
+      const child = dl.children[0];
+      const [title, children] = child.children;
+
+      if (child.children.length > 2) {
+        file.message(
+          'Simple collapser example has more than 2 child nodes. Please revisit this implementation to handle the additional nodes',
+          child.position.start,
+          'example-boxes'
+        );
+      }
+
+      setAttribute(
+        'title',
+        isPlainText(title) ? toString(title) : toJSXExpression(title, file),
+        child
+      );
+
+      dl.name = 'CollapserGroup';
+      child.name = 'Collapser';
+      child.children = [children];
+      removeAttribute('className', dl);
+    }
+  );
+
+  visit(tree, isExampleBox, (dl) => {
+    dl.name = 'CollapserGroup';
+    removeAttribute('className', dl);
+
+    visit(
+      dl,
+      (node, _idx, parent) => parent === dl && isMdxBlockElement('dt', node),
+      (dt, idx) => {
+        const dd = dl.children[idx + 1];
+
+        setAttribute(
+          'title',
+          isPlainText(dt) ? toString(dt) : toJSXExpression(dt, file),
+          dt
+        );
+
+        dt.name = 'Collapser';
+        dt.children = dd.children;
+      }
+    );
+
+    visit(
+      dl,
+      (node, _idx, parent) => parent === dl && isMdxBlockElement('dd', node),
+      (dd) => {
+        removeChild(dd, dl);
+      }
+    );
+  });
+};
+
+module.exports = exampleBoxes;