Merge pull request #9903 from shadcn-ui/shadcn/fix-template-scaffold

feat(shadcn): scaffold projects from github remote

Author: shadcn

.changeset/sixty-rice-repair.md

@@ -0,0 +1,5 @@
+---
+"shadcn": patch
+---
+
+scaffold templates from github remote

apps/v4/scripts/build-registry.mts

@@ -22,20 +22,6 @@ import { STYLES } from "@/registry/styles"
 // This is used by the v4 site.
 const WHITELISTED_STYLES = ["new-york-v4"]
 
-// Template directories to archive during build.
-const TEMPLATE_NAMES = [
-  "next-app",
-  "vite-app",
-  "react-router-app",
-  "start-app",
-  "astro-app",
-  "next-monorepo",
-  "vite-monorepo",
-  "react-router-monorepo",
-  "start-monorepo",
-  "astro-monorepo",
-]
-
 // Collect paths for batch prettier formatting at the end.
 const prettierPaths: string[] = []
 
@@ -101,9 +87,6 @@ try {
   console.log("\n⚙️ Building public/r/config.json...")
   await buildConfig()
 
-  console.log("\n📦 Building public/r/templates...")
-  await buildTemplates()
-
   // Copy UI to examples before cleanup.
   console.log("\n📋 Copying UI to examples...")
   await copyUIToExamples()
@@ -746,71 +729,6 @@ async function batchPrettier(paths: string[]) {
   })
 }
 
-async function buildTemplates() {
-  const templatesDir = path.resolve(process.cwd(), "../../templates")
-  const outputDir = path.join(process.cwd(), "public/r/templates")
-  await fs.mkdir(outputDir, { recursive: true })
-
-  await Promise.all(
-    TEMPLATE_NAMES.map(async (name) => {
-      const templatePath = path.join(templatesDir, name)
-
-      // Verify the template directory exists.
-      try {
-        await fs.access(templatePath)
-      } catch {
-        console.log(`   ⚠️ templates/${name} not found, skipping`)
-        return
-      }
-
-      const outputPath = path.join(outputDir, `${name}.tar.gz`)
-
-      await new Promise<void>((resolve, reject) => {
-        const proc = spawn(
-          "tar",
-          [
-            "-czf",
-            outputPath,
-            "--exclude",
-            "node_modules",
-            "--exclude",
-            ".git",
-            "--exclude",
-            "pnpm-lock.yaml",
-            "--exclude",
-            "._*",
-            "-C",
-            templatesDir,
-            name,
-          ],
-          {
-            cwd: process.cwd(),
-            stdio: "pipe",
-            env: { ...process.env, COPYFILE_DISABLE: "1" },
-          }
-        )
-        let stderr = ""
-        proc.stderr?.on("data", (data) => (stderr += data))
-        proc.on("close", (code) => {
-          if (code !== 0) {
-            reject(new Error(`tar exited with code ${code}: ${stderr}`))
-          } else {
-            resolve()
-          }
-        })
-        proc.on("error", reject)
-      })
-
-      // Zero out the gzip mtime header (bytes 4-7) for deterministic output.
-      const buf = await fs.readFile(outputPath)
-      buf[4] = buf[5] = buf[6] = buf[7] = 0
-      await fs.writeFile(outputPath, buf)
-
-      console.log(`   ✅ ${name}.tar.gz`)
-    })
-  )
-}
-
 async function buildColors() {
   const colorsTargetPath = path.join(process.cwd(), "public/r/colors")
   await fs.mkdir(colorsTargetPath, { recursive: true })

packages/shadcn/src/templates/create-template.ts

@@ -1,14 +1,14 @@
 import os from "os"
 import path from "path"
-import { REGISTRY_URL } from "@/src/registry/constants"
 import type { RegistryItem } from "@/src/registry/schema"
 import type { Config } from "@/src/utils/get-config"
 import { handleError } from "@/src/utils/handle-error"
 import { spinner } from "@/src/utils/spinner"
 import { execa } from "execa"
 import fs from "fs-extra"
 
-export const TEMPLATE_BASE_URL = `${REGISTRY_URL}/templates`
+const GITHUB_REPO_URL =
+  process.env.SHADCN_GITHUB_URL ?? "https://github.com/shadcn-ui/ui.git"
 
 export interface TemplateOptions {
   projectPath: string
@@ -99,7 +99,7 @@ export function resolveTemplate(
   return resolved
 }
 
-// Default scaffold that fetches a pre-built template archive.
+// Default scaffold that downloads a template from GitHub.
 function defaultScaffold({
   title,
   templateDir,
@@ -123,24 +123,33 @@ function defaultScaffold({
           filter: (src) => !src.includes("node_modules"),
         })
       } else {
-        // Fetch the pre-built template archive.
+        // Clone only the template directory from GitHub using sparse checkout.
         const templatePath = path.join(
           os.tmpdir(),
           `shadcn-template-${Date.now()}`
         )
-        await fs.ensureDir(templatePath)
-        const response = await fetch(
-          `${TEMPLATE_BASE_URL}/${templateDir}.tar.gz`
+        await execa("git", [
+          "clone",
+          "--depth",
+          "1",
+          "--filter=blob:none",
+          "--sparse",
+          GITHUB_REPO_URL,
+          templatePath,
+        ])
+        await execa("git", [
+          "-C",
+          templatePath,
+          "sparse-checkout",
+          "set",
+          `templates/${templateDir}`,
+        ])
+
+        const extractedPath = path.resolve(
+          templatePath,
+          "templates",
+          templateDir
         )
-        if (!response.ok) {
-          throw new Error(`Failed to download template: ${response.statusText}`)
-        }
-
-        // Write and extract the tar file.
-        const tarPath = path.resolve(templatePath, "template.tar.gz")
-        await fs.writeFile(tarPath, Buffer.from(await response.arrayBuffer()))
-        await execa("tar", ["-xzf", tarPath, "-C", templatePath])
-        const extractedPath = path.resolve(templatePath, templateDir)
         await fs.move(extractedPath, projectPath)
         await fs.remove(templatePath)
       }

packages/shadcn/src/templates/index.ts

@@ -5,11 +5,7 @@ import { reactRouter } from "./react-router"
 import { start } from "./start"
 import { vite } from "./vite"
 
-export {
-  createTemplate,
-  resolveTemplate,
-  TEMPLATE_BASE_URL,
-} from "./create-template"
+export { createTemplate, resolveTemplate } from "./create-template"
 export type { TemplateInitOptions, TemplateOptions } from "./create-template"
 
 export const templates = {

packages/shadcn/src/utils/create-project.test.ts

@@ -44,7 +44,7 @@ describe("createProject", () => {
     vi.mocked(fs.move).mockResolvedValue(undefined)
     vi.mocked(fs.remove).mockResolvedValue(undefined)
 
-    // Mock execa for template scaffold commands.
+    // Mock execa for git clone and package manager install.
     vi.mocked(execa).mockResolvedValue({
       stdout: "",
       stderr: "",
@@ -59,12 +59,6 @@ describe("createProject", () => {
       killed: false,
     } as any)
 
-    // Mock fetch for template download.
-    global.fetch = vi.fn().mockResolvedValue({
-      ok: true,
-      arrayBuffer: () => Promise.resolve(new ArrayBuffer(0)),
-    } as any)
-
     // Reset prompts mock
     vi.mocked(prompts).mockResolvedValue({ type: "next", name: "my-app" })
 
@@ -96,7 +90,6 @@ describe("createProject", () => {
   afterEach(() => {
     vi.resetAllMocks()
     mockExit?.mockRestore()
-    delete (global as any).fetch
   })
 
   it("should create a Next.js project with default options", async () => {