feat(shadcn): add new registry:file type (#6377)

* feat(shadcn): add new registry:file type * chore: add changeset * fix: file target
shadcn-ui · Jan 16, 2025 · 5f7957a · 5f7957a
1 parent f07c7ad
commit 5f7957a
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 13 deletions.
diff --git a/.changeset/swift-eyes-dress.md b/.changeset/swift-eyes-dress.md
@@ -0,0 +1,5 @@
+---
+"shadcn": minor
+---
+
+new registry:file type
diff --git a/apps/www/lib/registry.ts b/apps/www/lib/registry.ts
@@ -157,7 +157,7 @@ function getFileTarget(file: z.infer<typeof registryItemFileSchema>) {
     }
   }
 
-  return target
+  return target ?? ""
 }
 
 async function createTempSourceFile(filename: string) {

diff --git a/apps/www/public/registry.json b/apps/www/public/registry.json
@@ -14,7 +14,8 @@
         "registry:ui",
         "registry:hook",
         "registry:theme",
-        "registry:page"
+        "registry:page",
+        "registry:file"
       ]
     },
     "description": {

diff --git a/apps/www/public/schema/registry-item.json b/apps/www/public/schema/registry-item.json
@@ -14,7 +14,8 @@
         "registry:ui",
         "registry:hook",
         "registry:theme",
-        "registry:page"
+        "registry:page",
+        "registry:file"
       ]
     },
     "description": {
@@ -64,14 +65,27 @@
               "registry:ui",
               "registry:hook",
               "registry:theme",
-              "registry:page"
+              "registry:page",
+              "registry:file"
             ]
           },
           "target": {
             "type": "string"
           }
         },
-        "required": ["path", "type"]
+        "if": {
+          "properties": {
+            "type": {
+              "enum": ["registry:file", "registry:page"]
+            }
+          }
+        },
+        "then": {
+          "required": ["path", "type", "target"]
+        },
+        "else": {
+          "required": ["path", "type"]
+        }
       }
     },
     "tailwind": {

diff --git a/packages/shadcn/src/registry/schema.ts b/packages/shadcn/src/registry/schema.ts
@@ -9,21 +9,31 @@ export const registryItemTypeSchema = z.enum([
   "registry:component",
   "registry:ui",
   "registry:hook",
-  "registry:theme",
   "registry:page",
+  "registry:file",
 
   // Internal use only
+  "registry:theme",
   "registry:example",
   "registry:style",
   "registry:internal",
 ])
 
-export const registryItemFileSchema = z.object({
-  path: z.string(),
-  content: z.string().optional(),
-  type: registryItemTypeSchema,
-  target: z.string().optional(),
-})
+export const registryItemFileSchema = z.discriminatedUnion("type", [
+  // Target is required for registry:file and registry:page
+  z.object({
+    path: z.string(),
+    content: z.string().optional(),
+    type: z.enum(["registry:file", "registry:page"]),
+    target: z.string(),
+  }),
+  z.object({
+    path: z.string(),
+    content: z.string().optional(),
+    type: registryItemTypeSchema.exclude(["registry:file", "registry:page"]),
+    target: z.string().optional(),
+  }),
+])
 
 export const registryItemTailwindSchema = z.object({
   config: z

diff --git a/packages/shadcn/test/utils/updaters/update-files.test.ts b/packages/shadcn/test/utils/updaters/update-files.test.ts
@@ -79,7 +79,7 @@ describe("resolveFilePath", () => {
       description: "should NOT use src directory for root files",
       file: {
         path: "hello-world/.env",
-        type: "registry:lib",
+        type: "registry:file",
         target: "~/.env",
       },
       resolvedPath: "/foo/bar/.env",
@@ -347,6 +347,26 @@ describe("resolveFilePath", () => {
     ).toBe("/foo/bar/src/hooks/use-foo.ts")
   })
 
+  test("should resolve registry:file file types", () => {
+    expect(
+      resolveFilePath(
+        {
+          path: "hello-world/.env",
+          type: "registry:file",
+          target: "~/baz/.env",
+        },
+        {
+          resolvedPaths: {
+            cwd: "/foo/bar",
+          },
+        },
+        {
+          isSrcDir: false,
+        }
+      )
+    ).toBe("/foo/bar/baz/.env")
+  })
+
   test("should resolve nested files", () => {
     expect(
       resolveFilePath(
-Original file line number
+Diff line change
@@ Expand Up @@
         }
       }
-      return target
+      return target ?? ""
     }
     async function createTempSourceFile(filename: string) {
@@ Expand Down @@