@patternfly/documentation-framework 1.2.14 → 1.2.15

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 1.2.15 (2022-09-07)
+
+
+### Bug Fixes
+
+* **docs:** codesandbox relative imports point to package import ([#3122](https://github.com/patternfly/patternfly-org/issues/3122)) ([fbecd9d](https://github.com/patternfly/patternfly-org/commit/fbecd9d1b120d657910f3bb00486a49bf90360b6))
+
+
+
+
+
 ## 1.2.14 (2022-09-06)
 
 **Note:** Version bump only for package @patternfly/documentation-framework

package/components/example/example.js

@@ -79,7 +79,9 @@ export const Example = ({
   // Content that appears between h3 and code block to explain example
   children,
   // Show dark theme switcher on full page examples
-  hasDarkThemeSwitcher = process.env.hasDarkThemeSwitcher
+  hasDarkThemeSwitcher = process.env.hasDarkThemeSwitcher,
+  // Map of relative imports matched to their npm package import path (passed to Codesandbox)
+  relativeImports
 }) => {
   if (isFullscreenPreview) {
     isFullscreen = false;
@@ -98,9 +100,9 @@ export const Example = ({
 
   const [editorCode, setEditorCode] = React.useState(code);
   const loc = useLocation();
-
   const scope = {
     ...liveContext,
+    // These 2 are in the bundle anyways for the site since we dogfood
     ...reactCoreModule,
     ...reactTableModule,
     ...(source === 'react-next' ? reactCoreNextModule : {})
@@ -158,7 +160,7 @@ export const Example = ({
   const codeBoxParams = getParameters(
     lang === 'html'
       ? getStaticParams(title, editorCode)
-      : getReactParams(title, editorCode, scope, lang)
+      : getReactParams(title, editorCode, scope, lang, relativeImports)
   );
   const fullscreenLink = loc.pathname.replace(/\/$/, '')
     + (loc.pathname.endsWith(source) ? '' : `/${source}`)

package/helpers/codesandbox.js

@@ -2,6 +2,7 @@ const { parse } = require('@patternfly/ast-helpers');
 const versions  = require('../versions.json');
 const overpass = require('./fonts');
 const { capitalize } = require('./capitalize');
+const pathPrefix = process.env.pathPrefix;
 
 const getStaticParams = (title, html) => {
   const imgAssetRegex = /['"](\/assets\/images\/.*)['"]/g;
@@ -106,7 +107,7 @@ function prettyExampleCode(title, code, declaration, identifier) {
 }
 
 // TODO: Make React examples work and use a template that has our assets.
-function getReactParams(title, code, scope, lang) {
+function getReactParams(title, code, scope, lang, relativeImports) {
   let toRender = null;
   try {
     let declaration = getExampleDeclaration(code);
@@ -129,7 +130,7 @@ function getReactParams(title, code, scope, lang) {
   catch (err) {
     // Ignore
   }
-
+  // Update image imports to point to pf.org
   const imgImportRegex = /import\s*(\w*).*['"](.*)(\.(png|jpe?g|webp|gif|svg))['"]/g;
   let imgImportMatch;
   while ((imgImportMatch = imgImportRegex.exec(code))) {
@@ -137,6 +138,16 @@ function getReactParams(title, code, scope, lang) {
     code = code.replace(imgImportMatch[0], `const ${imgName} = "https://www.patternfly.org/v4${scope[imgName]}"`);
   }
 
+  const relImportRegex = /(?<=import[\s*{])([\w*{}\n\r\t, ]+)(?=[\s*]from\s["']([\.\/]+.*)["'])/gm;
+  let relImportMatch;
+  while (relImportMatch = relImportRegex.exec(code)) {
+    const [ relImportName, _name, relImportPath ] = relImportMatch;
+    if (relativeImports[relImportName]) {
+      code = code.replace(relImportPath, relativeImports[relImportName]);
+    }
+  }
+
+  
   const dependencies = {
     '@patternfly/react-core': versions.Releases[0].versions['@patternfly/react-core']
   };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@patternfly/documentation-framework",
   "description": "A framework to build documentation for PatternFly.",
-  "version": "1.2.14",
+  "version": "1.2.15",
   "author": "Red Hat",
   "license": "MIT",
   "private": false,
@@ -84,5 +84,5 @@
     "react": "^16.8.0 || ^17.0.0",
     "react-dom": "^16.8.0 || ^17.0.0"
   },
-  "gitHead": "9c5b4bf2295a80829fcc1c706263b4ee2ea7d443"
+  "gitHead": "ca1b4cfd13c0d6cae2f9d7638188a75f323cd5be"
 }

package/scripts/md/mdx-hast-to-jsx.js

@@ -69,12 +69,36 @@ function serializeRoot(node, options) {
 
   const importStatements = groups.import
     .map(node => node.value)
-    .map(imp => imp.replace(/(['"])\./g, (_, match) => `${match}${getRelPath()}${path.posix.sep}\.`))
+    .map(imp => imp.replace(/(['"])\./g, (_, match) => `${match}${getRelPath()}${path.posix.sep}\.`));
+
+  // Map relative import name to '@package...'
+  const relativeImportsRegex = /(?:[\.\/]+.*)(@.*)['"]/gm;
+  let relativeImportMatch;
+  let relativeImportMatches = {};
+  while (relativeImportMatch = relativeImportsRegex.exec(importStatements[0])) {
+    const [_match, absoluteImportPath] = relativeImportMatch;
+    if (absoluteImportPath && !absoluteImportPath.includes('srcImport')) {
+      // `@patternfly/react-core/src/demos/./examples/DashboardWrapper` to `DashboardWrapper`
+      let relativeFileImport = /(?<=\/)(\.+\/.*)/gm.exec(absoluteImportPath);
+      if (relativeFileImport) {
+        // Build map of relative imports (from example.js code) to npm package import path (used in codesandbox.js)
+        const relativeFilePath = relativeFileImport[0];
+        const relativeImportName = relativeFilePath
+          .split('/')
+          .pop()
+          .split('.')
+          .shift();
+        relativeImportMatches[relativeImportName] = absoluteImportPath;
+      }
+    }
+  }
+
+  const importStatementsWithThumbnails = importStatements
     .concat(thumbnailImports)
-    .join('\n')
+    .join('\n');
 
   // https://astexplorer.net/#/gist/9c531dd372dfc57e194c13c2889d31c3/03f2d6e889db1a733c6a079554e8af7784863739
-  options.importSpecifiers = parse(importStatements).body
+  options.importSpecifiers = parse(importStatementsWithThumbnails).body
     .map(node => node.specifiers)
     .flat(1)
     .map(spec => spec.local ? spec.local.name : null)
@@ -82,14 +106,13 @@ function serializeRoot(node, options) {
   const liveContext = options.importSpecifiers
     .filter(localName => !/srcImport.*/.test(localName)) // Images in MD like [!img](./src)
     .join(',\n  ');
-
   const childNodes = groups.rest
     .map(childNode => toJSX(childNode, node, options))
     .join('');
 
   let res = `import React from 'react';
 import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
-${importStatements}
+${importStatementsWithThumbnails}
 const pageData = ${JSON.stringify(pageData, null, 2)};
 `;
   if (liveContext) {
@@ -97,6 +120,13 @@ const pageData = ${JSON.stringify(pageData, null, 2)};
       '  ' + liveContext
     }\n};\n`
   }
+  if (relativeImportMatches) {
+    res += `pageData.relativeImports = {\n${
+      '  ' + Object.entries(relativeImportMatches)
+        .map(([key, val]) => `'${key}': '${val}'`)
+        .join(',\n  ')
+    }\n};\n`;
+  }
   if (examples) {
     res += `pageData.examples = {\n${
       '  ' + Object.entries(examples)