fix(cli): add resource generating invalid react component name (refin…

…edev#6226) Co-authored-by: Ali Emir Şen <senaliemir@gmail.com>
YusukeSano · Aug 5, 2024 · 9806a36 · 9806a36
1 parent 4e37590
commit 9806a36
Show file tree

Hide file tree

Showing 14 changed files with 148 additions and 38 deletions.
diff --git a/.changeset/odd-squids-invite.md b/.changeset/odd-squids-invite.md
@@ -0,0 +1,14 @@
+---
+"@refinedev/cli": patch
+---
+
+fix: `refine add resource` generating invalid React component name. #6225
+
+`refine add resource blog-posts` command was generating invalid React component name when the resource name contains a hyphen. This issue has been fixed by converting the resource name to PascalCase before generating the React component name.
+
+```diff
+- export const Blog-PostsList: React.FC = () => {};
++ export const BlogPostsList: React.FC = () => {};
+```
+
+[Resolves #6225](https://github.com/refinedev/refine/issues/6225)
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -36,6 +36,7 @@
     "@npmcli/package-json": "^5.2.0",
     "@refinedev/devtools-server": "1.1.34",
     "boxen": "^5.1.2",
+    "camelcase": "^6.2.0",
     "cardinal": "^2.1.1",
     "center-align": "1.0.1",
     "chalk": "^4.1.2",

diff --git a/packages/cli/src/commands/add/sub-commands/resource/index.test.ts b/packages/cli/src/commands/add/sub-commands/resource/index.test.ts
@@ -6,7 +6,10 @@ import { existsSync, readFileSync, rmdirSync } from "fs-extra";
 const srcDirPath = `${__dirname}/../../../..`;
 
 describe("add", () => {
-  beforeEach(() => {
+  beforeAll(() => {
+    // usefull for speed up the tests.
+    jest.spyOn(console, "log").mockImplementation();
+
     jest.spyOn(testTargetModule, "installInferencer").mockImplementation();
   });
 
@@ -84,4 +87,76 @@ describe("add", () => {
     // cleanup
     rmdirSync(reactComponentRootDirPath, { recursive: true });
   });
+
+  it.each([
+    {
+      resourceName: "blog-posts",
+      folderName: "blog-posts",
+      componentNamesByActions: {
+        list: "BlogPostsList",
+        create: "BlogPostsCreate",
+        show: "BlogPostsShow",
+        edit: "BlogPostsEdit",
+      },
+    },
+    {
+      resourceName: "blog-post",
+      folderName: "blog-posts",
+      componentNamesByActions: {
+        list: "BlogPostList",
+        create: "BlogPostCreate",
+        show: "BlogPostShow",
+        edit: "BlogPostEdit",
+      },
+    },
+    {
+      resourceName: "product",
+      folderName: "products",
+      componentNamesByActions: {
+        list: "ProductList",
+        create: "ProductCreate",
+        show: "ProductShow",
+        edit: "ProductEdit",
+      },
+    },
+    {
+      resourceName: "blogPosts",
+      folderName: "blogposts",
+      componentNamesByActions: {
+        list: "BlogPostsList",
+        create: "BlogPostsCreate",
+        show: "BlogPostsShow",
+        edit: "BlogPostsEdit",
+      },
+    },
+  ])(
+    "should generate components and folders for '$resourceName'",
+    (testCase) => {
+      jest
+        .spyOn(utilsProject, "getProjectType")
+        .mockReturnValue(ProjectTypes.VITE);
+
+      jest
+        .spyOn(testTargetModule, "getCommandRootDir")
+        .mockReturnValue(srcDirPath);
+
+      const actions = ["list", "create", "show", "edit"] as const;
+      testTargetModule.createResources({ actions: actions.join(",") }, [
+        testCase.resourceName,
+      ]);
+
+      const reactComponentRootDirPath = `${srcDirPath}/pages`;
+
+      actions.forEach((action) => {
+        const componentFilePath = `${reactComponentRootDirPath}/${testCase.folderName}/${action}.tsx`;
+        const componentContent = readFileSync(componentFilePath, "utf-8");
+        expect(componentContent).toContain(
+          `const ${testCase.componentNamesByActions[action]} = () => {`,
+        );
+      });
+
+      // cleanup
+      rmdirSync(reactComponentRootDirPath, { recursive: true });
+    },
+  );
 });
diff --git a/packages/cli/src/utils/compile/index.ts b/packages/cli/src/utils/compile/index.ts
@@ -6,6 +6,7 @@ import {
   writeFileSync,
   unlinkSync,
 } from "fs-extra";
+import { getComponentNameByResource } from "@utils/resource";
 
 export const compile = (filePath: string, params: any): string => {
   const content = readFileSync(filePath);
@@ -39,6 +40,14 @@ export const compile = (filePath: string, params: any): string => {
     return string.charAt(0).toUpperCase() + string.slice(1);
   });
 
+  Handlebars.registerHelper("getComponentNameByResource", (string) => {
+    if (!string) {
+      return;
+    }
+
+    return getComponentNameByResource(string);
+  });
+
   const template = Handlebars.compile(content.toString());
   return template(params);
 };

diff --git a/packages/cli/src/utils/resource/index.ts b/packages/cli/src/utils/resource/index.ts
@@ -1,4 +1,5 @@
 import { ProjectTypes } from "@definitions/projectTypes";
+import camelCase from "camelcase";
 
 export const getResourcePath = (
   projectType: ProjectTypes,
@@ -54,3 +55,10 @@ export const getFilesPathByProject = (projectType?: ProjectTypes) => {
       return "./src";
   }
 };
+
+export const getComponentNameByResource = (resource: string): string => {
+  return camelCase(resource, {
+    preserveConsecutiveUppercase: true,
+    pascalCase: true,
+  });
+};
diff --git a/packages/cli/templates/resource/components/create.tsx.hbs b/packages/cli/templates/resource/components/create.tsx.hbs
@@ -8,7 +8,7 @@ import { {{formatInferencerComponent uiFramework}}Inferencer } from "@refinedev/
 import { HeadlessInferencer } from "@refinedev/inferencer/headless";
 {{/if}}
 
-export const {{capitalize resource}}Create = () => {
+export const {{getComponentNameByResource resource}}Create = () => {
     {{#if uiFramework}}
     return <{{formatInferencerComponent uiFramework}}Inferencer />;
     {{else}}

diff --git a/packages/cli/templates/resource/components/edit.tsx.hbs b/packages/cli/templates/resource/components/edit.tsx.hbs
@@ -8,7 +8,7 @@ import { {{formatInferencerComponent uiFramework}}Inferencer } from "@refinedev/
 import { HeadlessInferencer } from "@refinedev/inferencer/headless";
 {{/if}}
 
-export const {{capitalize resource}}Edit = () => {
+export const {{getComponentNameByResource resource}}Edit = () => {
     {{#if uiFramework}}
     return <{{formatInferencerComponent uiFramework}}Inferencer />;
     {{else}}

diff --git a/packages/cli/templates/resource/components/list.tsx.hbs b/packages/cli/templates/resource/components/list.tsx.hbs
@@ -8,7 +8,7 @@ import { {{formatInferencerComponent uiFramework}}Inferencer } from "@refinedev/
 import { HeadlessInferencer } from "@refinedev/inferencer/headless";
 {{/if}}
 
-export const {{capitalize resource}}List = () => {
+export const {{getComponentNameByResource resource}}List = () => {
     {{#if uiFramework}}
     return <{{formatInferencerComponent uiFramework}}Inferencer />;
     {{else}}

diff --git a/packages/cli/templates/resource/components/show.tsx.hbs b/packages/cli/templates/resource/components/show.tsx.hbs
@@ -8,7 +8,7 @@ import { {{formatInferencerComponent uiFramework}}Inferencer } from "@refinedev/
 import { HeadlessInferencer } from "@refinedev/inferencer/headless";
 {{/if}}
 
-export const {{capitalize resource}}Show = () => {
+export const {{getComponentNameByResource resource}}Show = () => {
     {{#if uiFramework}}
     return <{{formatInferencerComponent uiFramework}}Inferencer />;
     {{else}}

diff --git a/packages/cli/templates/resource/pages/next/create/page.tsx.hbs b/packages/cli/templates/resource/pages/next/create/page.tsx.hbs
@@ -1,5 +1,5 @@
-import { {{capitalize resource}}Create } from "@components/{{resourceFolderName}}";
+import { {{getComponentNameByResource resource}}Create } from "@components/{{resourceFolderName}}";
 
-export default function {{capitalize resource}}CreatePage() {
-    return <{{capitalize resource}}Create />;
+export default function {{getComponentNameByResource resource}}CreatePage() {
+    return <{{getComponentNameByResource resource}}Create />;
 };
diff --git a/packages/cli/templates/resource/pages/next/edit/[id]/page.tsx.hbs b/packages/cli/templates/resource/pages/next/edit/[id]/page.tsx.hbs
@@ -1,5 +1,5 @@
-import { {{capitalize resource}}Edit } from "@components/{{resourceFolderName}}";
+import { {{getComponentNameByResource resource}}Edit } from "@components/{{resourceFolderName}}";
 
-export default function {{capitalize resource}}EditPage() {
-    return <{{capitalize resource}}Edit />;
+export default function {{getComponentNameByResource resource}}EditPage() {
+    return <{{getComponentNameByResource resource}}Edit />;
 };
diff --git a/packages/cli/templates/resource/pages/next/page.tsx.hbs b/packages/cli/templates/resource/pages/next/page.tsx.hbs
@@ -1,5 +1,5 @@
-import { {{capitalize resource}}List } from "@components/{{resourceFolderName}}";
+import { {{getComponentNameByResource resource}}List } from "@components/{{resourceFolderName}}";
 
-export default function {{capitalize resource}}ListPage() {
-    return <{{capitalize resource}}List />;
+export default function {{getComponentNameByResource resource}}ListPage() {
+    return <{{getComponentNameByResource resource}}List />;
 };
diff --git a/packages/cli/templates/resource/pages/next/show/[id]/page.tsx.hbs b/packages/cli/templates/resource/pages/next/show/[id]/page.tsx.hbs
@@ -1,5 +1,5 @@
-import { {{capitalize resource}}Show } from "@components/{{resourceFolderName}}";
+import { {{getComponentNameByResource resource}}Show } from "@components/{{resourceFolderName}}";
 
-export default function {{capitalize resource}}ShowPage() {
-    return <{{capitalize resource}}Show />;
+export default function {{getComponentNameByResource resource}}ShowPage() {
+    return <{{getComponentNameByResource resource}}Show />;
 };
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml