@next-core/build-next-bricks 1.13.6 → 1.14.0

package/bin/build-next-bricks.js

@@ -55,6 +55,10 @@ try {
           path.join(distDir, "types.json"),
           JSON.stringify(config.types, null, 2)
         );
+        await writeFile(
+          path.join(distDir, "examples.json"),
+          JSON.stringify(config.examples, null, 2)
+        );
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-core/build-next-bricks",
-  "version": "1.13.6",
+  "version": "1.14.0",
   "description": "Build next bricks",
   "homepage": "https://github.com/easyops-cn/next-core/tree/v3/packages/build-next-bricks",
   "license": "GPL-3.0",
@@ -51,5 +51,5 @@
   "devDependencies": {
     "@next-core/brick-manifest": "^0.5.1"
   },
-  "gitHead": "ad9c309ab3cc264f9ae8b913aeb7e64448a974ca"
+  "gitHead": "479c966531db9a58feb3f6e0ccc255ff90a91549"
 }

package/src/EmitBricksJsonPlugin.js

@@ -8,7 +8,7 @@ const pluginName = "EmitBricksJsonPlugin";
 
 export default class EmitBricksJsonPlugin {
   /**
-   * @param {{ packageName: string; bricks: string[]; processors: string[]; dependencies: Record<string, string[]>; manifest: PackageManifest; }} options
+   * @param {{ packageName: string; bricks: string[]; processors: string[]; dependencies: Record<string, string[]>; manifest: PackageManifest; examples: Record<string, {doc: string}> }} options
    */
   constructor(options) {
     this.packageName = options.packageName;
@@ -18,6 +18,7 @@ export default class EmitBricksJsonPlugin {
     this.dependencies = options.dependencies;
     this.manifest = options.manifest;
     this.types = options.types;
+    this.examples = options.examples;
   }
 
   /**
@@ -78,6 +79,12 @@ export default class EmitBricksJsonPlugin {
             new webpack.sources.RawSource(typesJson, false)
           );
 
+          const examplesJson = JSON.stringify(this.examples, null, 2);
+          compilation.emitAsset(
+            "examples.json",
+            new webpack.sources.RawSource(examplesJson, false)
+          );
+
           console.log("Defined bricks:", this.bricks);
           console.log("Defined elements:", this.elements);
           console.log("Defined processors:", this.processors);

package/src/build.js

@@ -452,6 +452,7 @@ async function getWebpackConfig(config) {
               dependencies: config.dependencies,
               manifest: config.manifest,
               types: config.types,
+              examples: config.examples,
             }),
           ]
         : []),

package/src/getDocs.js

@@ -0,0 +1,45 @@
+import {
+  extractExamplesInMarkdown,
+  htmlToYaml,
+  yamlToHtml,
+  htmlTagEntity,
+} from "@next-core/doc-helpers";
+
+const YAML_DELIMITER = "# -- YAML DELIMITER (1nbbm8) --";
+const HTML_DELIMITER_START = "<!-- HTML DELIMITER start (1nbbm8) --";
+const HTML_DELIMITER_END = "-- HTML DELIMITER end (1nbbm8) -->";
+
+/**
+ * @param {string} markdown
+ * @param {import("@next-core/brick-manifest").PackageManifest[]} manifests
+ */
+export function handleExamplesInMarkdown(markdown, manifests) {
+  const examples = extractExamplesInMarkdown(markdown, "");
+  let cursor = 0;
+  const chunks = [];
+  for (const example of examples) {
+    const nextCursor = example.codeIndex + example.code.length;
+    chunks.push(markdown.substring(cursor, nextCursor));
+    if (example.mode === "yaml") {
+      const html = yamlToHtml(example.code, manifests);
+      chunks.push(
+        `${YAML_DELIMITER}\n`,
+        html
+          .split("\n")
+          .map((line) => `# ${line}`)
+          .join("\n"),
+        "\n"
+      );
+    } else {
+      const yaml = htmlToYaml(example.code, manifests);
+      chunks.push(
+        `${HTML_DELIMITER_START}\n`,
+        htmlTagEntity(yaml),
+        `\n${HTML_DELIMITER_END}\n`
+      );
+    }
+    cursor = nextCursor;
+  }
+  chunks.push(markdown.substring(cursor));
+  return chunks.join("");
+}

package/src/scanBricks.js

@@ -15,6 +15,7 @@ import {
 } from "@babel/types";
 import getTypeDeclaration from "./getTypeDeclaration.js";
 import isDeprecatedV2Packages from "./isDeprecatedV2Packages.js";
+import { handleExamplesInMarkdown } from "./getDocs.js";
 
 /**
  *
@@ -40,7 +41,7 @@ const validExposeName = /^[-\w]+$/;
  * Scan defined bricks by AST.
  *
  * @param {string} packageDir
- * @returns {Promise<{exposes: Exposes; dependencies: Record<string, string[]>; manifest: PackageManifest; types: Record<string, unknown>}>}
+ * @returns {Promise<{exposes: Exposes; dependencies: Record<string, string[]>; manifest: PackageManifest; types: Record<string, unknown>; examples: Record<string, {doc: string}>}>}
  */
 export default async function scanBricks(packageDir) {
   /** @type {Map<string, Expose>} */
@@ -839,6 +840,36 @@ export default async function scanBricks(packageDir) {
     delete providerDoc.usedReferences;
   }
 
+  /** @type {Record<string, {doc: string}>} */
+  const examples = {};
+  const srcDocsDir = path.join(packageDir, "docs");
+
+  for (const brick of manifest.bricks.concat(manifest.providers ?? [])) {
+    const lastName = brick.name.split(".").pop();
+
+    const srcFilePath = path.join(srcDocsDir, `${brick.name}.md`);
+    const srcFilePathAlt = path.join(srcDocsDir, `${lastName}.md`);
+
+    /** @type {string} */
+    let brickDoc;
+    if (existsSync(srcFilePath)) {
+      brickDoc = handleExamplesInMarkdown(
+        await readFile(srcFilePath, "utf-8"),
+        [manifest]
+      );
+    } else if (existsSync(srcFilePathAlt)) {
+      brickDoc = handleExamplesInMarkdown(
+        await readFile(srcFilePathAlt, "utf-8"),
+        [manifest]
+      );
+    }
+    if (brickDoc) {
+      examples[brick.name] = {
+        doc: brickDoc,
+      };
+    }
+  }
+
   // console.log("exposes:", exposes);
 
   return {
@@ -871,5 +902,6 @@ export default async function scanBricks(packageDir) {
           ])
         )
     ),
+    examples,
   };
 }