@next-core/build-config-factory 2.18.45 → 2.18.48

package/CHANGELOG.md

@@ -3,6 +3,39 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.18.48](https://github.com/easyops-cn/next-core/compare/@next-core/build-config-factory@2.18.47...@next-core/build-config-factory@2.18.48) (2022-06-23)
+
+
+### Bug Fixes
+
+* show inherited method ([779eddb](https://github.com/easyops-cn/next-core/commit/779eddbf7bee66b24566eaf0288a14ae05079f5f))
+
+
+
+
+
+## [2.18.47](https://github.com/easyops-cn/next-core/compare/@next-core/build-config-factory@2.18.46...@next-core/build-config-factory@2.18.47) (2022-06-14)
+
+
+### Bug Fixes
+
+* typo ([7e942d3](https://github.com/easyops-cn/next-core/commit/7e942d363d9af86875b10a167b50a5d0972835e0))
+
+
+
+
+
+## [2.18.46](https://github.com/easyops-cn/next-core/compare/@next-core/build-config-factory@2.18.45...@next-core/build-config-factory@2.18.46) (2022-06-10)
+
+
+### Bug Fixes
+
+* support group i18n ([b8b774f](https://github.com/easyops-cn/next-core/commit/b8b774f705b5be23209b3839d0a12780dd5b9550))
+
+
+
+
+
 ## [2.18.45](https://github.com/easyops-cn/next-core/compare/@next-core/build-config-factory@2.18.44...@next-core/build-config-factory@2.18.45) (2022-06-06)
 
 **Note:** Version bump only for package @next-core/build-config-factory

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-core/build-config-factory",
-  "version": "2.18.45",
+  "version": "2.18.48",
   "description": "build config factory",
   "homepage": "https://github.com/easyops-cn/next-core/tree/master/packages/build-config-factory",
   "license": "GPL-3.0",
@@ -20,7 +20,7 @@
   "dependencies": {
     "@next-core/brick-utils": "^2.37.17",
     "@next-core/repo-config": "^0.2.1",
-    "@next-core/typedoc-plugin-filter-inherit": "^1.0.0",
+    "@next-core/typedoc-plugin-filter-inherit": "^1.2.0",
     "@next-core/webpack-config-factory": "^2.16.2",
     "change-case": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -37,5 +37,5 @@
     "typedoc": "^0.19.2",
     "typedoc-plugin-no-inherit": "^1.2.2"
   },
-  "gitHead": "a5a878706651388fc1cd282c5826b8abadda5d11"
+  "gitHead": "fea00f68859e17286116e998c4b52bc287374a91"
 }

package/src/generateBrickDocs.js

@@ -36,6 +36,7 @@ const baseDocComments = [
   "deprecated",
   "editor",
   "editorprops",
+  "groupi18n",
 ];
 
 function generateBrickDoc(doc) {
@@ -72,13 +73,23 @@ function convertTagsToMapByFields(tags, fields) {
         return prev;
       }
 
-      if (curr.tag === "editorprops") {
+      let specialField;
+      // typedoc 读取到的 tag 都为小写，不是驼峰的形式，这里特殊处理下最终文档生成驼峰的形式
+      if (
+        (specialField = ["editorProps", "groupI18N"].find(
+          (name) => name.toLowerCase() === curr.tag
+        ))
+      ) {
         try {
-          prev["editorProps"] = JSON.parse(curr.text);
+          prev[specialField] = JSON.parse(curr.text);
           return prev;
         } catch {
           const find = tags.find((item) => item.tag === "name");
-          throw new Error(`editorProps of ${find && find.text} parse error`);
+          throw new Error(
+            `${specialField} tag of ${
+              find && find.text
+            } \`JSON.parse()\` parse error`
+          );
         }
       }
 
@@ -166,12 +177,18 @@ function extractBrickDocBaseKind(tags) {
 
 function getRealBrickDocCategory(brick) {
   if (!Object.prototype.hasOwnProperty.call(brick, "decorators")) {
-    //当继承的属性来自于 node_modeule 时，相关的 @propert decorators 已经被转成低版本的代码，typedoc 获取不到相关 decorators 信息，
+    //当继承的属性来自于 node_module 时，相关的 @property decorators 已经被转成低版本的代码，typedoc 获取不到相关 decorators 信息，
     // 这里通过 comment tag 来标识是否使用了 @property, 以便继承的属性也能生成到文档的 property 类别中显示
     if (
       get(brick, "comment.tags", []).find((item) => item.tag === "property")
     ) {
       return "property";
+    } else if (
+      get(brick, "signatures[0].comment.tags", []).find(
+        (item) => item.tag === "method"
+      )
+    ) {
+      return "method";
     }
 
     return null;
@@ -237,11 +254,11 @@ function extractBrickDocComplexKind(groups, elementChildren) {
     }, {});
 
   // `Object literals` 类型也会放在 Properties 列表中， 放进去后再统一进行排序
-  const propertieList = brickConf[brickKindMap.property];
-  return propertieList
+  const propertiesList = brickConf[brickKindMap.property];
+  return propertiesList
     ? {
         ...brickConf,
-        [brickKindMap.property]: sortBy(propertieList, (item) => {
+        [brickKindMap.property]: sortBy(propertiesList, (item) => {
           const find = elementChildren.find(
             (child) => child.name === item.name
           );
@@ -614,7 +631,6 @@ module.exports = function generateBrickDocs(packageName) {
     // disableSources: true,
     hideGenerator: true,
     categoryOrder: ["property", "event", "method", "Other"],
-    allowInheritedDoc: ["FormItemElement", "BaseChartElement", "GraphElement"],
     exclude: [
       "node_modules",
       "**/*.spec.ts?(x)",