@bigbinary/neeto-playwright-commons 1.9.10 → 1.9.11

package/configs/scripts/jsdoc-builder/utils.mjs

@@ -28,6 +28,7 @@ import _traverse from "@babel/traverse";
 import _generate from "@babel/generator";
 
 import { matches } from "@bigbinary/neeto-cist";
+import { endsWith } from "ramda";
 
 const traverse = _traverse.default;
 const generate = _generate.default;
@@ -79,7 +80,9 @@ const getParagraphChildrenText = node => {
   const children = node.children;
   if (children.length === 1) return children[0].value;
 
-  return children.map(child => child.value || child.children[0].value).join("");
+  return children
+    .map(child => child.value || child.children?.[0]?.value)
+    .join("");
 };
 
 const transformParagraph = node => {
@@ -206,14 +209,15 @@ export const defaultTypeFileTraverser = options => {
 export const findVariableDeclarationName = node =>
   node?.declarations?.[0]?.id?.name || node?.declaration?.id?.name;
 
+export const isUtil = entityName => endsWith("Utils", entityName);
+
 export const findClassPropertyName = node => node?.key?.name;
 
-export const handleNode = ({
+export const handleEntity = (
   node,
-  extractEntityName,
-  options: { entityTitleToDescMapOfAllFiles, typeFileName, typeFileAST },
-}) => {
-  const entityName = extractEntityName(node);
+  entityTitleToDescMapOfAllFiles,
+  entityName
+) => {
   const entityDesc = entityTitleToDescMapOfAllFiles[entityName];
 
   if (!entityName || !entityDesc) {
@@ -221,6 +225,31 @@ export const handleNode = ({
   }
 
   babelTypes.addComment(node, "leading", entityDesc);
+};
+
+export const handleUtilityMethods = (node, entityTitleToDescMapOfAllFiles) => {
+  const members =
+    node?.declarations?.[0]?.id?.typeAnnotation?.typeAnnotation?.members;
+
+  members.map(methodNode => {
+    handleEntity(
+      methodNode,
+      entityTitleToDescMapOfAllFiles,
+      methodNode.key.name
+    );
+  });
+};
+
+export const handleNode = ({
+  node,
+  extractEntityName,
+  options: { entityTitleToDescMapOfAllFiles, typeFileName, typeFileAST },
+}) => {
+  const entityName = extractEntityName(node);
+
+  isUtil(entityName)
+    ? handleUtilityMethods(node, entityTitleToDescMapOfAllFiles)
+    : handleEntity(node, entityTitleToDescMapOfAllFiles, entityName);
 
   const { code } = generate(typeFileAST, {});