@next-core/build-config-factory 2.21.0 → 2.23.2

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.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)
+
+
+### 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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-core/build-config-factory",
-  "version": "2.21.0",
+  "version": "2.23.2",
   "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": "34a0808712ecaa925d0860d281ab23cf3bec7317"
+  "gitHead": "9bbe86c9ce96b4bf283c7ec3cddafaa6617e2601"
 }

package/src/generateBrickDocs.js

@@ -168,7 +168,7 @@ function composeBrickDocMethods(brick) {
             parameter.flags?.isOptional ? "?" : ""
           }: ${extractRealInterfaceType(parameter.type)}`
       )
-      .join(" "),
+      .join(", "),
     ...convertTagsToMapByFields(tags, methodComments),
   };
 }
@@ -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":
@@ -336,14 +344,12 @@ function extractRealInterfaceType(typeData, parentType) {
         typeData.type
       )}[]`;
     case "union":
-      if (parentType === "array") {
-        return `(${typeData.types
-          .map((type) => extractRealInterfaceType(type))
-          .join(" | ")})`;
-      }
-      return typeData.types
-        .map((type) => extractRealInterfaceType(type))
-        .join(" | ");
+      return wrapBracketByParentType(
+        typeData.types
+          .map((type) => extractRealInterfaceType(type, typeData.type))
+          .join(" | "),
+        parentType
+      );
     case "stringLiteral":
       return `"${typeData.value}"`;
     case "intrinsic":
@@ -351,32 +357,57 @@ 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 { children = [], indexSignature = [] } = typeData.declaration;
-
-        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(" ")} }`;
+        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 wrapBracketByParentType(typeStr, parentType);
+        } 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";
       }
     }
+    case "tuple":
+      return `[${typeData.elements
+        ?.map((element) => element.name)
+        .join(", ")}]`;
     default:
       return "";
   }
@@ -446,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 {
@@ -464,7 +501,6 @@ function extractBrickDocInterface(typeIds, references) {
                   })),
                   type: extractRealInterfaceType(child.type),
                   required: !get(child, ["flags", "isOptional"], false),
-                  description: get(child, ["comment", "shortText"], "").trim(),
                 };
               }) || [],
           };
@@ -634,6 +670,54 @@ 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
+          );
+        });
+      }
+      break;
+    case "tuple":
+      type.elements?.forEach((element) =>
+        traverseUsedReferenceIdsByType(
+          element,
+          usedReferenceIds,
+          references,
+          traversedTypeSet
+        )
+      );
+      break;
   }
 }