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

package/CHANGELOG.md

@@ -3,6 +3,52 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.23.3](https://github.com/easyops-cn/next-core/compare/@next-core/build-config-factory@2.23.2...@next-core/build-config-factory@2.23.3) (2022-07-14)
+
+
+### Bug Fixes
+
+* **generateBrickDocs:** filter element childern without supported decorators ([a2f8e50](https://github.com/easyops-cn/next-core/commit/a2f8e50425a6a1c6aec4ed2d6c21858d2d4dbea4))
+
+
+
+
+
+## [2.23.2](https://github.com/easyops-cn/next-core/compare/@next-core/build-config-factory@2.23.1...@next-core/build-config-factory@2.23.2) (2022-07-12)
+
+
+### Bug Fixes
+
+* **generateBrickDocs:** support wrapping intersection types ([9dca68d](https://github.com/easyops-cn/next-core/commit/9dca68d14396fec7f250c2ad41ba95464dcc3577))
+
+
+
+
+
+## [2.23.1](https://github.com/easyops-cn/next-core/compare/@next-core/build-config-factory@2.23.0...@next-core/build-config-factory@2.23.1) (2022-07-12)
+
+**Note:** Version bump only for package @next-core/build-config-factory
+
+
+
+
+
+# [2.23.0](https://github.com/easyops-cn/next-core/compare/@next-core/build-config-factory@2.22.0...@next-core/build-config-factory@2.23.0) (2022-07-12)
+
+
+### Bug Fixes
+
+* **generateBrickDocs:** filter inherited properties ([38daaff](https://github.com/easyops-cn/next-core/commit/38daaffa0dcb5c4ef66cc3d846e525db2ea3ba95))
+
+
+### Features
+
+* **generateBrickDocs:** support typle types ([148ad87](https://github.com/easyops-cn/next-core/commit/148ad87935a8deac87c69fd4d60828a2aef7723f))
+
+
+
+
+
 # [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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-core/build-config-factory",
-  "version": "2.22.0",
+  "version": "2.23.3",
   "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.21",
+    "@next-core/brick-utils": "^2.37.22",
     "@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": "42bab4e94fbac369b5e9953272d568ba5cfb15e8"
+  "gitHead": "00b8306625746d076f581d99f3132f8fdabfe977"
 }

package/src/generateBrickDocs.js

@@ -11,7 +11,7 @@ const brickKindMap = {
 };
 const extraScanPaths = ["src/interfaces"];
 
-const supportedDecorators = ["property", "event", "method"];
+const supportedDecoratorSet = new Set(["property", "event", "method"]);
 const methodComments = ["params", "description", "deprecated"];
 const eventDocComments = ["detail", "description", "deprecated"];
 const propertyDocComments = [
@@ -225,7 +225,7 @@ function getRealBrickDocCategory(brick) {
   }
 
   const finder = brick.decorators.find((d) =>
-    supportedDecorators.includes(d.name)
+    supportedDecoratorSet.has(d.name)
   );
 
   if (finder) {
@@ -314,6 +314,14 @@ function existBrickDocId(element) {
   }
 }
 
+function wrapBracketByParentType(typeStr, parentType) {
+  return parentType === "array" ||
+    parentType === "union" ||
+    parentType === "intersection"
+    ? `(${typeStr})`
+    : typeStr;
+}
+
 function extractRealInterfaceType(typeData, parentType) {
   switch (typeData?.type) {
     case "reference":
@@ -335,15 +343,13 @@ function extractRealInterfaceType(typeData, parentType) {
         typeData.elementType,
         typeData.type
       )}[]`;
-    case "union": {
-      const typeStr = typeData.types
-        .map((type) => extractRealInterfaceType(type, typeData.type))
-        .join(" | ");
-
-      return parentType === "array" || parentType === "union"
-        ? `(${typeStr})`
-        : typeStr;
-    }
+    case "union":
+      return wrapBracketByParentType(
+        typeData.types
+          .map((type) => extractRealInterfaceType(type, typeData.type))
+          .join(" | "),
+        parentType
+      );
     case "stringLiteral":
       return `"${typeData.value}"`;
     case "intrinsic":
@@ -351,9 +357,12 @@ function extractRealInterfaceType(typeData, parentType) {
     case "unknown": // unknown 暂定是`type`中的数字类型,e.g: type t = 0 | 1 | 'string'
       return typeData.name;
     case "intersection":
-      return typeData.types
-        .map((type) => extractRealInterfaceType(type))
-        .join(" & ");
+      return wrapBracketByParentType(
+        typeData.types
+          .map((type) => extractRealInterfaceType(type, typeData.type))
+          .join(" & "),
+        parentType
+      );
     case "reflection": {
       if (typeData.declaration) {
         const {
@@ -373,30 +382,32 @@ function extractRealInterfaceType(typeData, parentType) {
             )
             .join(", ")}) => ${extractRealInterfaceType(type)}`;
 
-          return parentType === "array" || parentType === "union"
-            ? `(${typeStr})`
-            : typeStr;
+          return wrapBracketByParentType(typeStr, parentType);
         } else {
           return `{ ${[
             ...children.map(
               (child) =>
                 `${child.name}${
                   child.flags?.isOptional ? "?" : ""
-                }: ${extractRealInterfaceType(child.type)};`
+                }: ${extractRealInterfaceType(child.type)}`
             ),
             ...indexSignature.map((item) => {
               const parameter = item.parameters[0];
               return `[${parameter.name}: ${extractRealInterfaceType(
                 parameter.type.type,
                 parameter.type
-              )}]: ${extractRealInterfaceType(item.type)};`;
+              )}]: ${extractRealInterfaceType(item.type)}`;
             }),
-          ].join(" ")} }`;
+          ].join("; ")} }`;
         }
       } else {
         return "object";
       }
     }
+    case "tuple":
+      return `[${typeData.elements
+        ?.map((element) => element.name)
+        .join(", ")}]`;
     default:
       return "";
   }
@@ -466,14 +477,20 @@ function extractBrickDocInterface(typeIds, references) {
             extendedTypes: finder.extendedTypes,
             description: finder?.comment?.shortText?.trim(),
             children:
-              finder.children?.map((child) => {
-                return {
-                  name: child.name,
-                  type: extractRealInterfaceType(child.type),
-                  required: !get(child, ["flags", "isOptional"], false),
-                  description: get(child, ["comment", "shortText"], "").trim(),
-                };
-              }) || [],
+              finder.children
+                ?.filter((child) => !child.inheritedFrom)
+                .map((child) => {
+                  return {
+                    name: child.name,
+                    type: extractRealInterfaceType(child.type),
+                    required: !get(child, ["flags", "isOptional"], false),
+                    description: get(
+                      child,
+                      ["comment", "shortText"],
+                      ""
+                    ).trim(),
+                  };
+                }) || [],
             indexSignature:
               finder.indexSignature?.map((child) => {
                 return {
@@ -484,7 +501,6 @@ function extractBrickDocInterface(typeIds, references) {
                   })),
                   type: extractRealInterfaceType(child.type),
                   required: !get(child, ["flags", "isOptional"], false),
-                  description: get(child, ["comment", "shortText"], "").trim(),
                 };
               }) || [],
           };
@@ -527,6 +543,14 @@ function traverseElementUsedInterfaceIds(
   traversedTypeSet
 ) {
   element.children.forEach((child) => {
+    if (
+      !child.decorators?.some((decorator) =>
+        supportedDecoratorSet.has(decorator.name)
+      )
+    ) {
+      return;
+    }
+
     if (child.kindString === "Method") {
       child.signatures[0].parameters?.map((parameter) =>
         traverseUsedReferenceIdsByType(
@@ -691,6 +715,17 @@ function traverseUsedReferenceIdsByType(
           );
         });
       }
+      break;
+    case "tuple":
+      type.elements?.forEach((element) =>
+        traverseUsedReferenceIdsByType(
+          element,
+          usedReferenceIds,
+          references,
+          traversedTypeSet
+        )
+      );
+      break;
   }
 }