@next-core/yo 1.2.7 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-core/yo",
-  "version": "1.2.7",
+  "version": "1.4.0",
   "description": "Generator for next v3",
   "homepage": "https://github.com/easyops-cn/next-core/tree/v3/packages/yo",
   "license": "GPL-3.0",
@@ -24,14 +24,14 @@
     "plop": "^3.1.2"
   },
   "devDependencies": {
-    "@next-core/build-next-bricks": "^1.11.1",
+    "@next-core/build-next-bricks": "^1.13.0",
     "@next-core/build-next-libs": "^1.0.5",
-    "@next-core/element": "^1.0.6",
+    "@next-core/element": "^1.1.0",
     "@next-core/i18n": "^1.0.21",
-    "@next-core/react-element": "^1.0.7",
+    "@next-core/react-element": "^1.0.8",
     "@next-core/test-next": "^1.0.6",
     "@next-core/theme": "^1.1.1",
     "react": "0.0.0-experimental-ee8509801-20230117"
   },
-  "gitHead": "cdd45da473b22e9f884bcbf2f956b4fc564ab2fd"
+  "gitHead": "06fca79a3a3b63a995d92729cfbed8e312cfdccd"
 }

package/src/plopfile.js

@@ -1,6 +1,6 @@
 import path from "node:path";
 import { existsSync } from "node:fs";
-import { readFile, readdir } from "node:fs/promises";
+import { readFile, readdir, writeFile } from "node:fs/promises";
 import { fileURLToPath } from "node:url";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -64,6 +64,25 @@ export default function (
     "libDevDependencies",
     getObjectPartialInPackageJson(libDevDependencies)
   );
+  plop.setHelper("getTagName", (brickType, pkgName, brickName, lastNameOnly) =>
+    brickType === "common"
+      ? `eo-${brickName}`
+      : lastNameOnly
+      ? brickName
+      : `${pkgName}.${brickName}`
+  );
+  plop.setPartial(
+    "tagName",
+    "{{getTagName brickType pkgName brickName false}}"
+  );
+  plop.setPartial(
+    "lastTagName",
+    "{{getTagName brickType pkgName brickName true}}"
+  );
+  plop.setPartial(
+    "className",
+    "{{pascalCase (getTagName brickType pkgName brickName true)}}"
+  );
 
   // create your generators here
   plop.setGenerator("basics", {
@@ -153,6 +172,24 @@ export default function (
           return true;
         },
       },
+      {
+        type: "list",
+        name: "brickType",
+        message: "Select your brick type:",
+        when(data) {
+          return data.type === "brick";
+        },
+        choices: [
+          {
+            name: "Business-specific brick (starts with namespace)",
+            value: "specific",
+          },
+          {
+            name: "Common brick (starts with `eo-`, no namespace)",
+            value: "common",
+          },
+        ],
+      },
       {
         type: "input",
         name: "brickName",
@@ -160,17 +197,41 @@ export default function (
         when(data) {
           return data.type === "brick";
         },
-        validate(value, data) {
-          if (!validBrickName.test(value)) {
+        async validate(value, data) {
+          const realBrickName =
+            data.brickType === "common" ? `eo-${value}` : value;
+          if (!validBrickName.test(realBrickName)) {
             return "Please enter a lower-kebab-case brick name.";
           }
 
           if (existsSync(path.join(bricksDir, data.pkgName, "src", value))) {
-            return `Brick "${value}" seems to be existed, please enter another name.`;
+            return `Brick "${realBrickName}" seems to be existed, please enter another name.`;
+          }
+
+          const commonBricksJsonFile = path.join(
+            rootDir,
+            "shared/common-bricks/common-bricks.json"
+          );
+          if (data.brickType === "common" && existsSync(commonBricksJsonFile)) {
+            const commonBricksJson = JSON.parse(
+              await readFile(commonBricksJsonFile, "utf-8")
+            );
+            for (const [pkg, commonBricks] of Object.entries(
+              commonBricksJson
+            )) {
+              if (commonBricks.includes(realBrickName)) {
+                return `Brick "${realBrickName}" existed in package "${pkg}", please enter another name.`;
+              }
+            }
           }
 
           return true;
         },
+        transformer(input, data) {
+          return data.brickType === "common"
+            ? `eo-${input}`
+            : `${data.pkgName}.${input}`;
+        },
       },
       {
         type: "input",
@@ -199,6 +260,9 @@ export default function (
 
           return true;
         },
+        transformer(input, data) {
+          return `${data.pkgName}.${input}`;
+        },
       },
     ],
     actions(data) {
@@ -218,9 +282,49 @@ export default function (
           },
           {
             type: "add",
-            path: "bricks/{{pkgName}}/docs/{{brickName}}.md",
+            path: "bricks/{{pkgName}}/docs/{{>lastTagName}}.md",
             templateFile: "templates/brick.md.hbs",
           },
+          async function modifyCommonBricksJson(answers) {
+            if (answers.brickType === "common") {
+              const realBrickName = `eo-${answers.brickName}`;
+              const commonBricksJsonFile = path.join(
+                rootDir,
+                "shared/common-bricks/common-bricks.json"
+              );
+              /** @type {Record<string, string[]>} */
+              let commonBricksJson;
+              /** @type {string[]} */
+              let commonBricks;
+              if (existsSync(commonBricksJsonFile)) {
+                commonBricksJson = JSON.parse(
+                  await readFile(commonBricksJsonFile, "utf-8")
+                );
+                if (
+                  Object.prototype.hasOwnProperty.call(
+                    commonBricksJson,
+                    answers.pkgName
+                  )
+                ) {
+                  commonBricks = commonBricksJson[answers.pkgName];
+                } else {
+                  commonBricks = commonBricksJson[answers.pkgName] = [];
+                }
+              } else {
+                commonBricksJson = {};
+                commonBricks = commonBricksJson[answers.pkgName] = [];
+              }
+              commonBricks.push(realBrickName);
+              await writeFile(
+                commonBricksJsonFile,
+                JSON.stringify(commonBricksJson, null, 2)
+              );
+              return plop.renderString(
+                `added {{pkgName}}: ${realBrickName} in /shared/common-bricks/common-bricks.json`,
+                answers
+              );
+            }
+          },
         ];
       } else if (data.type === "provider") {
         return [

package/src/templates/brick/i18n.ts

@@ -9,7 +9,7 @@ const zh: Locale = {
   // HELLO: "你好",
 };
 
-export const NS = "bricks/{{pkgName}}/{{brickName}}";
+export const NS = "bricks/{{pkgName}}/{{>lastTagName}}";
 
 export const locales = { en, zh };
 

package/src/templates/brick/index.spec.tsx.hbs

@@ -1,13 +1,13 @@
 import { describe, test, expect, jest } from "@jest/globals";
 import { act } from "react-dom/test-utils";
 import "./";
-import { {{pascalCase brickName}} } from "./index.js";
+import { {{>className}} } from "./index.js";
 
 jest.mock("@next-core/theme", () => ({}));
 
-describe("{{pkgName}}.{{brickName}}", () => {
+describe("{{>tagName}}", () => {
   test("basic usage", async () => {
-    const element = document.createElement("{{pkgName}}.{{brickName}}") as {{pascalCase brickName}};
+    const element = document.createElement("{{>tagName}}") as {{>className}};
 
     expect(element.shadowRoot).toBeFalsy();
 

package/src/templates/brick/index.tsx.hbs

@@ -12,21 +12,21 @@ import styleText from "./styles.shadow.css";
 const { defineElement, property } = createDecorators();
 
 /**
- * 构件 {{brickName}}
+ * 构件 `{{>tagName}}`
  */
 export
-@defineElement("{{pkgName}}.{{brickName}}", {
+@defineElement("{{>tagName}}", {
   styleTexts: [styleText],
 })
-class {{pascalCase brickName}} extends ReactNextElement {
+class {{>className}} extends ReactNextElement {
   render() {
     return (
-      <{{pascalCase brickName}}Component />
+      <{{>className}}Component />
     );
   }
 }
 
-export function {{pascalCase brickName}}Component() {
+export function {{>className}}Component() {
   // const { t } = useTranslation(NS);
   // const hello = t(K.HELLO);
   return <div>It works!</div>;

package/src/templates/brick.md.hbs

@@ -1,9 +1,9 @@
-构件 {{brickName}}
+构件 `{{>tagName}}`
 
 ## Examples
 
 ### Basic
 
 ```html preview
-<{{pkgName}}.{{brickName}}>Hello world</{{pkgName}}.{{brickName}}>
+<{{>tagName}}>Hello world</{{>tagName}}>
 ```