@patternfly/documentation-framework 2.0.0-alpha.7 → 2.0.0-alpha.70

package/scripts/md/parseMD.js

@@ -12,10 +12,12 @@ const { typecheck } = require('./typecheck');
 const { makeSlug } = require('../../helpers/slugger');
 const { liveCodeTypes } = require('../../helpers/liveCodeTypes');
 const { tsDocgen } = require('../tsDocgen');
+const { getPackageFunctionDocumentation } = require("../typeDocGen");
 
 let exitCode = 0;
 const outputBase = path.join(process.cwd(), `patternfly-docs/generated`);
 const tsDocs = {};
+let functionDocs = {};
 const routes = {};
 const globs = {
   props: [],
@@ -75,6 +77,24 @@ function toReactComponent(mdFilePath, source, buildMode) {
         return acc;
       }, []);
 
+      const functionDocumentation = Object.keys(
+        frontmatter.functions || {}
+      ).reduce((acc, fileName) => {
+        const functionNames = frontmatter.functions[fileName];
+
+        functionNames.forEach((functionName) => {
+          if (functionDocs[fileName] && functionDocs[fileName][functionName]) {
+            const functionDescriptionWithName = { functionName, ...functionDocs[fileName][functionName]}
+            acc.push(functionDescriptionWithName);
+          } else {
+            file.message(
+              `function documentation for ${functionName} is missing from function docs generation`
+            );
+          }
+        });
+        return acc;
+      }, []);
+
       const normalizedPath = relPath
         .replace('node_modules/@patternfly/patternfly/docs', 'src/patternfly')
         .replace(/node_modules\/@patternfly\/react-([\w-])/, (_, match) => `packages/react-${match}`)
@@ -84,7 +104,12 @@ function toReactComponent(mdFilePath, source, buildMode) {
         id: frontmatter.id,
         section: frontmatter.section || '',
         subsection: frontmatter.subsection || '',
+        deprecated: frontmatter.deprecated || false,
+        beta: frontmatter.beta || false,
+        demo: frontmatter.demo || false,
+        newImplementationLink: frontmatter.newImplementationLink || false,
         source,
+        tabName: frontmatter.tabName || null,
         slug,
         sourceLink: frontmatter.sourceLink || `https://github.com/patternfly/${
           sourceRepo}/blob/main/${
@@ -106,26 +131,26 @@ function toReactComponent(mdFilePath, source, buildMode) {
       if (propComponents.length > 0) {
         pageData.propComponents = propComponents;
       }
+      if (functionDocumentation.length > 0) {
+        pageData.functionDocumentation = functionDocumentation;
+      }
       if (frontmatter.optIn) {
         pageData.optIn = frontmatter.optIn;
       }
-      if (frontmatter.beta) {
-        pageData.beta = frontmatter.beta;
-      }
       if (frontmatter.cssPrefix) {
         pageData.cssPrefix = Array.isArray(frontmatter.cssPrefix)
           ? frontmatter.cssPrefix
           : [frontmatter.cssPrefix];
       }
-      if (frontmatter.katacodaBroken) {
-        pageData.katacodaBroken = frontmatter.katacodaBroken;
-      }
-      if (frontmatter.katacodaLayout) {
-        pageData.katacodaLayout = frontmatter.katacodaLayout;
-      }
       if (frontmatter.hideNavItem) {
         pageData.hideNavItem = frontmatter.hideNavItem;
       }
+      if (frontmatter.sortValue) {
+        pageData.sortValue = frontmatter.sortValue;
+      }
+      if (frontmatter.subsectionSortValue) {
+        pageData.subsectionSortValue = frontmatter.subsectionSortValue;
+      }
     })
     // Delete HTML comments
     .use(require('./remove-comments'))
@@ -266,12 +291,21 @@ function sourceMDFile(file, source, buildMode) {
       section: pageData.section,
       subsection: pageData.subsection,
       source: pageData.source,
-      ...(pageData.katacodaLayout && { katacodaLayout: pageData.katacodaLayout }),
-      ...(pageData.hideNavItem && { hideNavItem: pageData.hideNavItem })
+      tabName: pageData.tabName,
+      ...(pageData.hideNavItem && { hideNavItem: pageData.hideNavItem }),
+      ...(pageData.beta && { beta: pageData.beta }),
+      ...(pageData.deprecated && { deprecated: pageData.deprecated }),
+      ...(pageData.demo && { demo: pageData.demo }),
+      ...(pageData.sortValue && { sortValue: pageData.sortValue }),
+      ...(pageData.subsectionSortValue && { subsectionSortValue: pageData.subsectionSortValue })
     };
   }
 }
 
+function sourceFunctionDocs(packageName) {
+  functionDocs = getPackageFunctionDocumentation(packageName);
+}
+
 function writeIndex() {
   const stringifyRoute = ([route, pageData]) => `'${route}': {\n    ${Object.entries(pageData)
     .map(([key, val]) => `${key}: ${JSON.stringify(val)}`)
@@ -310,6 +344,7 @@ module.exports = {
     globs.md.push({ glob, source, ignore });
     sync(glob, { ignore }).forEach(file => sourceMDFile(file, source, buildMode));
   },
+  sourceFunctionDocs,
   writeIndex,
   watchMD() {
     globs.props.forEach(({ glob, ignore }) => {

package/scripts/md/styled-tags.js

@@ -24,22 +24,23 @@ function styledTags() {
         node.properties.className = node.properties.className || '';
         node.properties.className += node.properties.className ? ' ' : '';
         node.properties.className += `ws-${node.tagName}`;
-        // Match pf-c-table implementation
+        // Match pf-v5-c-table implementation
         // https://pf4.patternfly.org/components/table/html/basic-table/
         if (node.tagName === 'table') {
-          node.properties.className += ' pf-c-table pf-m-grid-lg pf-m-compact';
+          node.properties.className += ' pf-v5-c-table pf-m-grid-lg pf-m-compact';
           node.properties.role = 'grid';
           let columnHeaders = [];
           for (let child of node.children) {
             if (child.tagName === 'thead') {
+              child.properties.className = 'pf-v5-c-table__thead';
               // Find column headers
               const tr = child.children.find(child => child.tagName === 'tr');
               tr.properties.role = 'row';
+              tr.properties.className = 'pf-v5-c-table__tr';
               tr.children
                 .filter(child => child.tagName === 'th')
                 .forEach(th => {
-                  th.properties.className = th.properties.className || '';
-                  th.properties.className += ' pf-m-wrap';
+                  th.properties.className = `${th.properties.className} pf-v5-c-table__th pf-m-wrap`;
                   th.properties.role = 'columnheader';
                   th.properties.scope = 'col';
                   let colName = '';
@@ -56,14 +57,17 @@ function styledTags() {
             }
             else if (child.tagName === 'tbody') {
               child.properties.role = 'rowgroup';
+              child.properties.className = 'pf-v5-c-table__tbody';
               child.children
                 .filter(tr => tr.tagName === 'tr')
                 .forEach(tr => {
                   tr.properties.role = 'row';
+                  tr.properties.className = 'pf-v5-c-table__tr';
                   tr.children
                     .filter(td => td.tagName === 'td')
                     .forEach((td, i) => {
                       td.properties.role = 'cell';
+                      td.properties.className = 'pf-v5-c-table__td';
                       if (columnHeaders[i]) {
                         td.properties['data-label'] = columnHeaders[i];
                       }

package/scripts/tsDocgen.js

@@ -1,28 +1,28 @@
-const fs = require('fs');
-const reactDocgen = require('react-docgen');
-const ts = require('typescript');
+const fs = require("fs");
+const reactDocgen = require("react-docgen");
+const ts = require("typescript");
 
 const annotations = [
   {
     regex: /@deprecated/,
-    name: 'deprecated',
-    type: 'Boolean'
+    name: "deprecated",
+    type: "Boolean",
   },
   {
     regex: /@hide/,
-    name: 'hide',
-    type: 'Boolean'
+    name: "hide",
+    type: "Boolean",
   },
   {
     regex: /@beta/,
-    name: 'beta',
-    type: 'Boolean'
+    name: "beta",
+    type: "Boolean",
   },
   {
     regex: /@propType\s+(.*)/,
-    name: 'type',
-    type: 'String'
-  }
+    name: "type",
+    type: "String",
+  },
 ];
 
 function addAnnotations(prop) {
@@ -30,12 +30,12 @@ function addAnnotations(prop) {
     annotations.forEach(({ regex, name }) => {
       const match = prop.description.match(regex);
       if (match) {
-        prop.description = prop.description.replace(regex, '').trim();
+        prop.description = prop.description.replace(regex, "").trim();
         if (name) {
           prop[name] = match[2] || match[1] || true;
         }
       }
-    })
+    });
   }
 
   return prop;
@@ -55,74 +55,101 @@ function getComponentMetadata(filename, sourceText) {
     // console.warn(`No component found in ${filename}:`, err);
   }
 
-  return (parsedComponents || []).filter(parsed => parsed && parsed.displayName);
+  return (parsedComponents || []).filter(
+    (parsed) => parsed && parsed.displayName
+  );
 }
 
-function getInterfaceMetadata(filename, sourceText) {
-  const ast = ts.createSourceFile(
+const getNodeText = (node, sourceText) => {
+  if (!node || !node.pos || !node.end) {
+    return undefined;
+  }
+
+  return sourceText.substring(node.pos, node.end).trim();
+};
+
+const buildJsDocProps = (nodes, sourceText) =>
+  nodes?.reduce((acc, member) => {
+    const name =
+      (member.name && member.name.escapedText) ||
+      (member.parameters &&
+        `[${getNodeText(member.parameters[0], sourceText)}]`) ||
+      "Unknown";
+    acc[name] = {
+      description: member.jsDoc
+        ? member.jsDoc.map((doc) => doc.comment).join("\n")
+        : null,
+      required: member.questionToken === undefined,
+      type: {
+        raw: getNodeText(member.type, sourceText).trim(),
+      },
+    };
+    return acc;
+  }, {});
+
+const getSourceFileStatements = (filename, sourceText) => {
+  const { statements } = ts.createSourceFile(
     filename,
     sourceText,
     ts.ScriptTarget.Latest // languageVersion
   );
-  
-  function getText(node) {
-    if (!node || !node.pos || !node.end) {
-      return undefined;
-    }
-    return sourceText.substring(node.pos, node.end).trim();
-  }
 
-  const interfaces = [];
-  
-  ast.statements
-    .filter(statement => statement.kind === ts.SyntaxKind.InterfaceDeclaration)
-    .forEach(statement => {
-      const props = statement.members.reduce((acc, member) => {
-        const name = (member.name && member.name.escapedText)
-          || (member.parameters && `[${getText(member.parameters[0])}]`)
-          || 'Unknown';
-        acc[name] = {
-          description: member.jsDoc
-            ? member.jsDoc.map(doc => doc.comment).join('\n')
-            : null,
-          required: member.questionToken === undefined,
-          type: {
-            raw: getText(member.type).trim()
+  return statements;
+};
+
+const getInterfaceMetadata = (filename, sourceText) =>
+  getSourceFileStatements(filename, sourceText).reduce(
+    (metaDataAcc, statement) => {
+      if (statement.kind === ts.SyntaxKind.InterfaceDeclaration) {
+        metaDataAcc.push({
+          displayName: statement.name.escapedText,
+          description: statement.jsDoc?.map((doc) => doc.comment).join("\n"),
+          props: buildJsDocProps(statement.members, sourceText),
+        });
+      }
+
+      return metaDataAcc;
+    },
+    []
+  );
+
+const getTypeAliasMetadata = (filename, sourceText) =>
+  getSourceFileStatements(filename, sourceText).reduce(
+    (metaDataAcc, statement) => {
+      if (statement.kind === ts.SyntaxKind.TypeAliasDeclaration) {
+        const props = statement.type.types?.reduce((propAcc, type) => {
+          if (type.members) {
+            propAcc.push(buildJsDocProps(type.members, sourceText));
           }
-        };
-        return acc;
-      }, {});
-
-      interfaces.push({
-        displayName: statement.name.escapedText,
-        description: statement.jsDoc
-            ? statement.jsDoc.map(doc => doc.comment).join('\n')
-            : null,
-        props
-      });
-    });
-  return interfaces;
-}
+
+          return propAcc;
+        }, []);
+
+        metaDataAcc.push({
+          props,
+          displayName: statement.name.escapedText,
+          description: statement.jsDoc?.map((doc) => doc.comment).join("\n"),
+        });
+      }
+
+      return metaDataAcc;
+    },
+    []
+  );
 
 function normalizeProp([
   name,
-  {
-    required,
-    annotatedType,
-    type,
-    tsType,
-    description,
-    defaultValue
-  }
+  { required, annotatedType, type, tsType, description, defaultValue },
 ]) {
   const res = {
     name,
-    type: annotatedType
-      || (type && type.name)
-      || (type && (type.raw || type.name))
-      || (tsType && (tsType.raw || tsType.name))
-      || 'No type info',
-    description
+    type:
+      annotatedType ||
+      (type && type.name) ||
+      (type && (type.raw || type.name)) ||
+      (tsType && (tsType.raw || tsType.name)) ||
+      "No type info",
+    description,
   };
   if (required) {
     res.required = true;
@@ -134,45 +161,46 @@ function normalizeProp([
   return res;
 }
 
-function getDescription(parsed, ) {
-
-}
-
 function tsDocgen(file) {
-  const sourceText = fs.readFileSync(file, 'utf8');
+  const sourceText = fs.readFileSync(file, "utf8");
   const componentMeta = getComponentMetadata(file, sourceText); // Array of components with props
   const interfaceMeta = getInterfaceMetadata(file, sourceText); // Array of interfaces with props
-  const interfaceMetaMap = interfaceMeta.reduce(function(target, interface) {
-    target[interface.displayName] = interface;
+  const typeAliasMeta = getTypeAliasMetadata(file, sourceText); // Array of type aliases with props
+  const propsMetaMap = [...interfaceMeta, ...typeAliasMeta].reduce(function (
+    target,
+    interfaceOrTypeAlias
+  ) {
+    target[interfaceOrTypeAlias.displayName] = interfaceOrTypeAlias;
     return target;
-  }, {})
+  },
+  {});
 
-  // Go through each component and check if they have an interface with a jsDoc description
+  // Go through each component and check if they have an interface or type alias with a jsDoc description
   // If so copy it over (fix for https://github.com/patternfly/patternfly-react/issues/7612)
-  componentMeta.forEach(c => {
+  componentMeta.forEach((c) => {
     if (c.description) {
       return c;
     }
-    const interface = `${c.displayName}Props`;
-    if (interfaceMetaMap[interface] && interfaceMetaMap[interface].description) {
-      c.description = interfaceMetaMap[interface].description;
+
+    const propsName = `${c.displayName}Props`;
+    if (propsMetaMap[propsName]?.description) {
+      c.description = propsMetaMap[propsName].description;
     }
-  })
+  });
 
-  return componentMeta
-    .concat(interfaceMeta)
-    .map(parsed => ({
+  return [...componentMeta, ...interfaceMeta, ...typeAliasMeta].map(
+    (parsed) => ({
       name: parsed.displayName,
-      description: parsed.description || '',
+      description: parsed.description || "",
       props: Object.entries(parsed.props || {})
         .map(normalizeProp)
         .map(addAnnotations)
-        .filter(prop => !prop.hide)
-        .sort((p1, p2) => p1.name.localeCompare(p2.name))
-    }));
+        .filter((prop) => !prop.hide)
+        .sort((p1, p2) => p1.name.localeCompare(p2.name)),
+    })
+  );
 }
 
 module.exports = {
-  tsDocgen
+  tsDocgen,
 };
-

package/scripts/typeDocGen.js

@@ -0,0 +1,209 @@
+const TypeDoc = require("typedoc");
+const path = require("path");
+
+/** Compiles variable types if a type is generic. */
+function getVariableType(typeArguments) {
+  if (!typeArguments || typeArguments.length === 0) {
+    return "";
+  }
+
+  const typeArgs = typeArguments.map((type) => getType(type));
+
+  return (
+    typeArgs.reduce((acc, type) => acc + type + ", ", "<").slice(0, -2) + ">"
+  );
+}
+
+/** compiles key/value pairs of a Type or Interface. */
+function getPropertyTypes(properties) {
+  const formattedProperties = properties.reduce((acc, property) => {
+    const { flags, name, type } = property;
+    const formattedName = flags.isOptional ? name + "?" : name;
+    return `${acc}${formattedName}: ${getType(type)}; `;
+  }, "");
+
+  return `{ ${formattedProperties} }`;
+}
+
+/** Compiles the subtypes of a tuple. */
+function getTupleTypes(tupleElements) {
+  const [firstType, secondType] = tupleElements.map((element) =>
+    getType(element)
+  );
+  return `[${firstType}, ${secondType}]`;
+}
+
+/** Compiles the different subtypes of a union or intersection. */
+function getJoinedTypes(types, joinChar) {
+  const joinedTypes = types.map((type) => getType(type));
+  return joinedTypes
+    .reduce((acc, type) => `${acc} ${joinChar} ${type}`, "")
+    .slice(2);
+}
+
+/** Return the type of a reflection.
+ * For anything that has, or can have, multiple subtypes (i.e. variable types in a generic, properties in an interface,
+ * several types in a union, callbacks, etc.) it will recursively navigate the parsed type info as needed to resolve
+ * all relevant subtypes.
+ */
+function getType(reflection) {
+  switch (reflection.type) {
+    case "intrinsic":
+    case "reference":
+      return reflection.name + getVariableType(reflection.typeArguments);
+    case "union":
+      return getJoinedTypes(reflection.types, "|");
+    case "reflection":
+      const { signatures, children } = reflection.declaration;
+      if (signatures) {
+        return getFunctionDocumentation(signatures[0]).type;
+      } else if (children) {
+        return getPropertyTypes(children);
+      } else {
+        return "Props";
+      }
+    case "array":
+      return reflection.elementType.name + "[]";
+    case "tuple":
+      return getTupleTypes(reflection.elements);
+    case "intersection":
+      return getJoinedTypes(reflection.types, "&");
+    case "literal":
+      return reflection.value;
+  }
+}
+
+/** Compiles information about the parameters of a function.
+ * Includes the name, default value, type, and whether it is optional.
+ */
+function getParamInfo(parameters = []) {
+  return parameters.map((parameter) => {
+    const { name, defaultValue, type, flags } = parameter;
+    return {
+      name,
+      default: defaultValue,
+      type: getType(type),
+      optional: flags.isOptional,
+    };
+  });
+}
+
+/** Formats call signature for a function. */
+function formatFunctionType(parameters, returnType) {
+  const annotatedParams = parameters.map((parameter) => {
+    const { name, type, optional } = parameter;
+
+    return [optional ? name + "?" : name, type];
+  });
+
+  const formattedParams = annotatedParams
+    .reduce((acc, param) => `${acc}, ${param[0]}: ${param[1]}`, "")
+    .slice(2);
+
+  return `(${formattedParams}) => ${returnType}`;
+}
+
+/** Primary entry point for gathering type information from a typedoc function reflection. */
+function getFunctionDocumentation(callSignatureReflection) {
+  const { type, parameters, comment } = callSignatureReflection;
+  const params = getParamInfo(parameters);
+
+  const returnType = type?.name || getType(type);
+
+  return {
+    params,
+    returnType,
+    type: formatFunctionType(params, returnType),
+    description: comment?.shortText,
+  };
+}
+
+/** Parses the source for a package using TypeDoc. */
+function typeDocGen(entryPoint, tsconfigLocation) {
+  const app = new TypeDoc.Application();
+  app.options.addReader(new TypeDoc.TSConfigReader());
+  app.bootstrap({
+    // typedoc options here
+    entryPointStrategy: "expand",
+    entryPoints: [entryPoint],
+    tsconfig: tsconfigLocation,
+  });
+
+  // this non-standard reflection creation allows us to ignore any type errors in a package
+  const project = app.converter.convert(app.getEntryPoints() ?? []);
+
+  // if something caused project conversion to fail log an error
+  if (project) {
+    return project;
+  } else {
+    console.error("Something went wrong during typedoc project conversion");
+    return {};
+  }
+}
+
+/** Takes package information and returns an object with all tsdoc standard format info about the functions in it.
+ * 
+ * The object has file names as keys, with values being an additional object which has the function names in that file
+ * as keys and the information about that function as the value, also in object form.
+ * Information includes the name of the file in which it's defined, the parameters, description, default values and
+ * type information.
+ *
+ * Example structure:
+ * {
+ *   "components/component.tsx": {
+ *     "boolToString": {
+ *       "description": "Converts a boolean to a string",
+ *       "params": [
+ *         {
+ *           "default": false,
+ *           "name": "booleanValue",
+ *           "optional": true,
+ *           "type": "boolean",
+ *         },
+ *       ],
+ *       "returnType": "string",
+ *       "type": "(booleanValue?: boolean) => string",
+ *     },
+ *   },
+ * }
+ */
+function getPackageFunctionDocumentation(
+  packageName,
+  pathToRoot = "dist/js/index.js",
+  srcPath = "src",
+  tsconfigPath = "tsconfig.json"
+) {
+  const packageRoot = require.resolve(packageName).replace(pathToRoot, "");
+  const entry = path.relative(process.cwd(), path.join(packageRoot, srcPath));
+  const configLocation = path.relative(
+    process.cwd(),
+    path.join(packageRoot, tsconfigPath)
+  );
+
+  const packageReflection = typeDocGen(entry, configLocation);
+
+  // 64 corresponds with functions, see all reflection kinds here: https://typedoc.org/api/enums/Models.ReflectionKind-1.html
+  const functionReflections = packageReflection.getReflectionsByKind(64);
+
+  const functionsMap = functionReflections.reduce((acc, functionReflection) => {
+    const { name, sources, signatures } = functionReflection;
+
+    const sourceFile = sources[0].fileName;
+    const shortSourceFile = sourceFile.replace(
+      `${packageName}/${srcPath}/`,
+      ""
+    );
+    const obj = getFunctionDocumentation(signatures[0]);
+
+    if (acc[shortSourceFile]) {
+      acc[shortSourceFile] = { ...acc[shortSourceFile], [name]: obj };
+    } else {
+      acc[shortSourceFile] = { [name]: obj };
+    }
+    return acc;
+  }, {});
+
+  return functionsMap;
+}
+
+module.exports = { getPackageFunctionDocumentation };

package/scripts/webpack/getHtmlWebpackPlugins.js

@@ -9,7 +9,6 @@ async function getHtmlWebpackPlugin({
   isProd,
   googleAnalyticsID,
   algolia,
-  pathPrefix = '',
   url,
   title,
   isFullscreen
@@ -20,7 +19,7 @@ async function getHtmlWebpackPlugin({
     templateParameters: {
       title: getTitle(title),
       // Don't prerender fullscreen pages (expensive!)
-      prerendering: (isProd && !isFullscreen && !url.includes('topology') && !url.includes('extensions')) ? await prerender(url, pathPrefix) : null,
+      prerendering: (isProd && !isFullscreen && !url.includes('topology') && !url.includes('extensions')) ? await prerender(url) : null,
       // Don't use GA in dev mode
       googleAnalyticsID: isProd ? googleAnalyticsID : false,
       algolia

package/scripts/webpack/prerender.js

@@ -8,8 +8,7 @@ const ssrPrepass = require('react-ssr-prepass');
 
 // This function is effectively synchronous because it mutates global.setTimeout
 // Only allow one copy at a time to run
-async function prerender(url, pathPrefix) {
-  url = `${pathPrefix}${url}`;
+async function prerender(url) {
   const location = { pathname: url };
   // For @reach/router
   global.history = {};