Merge pull request #34 from easyops-cn/steve/parts

Support parts
easyops-cn · Aug 1, 2023 · 40143a7 · 40143a7
2 parents df74c88 + 7d0be7b
commit 40143a7
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 16 deletions.
diff --git a/package.json b/package.json
@@ -23,10 +23,10 @@
     "@docusaurus/preset-classic": "2.4.1",
     "@easyops-cn/docusaurus-search-local": "^0.35.0",
     "@mdx-js/react": "^1.6.22",
-    "@next-core/brick-manifest": "^0.5.0",
-    "@next-core/doc-helpers": "^0.1.9",
+    "@next-core/brick-manifest": "^0.5.1",
+    "@next-core/doc-helpers": "^0.1.10",
     "@next-core/monaco-contributions": "^0.3.1",
-    "@next-core/preview": "^0.1.34",
+    "@next-core/preview": "^0.1.35",
     "clsx": "^1.2.1",
     "copy-to-clipboard": "^3.3.3",
     "monaco-editor": "^0.40.0",

diff --git a/scripts/pre-build.mjs b/scripts/pre-build.mjs
@@ -64,6 +64,7 @@ import BrickDocProperties from "@site/src/components/BrickDocProperties";
 import BrickDocSlots from "@site/src/components/BrickDocSlots";
 import BrickDocEvents from "@site/src/components/BrickDocEvents";
 import BrickDocMethods from "@site/src/components/BrickDocMethods";
+import BrickDocParts from "@site/src/components/BrickDocParts";
 import BrickDocTypes from "@site/src/components/BrickDocTypes";
 import { TypeReferencesContext } from "@site/src/components/GeneralType";
 
@@ -113,6 +114,16 @@ ${
     : ""
 }
 
+${
+  brick.parts && brick.parts.length > 0
+    ?
+`## Parts
+
+<BrickDocParts parts={${JSON.stringify(brick.parts)}} />
+`
+    : ""
+}
+
 ${
   brick.types && brick.types.length > 0
   ?

diff --git a/src/components/BrickDocParts/index.tsx b/src/components/BrickDocParts/index.tsx
@@ -0,0 +1,29 @@
+import React from "react";
+import type { PartManifest } from "@next-core/brick-manifest";
+
+export default function BrickDocParts({
+  parts,
+}: {
+  parts: PartManifest[];
+}): JSX.Element {
+  return (
+    <table>
+      <thead>
+        <tr>
+          <th>Name</th>
+          <th>Description</th>
+        </tr>
+      </thead>
+      <tbody>
+        {parts.map((part) => (
+          <tr key={part.name}>
+            <td>
+              <code>{part.name}</code>
+            </td>
+            <td>{part.description}</td>
+          </tr>
+        ))}
+      </tbody>
+    </table>
+  );
+}
diff --git a/yarn.lock b/yarn.lock
@@ -1868,17 +1868,17 @@
   resolved "https://registry.yarnpkg.com/@mdx-js/util/-/util-1.6.22.tgz#219dfd89ae5b97a8801f015323ffa4b62f45718b"
   integrity sha512-H1rQc1ZOHANWBvPcW+JpGwr+juXSxM8Q8YCkm3GhZd8REu1fHR3z99CErO1p9pkcfcxZnMdIZdIsXkOHY0NilA==
 
-"@next-core/brick-manifest@^0.5.0":
-  version "0.5.0"
-  resolved "https://registry.yarnpkg.com/@next-core/brick-manifest/-/brick-manifest-0.5.0.tgz#563a963fa22d2e91468d666f08f753b36f3e0ba3"
-  integrity sha512-D9aFMKg2ZRNGoaMowv0JeFVCCTOQqf4gAxPtdKi31Cag7pzWFWpVNuS781VxTTnHmf25XjWZomtNIh71J93m2Q==
+"@next-core/brick-manifest@^0.5.1":
+  version "0.5.1"
+  resolved "https://registry.yarnpkg.com/@next-core/brick-manifest/-/brick-manifest-0.5.1.tgz#446973b6c80b80eae3fe04c766cce8363c1e4210"
+  integrity sha512-+RxfczyqIUJ+FRrOAXdvjP/zxrk1QsPp/uCky12IrOA6dFtmU9LgmWNkl6rCEDjg2d2IH6dSa5isSzxlsj6K9g==
 
-"@next-core/doc-helpers@^0.1.9":
-  version "0.1.9"
-  resolved "https://registry.yarnpkg.com/@next-core/doc-helpers/-/doc-helpers-0.1.9.tgz#12b3847c0c35617e3f393bfd45c7dcc15bb9fc5f"
-  integrity sha512-35R0IZCMzX1H2UayZ7UZTmRll6O9E8KqmmKo0aYExElDV/OAhYMQ1Ir0qckvWrD7GRIxSqdmLUeEtGSU7HMeIw==
+"@next-core/doc-helpers@^0.1.10":
+  version "0.1.10"
+  resolved "https://registry.yarnpkg.com/@next-core/doc-helpers/-/doc-helpers-0.1.10.tgz#1023507add0bbba187f102718b7b9dbe7c4f71a7"
+  integrity sha512-ab24Z7REa2qM+Sk9UQ4jFJ03asjHpl6L3cUDnWoZ7r0EocxX5sGdxyXKYfn+NZfOZV7V4fF1xFCZw0zEhtw0EQ==
   dependencies:
-    "@next-core/brick-manifest" "^0.5.0"
+    "@next-core/brick-manifest" "^0.5.1"
     fast-xml-parser "^4.2.4"
     js-yaml "^3.14.1"
     prettier "^2.8.8"
@@ -1888,10 +1888,10 @@
   resolved "https://registry.yarnpkg.com/@next-core/monaco-contributions/-/monaco-contributions-0.3.1.tgz#cb6fc43aa2dcc8f9afd85827af079bc5394a31b1"
   integrity sha512-ph7+AhO/Lw22husSyPwtyFRIrdMdR0F5ItINmkM3wlpjwgV68zJ15nOIFfJxVM+B1IFR3Gt76lWIkFbUDP33vg==
 
-"@next-core/preview@^0.1.34":
-  version "0.1.34"
-  resolved "https://registry.yarnpkg.com/@next-core/preview/-/preview-0.1.34.tgz#fd24a3f45b2f1efd8cf5ceea81c52e583239f86a"
-  integrity sha512-u/n9OpbUjXvELxVJfnCzFo/iqNCgvUUkfqefaYGRdfXzexyrvzjMsO4ezRnbmLxikD2TRpt8eV48q0boyfjq1g==
+"@next-core/preview@^0.1.35":
+  version "0.1.36"
+  resolved "https://registry.yarnpkg.com/@next-core/preview/-/preview-0.1.36.tgz#c74c7387e2a939209075c021d830b49298879f8f"
+  integrity sha512-CBeuxVvgysTvzBLLIVQV7VIWr6VmzRV2bTR9O+5J1N121/qftekIXN4A21s+G/YJ2zNCbxllfvMJUl7r5XkrAg==
 
 "@node-rs/jieba-android-arm-eabi@1.7.0":
   version "1.7.0"