@next-core/build-config-factory 2.19.0 → 2.22.0

package/CHANGELOG.md

@@ -3,6 +3,42 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.22.0](https://github.com/easyops-cn/next-core/compare/@next-core/build-config-factory@2.21.0...@next-core/build-config-factory@2.22.0) (2022-07-11)
+
+
+### Features
+
+* **generateBrickDocs:** support function type ([b085bbf](https://github.com/easyops-cn/next-core/commit/b085bbf089b89dc6e7fa7f743a69731b24ea449a))
+
+
+
+
+
+# [2.21.0](https://github.com/easyops-cn/next-core/compare/@next-core/build-config-factory@2.20.0...@next-core/build-config-factory@2.21.0) (2022-07-07)
+
+
+### Features
+
+* **generateBrickDocs:** support description of enum and interface ([3b81fe1](https://github.com/easyops-cn/next-core/commit/3b81fe1a5ee3d1666083fad50c7da8d62379c98a))
+* **generateBrickDocs:** support get detail of reflection type from declaration ([b62557f](https://github.com/easyops-cn/next-core/commit/b62557f09a362a85ac25151d8940cec4e691700b))
+* **generateBrickDocs:** support get parameters type of method from declaration ([e88bef6](https://github.com/easyops-cn/next-core/commit/e88bef6006140001bd44271911566df497e03ca4))
+* **generateBrickDocs:** support get property type from setter ([5825363](https://github.com/easyops-cn/next-core/commit/5825363195c4359a21b9b80360a58a261e886825))
+
+
+
+
+
+# [2.20.0](https://github.com/easyops-cn/next-core/compare/@next-core/build-config-factory@2.19.0...@next-core/build-config-factory@2.20.0) (2022-07-05)
+
+
+### Features
+
+* **generateBrickDocs:** support infer required and default of property and detail of event from declaration ([6a60f26](https://github.com/easyops-cn/next-core/commit/6a60f26563683d89d5b36bb766f973cb23522e70))
+
+
+
+
+
 # [2.19.0](https://github.com/easyops-cn/next-core/compare/@next-core/build-config-factory@2.18.52...@next-core/build-config-factory@2.19.0) (2022-07-05)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-core/build-config-factory",
-  "version": "2.19.0",
+  "version": "2.22.0",
   "description": "build config factory",
   "homepage": "https://github.com/easyops-cn/next-core/tree/master/packages/build-config-factory",
   "license": "GPL-3.0",
@@ -18,7 +18,7 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@next-core/brick-utils": "^2.37.20",
+    "@next-core/brick-utils": "^2.37.21",
     "@next-core/repo-config": "^0.2.1",
     "@next-core/typedoc-plugin-filter-inherit": "^1.2.2",
     "@next-core/webpack-config-factory": "^2.16.6",
@@ -37,5 +37,5 @@
     "typedoc": "^0.19.2",
     "typedoc-plugin-no-inherit": "^1.2.2"
   },
-  "gitHead": "b8a911770baa015938fd6f70daaeb584ea2449c8"
+  "gitHead": "42bab4e94fbac369b5e9953272d568ba5cfb15e8"
 }

package/src/generateBrickDocs.js

@@ -100,12 +100,26 @@ function convertTagsToMapByFields(tags, fields) {
   }, {});
 }
 
+function getClassChildType(child) {
+  let type = child.type;
+
+  // setter
+  if (!type && child.kindString === "Accessor" && child.setSignature) {
+    type = child.setSignature[0].parameters[0].type;
+  }
+
+  return type;
+}
+
 function composeBrickDocProperties(brick) {
-  const { name, comment } = brick;
-  const type = brick.type && brick.type.type;
+  const { name, comment, flags, defaultValue } = brick;
+  const type = getClassChildType(brick);
+
   return {
     name,
-    type: extractRealInterfaceType(type, brick.type),
+    type: extractRealInterfaceType(type),
+    required: flags?.isOptional !== true,
+    default: defaultValue,
     ...convertTagsToMapByFields(get(comment, "tags", []), propertyDocComments),
   };
 }
@@ -122,11 +136,19 @@ function getEventTypeByDecorators(decorators) {
   return null;
 }
 
+function getDetailTypeByEventType(type) {
+  if (type.name === "EventEmitter" && type.typeArguments?.length > 0) {
+    const argument = type.typeArguments[0];
+    return extractRealInterfaceType(argument);
+  }
+}
+
 function composeBrickDocEvents(brick) {
-  const { comment, decorators } = brick;
+  const { comment, decorators, type } = brick;
 
   return {
     type: getEventTypeByDecorators(decorators),
+    detail: getDetailTypeByEventType(type),
     ...convertTagsToMapByFields(get(comment, "tags", []), eventDocComments),
   };
 }
@@ -139,6 +161,14 @@ function composeBrickDocMethods(brick) {
     [];
   return {
     name,
+    params: signatures[0].parameters
+      ?.map(
+        (parameter) =>
+          `${parameter.name}${
+            parameter.flags?.isOptional ? "?" : ""
+          }: ${extractRealInterfaceType(parameter.type)}`
+      )
+      .join(", "),
     ...convertTagsToMapByFields(tags, methodComments),
   };
 }
@@ -284,8 +314,8 @@ function existBrickDocId(element) {
   }
 }
 
-function extractRealInterfaceType(type, typeData, parentType) {
-  switch (type) {
+function extractRealInterfaceType(typeData, parentType) {
+  switch (typeData?.type) {
     case "reference":
       // eslint-disable-next-line no-case-declarations
       let result = "";
@@ -295,26 +325,25 @@ function extractRealInterfaceType(type, typeData, parentType) {
 
       if (typeData.typeArguments && typeData.typeArguments.length > 0) {
         result += `<${typeData.typeArguments
-          .map((type) => extractRealInterfaceType(type.type, type))
+          .map((type) => extractRealInterfaceType(type))
           .join(", ")}>`;
       }
 
       return result;
     case "array":
       return `${extractRealInterfaceType(
-        typeData.elementType.type,
         typeData.elementType,
-        type
+        typeData.type
       )}[]`;
-    case "union":
-      if (parentType === "array") {
-        return `(${typeData.types
-          .map((type) => extractRealInterfaceType(type.type, type))
-          .join(" | ")})`;
-      }
-      return typeData.types
-        .map((type) => extractRealInterfaceType(type.type, type))
+    case "union": {
+      const typeStr = typeData.types
+        .map((type) => extractRealInterfaceType(type, typeData.type))
         .join(" | ");
+
+      return parentType === "array" || parentType === "union"
+        ? `(${typeStr})`
+        : typeStr;
+    }
     case "stringLiteral":
       return `"${typeData.value}"`;
     case "intrinsic":
@@ -323,10 +352,51 @@ function extractRealInterfaceType(type, typeData, parentType) {
       return typeData.name;
     case "intersection":
       return typeData.types
-        .map((type) => extractRealInterfaceType(type.type, type))
+        .map((type) => extractRealInterfaceType(type))
         .join(" & ");
-    case "reflection":
-      return "object";
+    case "reflection": {
+      if (typeData.declaration) {
+        const {
+          signatures,
+          children = [],
+          indexSignature = [],
+        } = typeData.declaration;
+
+        if (signatures) {
+          const { parameters, type } = signatures[0];
+          const typeStr = `(${parameters
+            ?.map(
+              (parameter) =>
+                `${parameter.name}${
+                  parameter.flags?.isOptional ? "?" : ""
+                }: ${extractRealInterfaceType(parameter.type)}`
+            )
+            .join(", ")}) => ${extractRealInterfaceType(type)}`;
+
+          return parentType === "array" || parentType === "union"
+            ? `(${typeStr})`
+            : typeStr;
+        } else {
+          return `{ ${[
+            ...children.map(
+              (child) =>
+                `${child.name}${
+                  child.flags?.isOptional ? "?" : ""
+                }: ${extractRealInterfaceType(child.type)};`
+            ),
+            ...indexSignature.map((item) => {
+              const parameter = item.parameters[0];
+              return `[${parameter.name}: ${extractRealInterfaceType(
+                parameter.type.type,
+                parameter.type
+              )}]: ${extractRealInterfaceType(item.type)};`;
+            }),
+          ].join(" ")} }`;
+        }
+      } else {
+        return "object";
+      }
+    }
     default:
       return "";
   }
@@ -338,7 +408,7 @@ function extractBrickDocTypes(type) {
     typeParameter: getTypeParameter(type),
     kind: "type",
     description: get(type, ["comment", "shortText"], "").trim(),
-    type: extractRealInterfaceType(type.type.type, type.type),
+    type: extractRealInterfaceType(type.type),
   };
 }
 
@@ -347,6 +417,7 @@ function extractBrickDocEnumerations(enumerations) {
     name: enumerations.name,
     typeParameter: null,
     kind: "enum",
+    description: enumerations?.comment?.shortText?.trim(),
     children: [
       ...enumerations.children.map((child) => {
         return {
@@ -393,11 +464,12 @@ function extractBrickDocInterface(typeIds, references) {
             typeParameter: getTypeParameter(finder),
             kind: "interface",
             extendedTypes: finder.extendedTypes,
+            description: finder?.comment?.shortText?.trim(),
             children:
               finder.children?.map((child) => {
                 return {
                   name: child.name,
-                  type: extractRealInterfaceType(child.type.type, child.type),
+                  type: extractRealInterfaceType(child.type),
                   required: !get(child, ["flags", "isOptional"], false),
                   description: get(child, ["comment", "shortText"], "").trim(),
                 };
@@ -408,12 +480,9 @@ function extractBrickDocInterface(typeIds, references) {
                   name: child.name,
                   parameters: child.parameters.map((parameter) => ({
                     ...parameter,
-                    type: extractRealInterfaceType(
-                      parameter.type.type,
-                      parameter.type
-                    ),
+                    type: extractRealInterfaceType(parameter.type),
                   })),
-                  type: extractRealInterfaceType(child.type.type, child.type),
+                  type: extractRealInterfaceType(child.type),
                   required: !get(child, ["flags", "isOptional"], false),
                   description: get(child, ["comment", "shortText"], "").trim(),
                 };
@@ -458,12 +527,25 @@ function traverseElementUsedInterfaceIds(
   traversedTypeSet
 ) {
   element.children.forEach((child) => {
-    traverseUsedReferenceIdsByType(
-      child.type,
-      usedReferenceIds,
-      references,
-      traversedTypeSet
-    );
+    if (child.kindString === "Method") {
+      child.signatures[0].parameters?.map((parameter) =>
+        traverseUsedReferenceIdsByType(
+          parameter.type,
+          usedReferenceIds,
+          references,
+          traversedTypeSet
+        )
+      );
+    } else {
+      const type = getClassChildType(child);
+
+      traverseUsedReferenceIdsByType(
+        type,
+        usedReferenceIds,
+        references,
+        traversedTypeSet
+      );
+    }
   });
 }
 
@@ -572,6 +654,43 @@ function traverseUsedReferenceIdsByType(
         traversedTypeSet
       );
       break;
+    case "reflection":
+      if (type.declaration) {
+        const { signatures, children, indexSignature } = type.declaration;
+
+        signatures?.forEach((signature) => {
+          signature.parameters?.forEach((parameter) =>
+            traverseUsedReferenceIdsByType(
+              parameter.type,
+              usedReferenceIds,
+              references,
+              traversedTypeSet
+            )
+          );
+          traverseUsedReferenceIdsByType(
+            signature.type,
+            usedReferenceIds,
+            references,
+            traversedTypeSet
+          );
+        });
+        children?.forEach((child) => {
+          traverseUsedReferenceIdsByType(
+            child.type,
+            usedReferenceIds,
+            references,
+            traversedTypeSet
+          );
+        });
+        indexSignature?.forEach((item) => {
+          traverseUsedReferenceIdsByType(
+            item.type,
+            usedReferenceIds,
+            references,
+            traversedTypeSet
+          );
+        });
+      }
   }
 }