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

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [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.0",
   "description": "build config factory",
   "homepage": "https://github.com/easyops-cn/next-core/tree/master/packages/build-config-factory",
   "license": "GPL-3.0",
@@ -37,5 +37,5 @@
     "typedoc": "^0.19.2",
     "typedoc-plugin-no-inherit": "^1.2.2"
   },
-  "gitHead": "42bab4e94fbac369b5e9953272d568ba5cfb15e8"
+  "gitHead": "c8dfe32cac64f85af7aa55e420d6b5182d1c1505"
 }

package/src/generateBrickDocs.js

@@ -397,6 +397,10 @@ function extractRealInterfaceType(typeData, parentType) {
         return "object";
       }
     }
+    case "tuple":
+      return `[${typeData.elements
+        ?.map((element) => element.name)
+        .join(", ")}]`;
     default:
       return "";
   }
@@ -466,14 +470,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 +494,6 @@ function extractBrickDocInterface(typeIds, references) {
                   })),
                   type: extractRealInterfaceType(child.type),
                   required: !get(child, ["flags", "isOptional"], false),
-                  description: get(child, ["comment", "shortText"], "").trim(),
                 };
               }) || [],
           };
@@ -691,6 +700,17 @@ function traverseUsedReferenceIdsByType(
           );
         });
       }
+      break;
+    case "tuple":
+      type.elements?.forEach((element) =>
+        traverseUsedReferenceIdsByType(
+          element,
+          usedReferenceIds,
+          references,
+          traversedTypeSet
+        )
+      );
+      break;
   }
 }