create-puck-app 0.12.0-canary.c85f82f → 0.12.0-canary.da2bc0f

package/index.js

@@ -103,7 +103,7 @@ program
       return;
     }
 
-    await fs.mkdirSync(appName);
+    fs.mkdirSync(appName);
 
     const packageManager = !!options.useNpm
       ? "npm"
@@ -130,7 +130,7 @@ program
       let data;
 
       if (path.extname(filePath) === ".hbs") {
-        const templateString = await fs.readFileSync(filePath, "utf-8");
+        const templateString = fs.readFileSync(filePath, "utf-8");
 
         const template = Handlebars.compile(templateString);
         data = template({
@@ -139,14 +139,14 @@ program
           puckVersion: `^${packageJson.version}`,
         });
       } else {
-        data = await fs.readFileSync(filePath, "utf-8");
+        data = fs.readFileSync(filePath, "utf-8");
       }
 
       const dir = path.dirname(targetPath);
 
-      await fs.mkdirSync(dir, { recursive: true });
+      fs.mkdirSync(dir, { recursive: true });
 
-      await fs.writeFileSync(targetPath, data);
+      fs.writeFileSync(targetPath, data);
     }
 
     if (packageManager === "yarn") {
@@ -159,22 +159,24 @@ program
 
     try {
       inGitRepo =
-        execSync("git status", {
-          cwd: appPath,
-        })
+        execSync("git status", { cwd: appPath })
           .toString()
           .indexOf("fatal:") !== 0;
     } catch {}
 
     // Only commit if this is a new repo
     if (!inGitRepo) {
-      execSync("git init", { cwd: appPath, stdio: "inherit" });
+      try {
+        execSync("git init", { cwd: appPath, stdio: "inherit" });
 
-      execSync("git add .", { cwd: appPath, stdio: "inherit" });
-      execSync("git commit -m 'build(puck): generate app'", {
-        cwd: appPath,
-        stdio: "inherit",
-      });
+        execSync("git add .", { cwd: appPath, stdio: "inherit" });
+        execSync('git commit -m "build(puck): generate app"', {
+          cwd: appPath,
+          stdio: "inherit",
+        });
+      } catch (error) {
+        console.log("Failed to commit git changes");
+      }
     }
   })
   .parse(process.argv);

package/package.json

@@ -1,15 +1,21 @@
 {
   "name": "create-puck-app",
-  "version": "0.12.0-canary.c85f82f",
+  "version": "0.12.0-canary.da2bc0f",
   "private": false,
   "license": "MIT",
   "type": "module",
   "bin": {
     "create-puck-app": "./index.js"
   },
+  "files": [
+    "templates",
+    "index.js"
+  ],
   "scripts": {
     "generate": "node scripts/generate.js",
-    "prepublishOnly": "yarn generate"
+    "prepublishOnly": "yarn generate",
+    "removeGitignore": "mv templates/.gitignore templates/gitignore",
+    "restoreGitignore": "mv templates/gitignore templates/.gitignore"
   },
   "dependencies": {
     "commander": "^10.0.1",

package/templates/gitignore

@@ -0,0 +1,8 @@
+# # Ignore everything
+*.*
+
+# # Explicitly ignore gitignore without extension
+gitignore
+
+# # Except for handlebars files
+!*.hbs

package/templates/next/.eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  root: true,
+  extends: ["custom"],
+};

package/templates/next/app/[...puckPath]/client.tsx

@@ -0,0 +1,9 @@
+"use client";
+
+import type { Data } from "@measured/puck";
+import { Render } from "@measured/puck";
+import config from "../../puck.config";
+
+export function Client({ data }: { data: Data }) {
+  return <Render config={config} data={data} />;
+}

package/templates/next/app/[...puckPath]/page.tsx

@@ -0,0 +1,47 @@
+/**
+ * This file implements a catch-all route that renders the user-facing pages
+ * generated by Puck. For any route visited (with exception of other hardcoded
+ * pages in /app), it will check your database (via `getPage`) for a Puck page
+ * and render it using <Render>.
+ *
+ * All routes produced by this page are statically rendered using incremental
+ * static site generation. After the first visit, the page will be cached as
+ * a static file. Subsequent visits will receive the cache. Publishing a page
+ * will invalidate the cache as the page is written in /api/puck/route.ts
+ */
+
+import { Client } from "./client";
+import { notFound } from "next/navigation";
+import { Metadata } from "next";
+import { getPage } from "../../lib/get-page";
+
+export async function generateMetadata({
+  params: { puckPath = [] },
+}: {
+  params: { puckPath: string[] };
+}): Promise<Metadata> {
+  const path = `/${puckPath.join("/")}`;
+
+  return {
+    title: getPage(path)?.root.title,
+  };
+}
+
+export default async function Page({
+  params: { puckPath = [] },
+}: {
+  params: { puckPath: string[] };
+}) {
+  const path = `/${puckPath.join("/")}`;
+  const data = getPage(path);
+
+  if (!data) {
+    return notFound();
+  }
+
+  return <Client data={data} />;
+}
+
+// Force Next.js to produce static pages: https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config#dynamic
+// Delete this if you need dynamic rendering, such as access to headers or cookies
+export const dynamic = "force-static";

package/templates/next/app/layout.tsx

@@ -0,0 +1,14 @@
+import "@measured/puck/puck.css";
+import "./styles.css";
+
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  return (
+    <html lang="en">
+      <body>{children}</body>
+    </html>
+  );
+}

package/templates/next/app/page.tsx

@@ -0,0 +1 @@
+export { default, generateMetadata } from "./[...puckPath]/page";

package/templates/next/app/puck/[...puckPath]/client.tsx

@@ -0,0 +1,20 @@
+"use client";
+
+import type { Data } from "@measured/puck";
+import { Puck } from "@measured/puck";
+import config from "../../../puck.config";
+
+export function Client({ path, data }: { path: string; data: Data }) {
+  return (
+    <Puck
+      config={config}
+      data={data}
+      onPublish={async (data: Data) => {
+        await fetch("/puck/api", {
+          method: "post",
+          body: JSON.stringify({ data, path }),
+        });
+      }}
+    />
+  );
+}

package/templates/next/app/puck/[...puckPath]/page.tsx

@@ -0,0 +1,39 @@
+/**
+ * This file implements a *magic* catch-all route that renders the Puck editor.
+ *
+ * This route exposes /puck/[...puckPath], but is disabled by middleware.ts. The middleware
+ * then rewrites all URL requests ending in `/edit` to this route, allowing you to visit any
+ * page in your application and add /edit to the end to spin up a Puck editor.
+ *
+ * This approach enables public pages to be statically rendered whilst the /puck route can
+ * remain dynamic.
+ *
+ * NB this route is public, and you will need to add authentication
+ */
+
+import { Client } from "./client";
+import { Metadata } from "next";
+import { getPage } from "../../../lib/get-page";
+
+export async function generateMetadata({
+  params: { puckPath = [] },
+}: {
+  params: { puckPath: string[] };
+}): Promise<Metadata> {
+  const path = `/${puckPath.join("/")}`;
+
+  return {
+    title: "Puck: " + path,
+  };
+}
+
+export default async function Page({
+  params: { puckPath = [] },
+}: {
+  params: { puckPath: string[] };
+}) {
+  const path = `/${puckPath.join("/")}`;
+  const data = getPage(path);
+
+  return <Client path={path} data={data} />;
+}

package/templates/next/app/puck/api/route.ts

@@ -0,0 +1,25 @@
+import { revalidatePath } from "next/cache";
+import { NextResponse } from "next/server";
+import fs from "fs";
+
+export async function POST(request: Request) {
+  const payload = await request.json();
+
+  const existingData = JSON.parse(
+    fs.existsSync("database.json")
+      ? fs.readFileSync("database.json", "utf-8")
+      : "{}"
+  );
+
+  const updatedData = {
+    ...existingData,
+    [payload.path]: payload.data,
+  };
+
+  fs.writeFileSync("database.json", JSON.stringify(updatedData));
+
+  // Purge Next.js cache
+  revalidatePath(payload.path);
+
+  return NextResponse.json({ status: "ok" });
+}

package/templates/next/app/puck/page.tsx

@@ -0,0 +1 @@
+export { default, generateMetadata } from "./[...puckPath]/page";

package/templates/next/app/styles.css

@@ -0,0 +1,5 @@
+html,
+body {
+  margin: 0;
+  padding: 0;
+}

package/templates/next/database.json

@@ -0,0 +1 @@
+{"/":{"content":[{"type":"HeadingBlock","props":{"title":"Edit this page by adding /edit to the end of the URL","id":"HeadingBlock-1694032984497"}}],"root":{"props": {"title":""}}}}

package/templates/next/gitignore

@@ -0,0 +1,34 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# vercel
+.vercel

package/templates/next/lib/get-page.ts

@@ -0,0 +1,11 @@
+import { Data } from "@measured/puck";
+import fs from "fs";
+
+// Replace with call to your database
+export const getPage = (path: string) => {
+  const allData: Record<string, Data> | null = fs.existsSync("database.json")
+    ? JSON.parse(fs.readFileSync("database.json", "utf-8"))
+    : null;
+
+  return allData ? allData[path] : null;
+};

package/templates/next/middleware.ts

@@ -0,0 +1,27 @@
+import { NextResponse } from "next/server";
+
+import type { NextRequest } from "next/server";
+
+export async function middleware(req: NextRequest) {
+  const res = NextResponse.next();
+
+  if (req.method === "GET") {
+    // Rewrite routes that match "/[...puckPath]/edit" to "/puck/[...puckPath]"
+    if (req.nextUrl.pathname.endsWith("/edit")) {
+      const pathWithoutEdit = req.nextUrl.pathname.slice(
+        0,
+        req.nextUrl.pathname.length - 5
+      );
+      const pathWithEditPrefix = `/puck${pathWithoutEdit}`;
+
+      return NextResponse.rewrite(new URL(pathWithEditPrefix, req.url));
+    }
+
+    // Disable "/puck/[...puckPath]"
+    if (req.nextUrl.pathname.startsWith("/puck")) {
+      return NextResponse.redirect(new URL("/", req.url));
+    }
+  }
+
+  return res;
+}

package/templates/next/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

package/templates/next/next.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  reactStrictMode: true,
+  transpilePackages: ["ui"],
+};

package/templates/next/puck.config.tsx

@@ -0,0 +1,25 @@
+import type { Config } from "@measured/puck";
+
+type Props = {
+  HeadingBlock: { title: string };
+};
+
+export const config: Config<Props> = {
+  components: {
+    HeadingBlock: {
+      fields: {
+        title: { type: "text" },
+      },
+      defaultProps: {
+        title: "Heading",
+      },
+      render: ({ title }) => (
+        <div style={{ padding: 64 }}>
+          <h1>{title}</h1>
+        </div>
+      ),
+    },
+  },
+};
+
+export default config;

package/templates/next/tsconfig/base.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Default",
+  "compilerOptions": {
+    "composite": false,
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "inlineSources": false,
+    "isolatedModules": true,
+    "moduleResolution": "node",
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "preserveWatchOutput": true,
+    "skipLibCheck": true,
+    "strict": true
+  },
+  "exclude": ["node_modules"]
+}

package/templates/next/tsconfig/nextjs.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Next.js",
+  "extends": "./base.json",
+  "compilerOptions": {
+    "plugins": [{ "name": "next" }],
+    "allowJs": true,
+    "declaration": false,
+    "declarationMap": false,
+    "incremental": true,
+    "jsx": "preserve",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "module": "esnext",
+    "noEmit": true,
+    "resolveJsonModule": true,
+    "strict": false,
+    "target": "es5"
+  },
+  "include": ["src", "next-env.d.ts"],
+  "exclude": ["node_modules"]
+}

package/templates/next/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig/nextjs.json",
+  "compilerOptions": {
+    "plugins": [{ "name": "next" }]
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}

package/scripts/generate.js

@@ -1,72 +0,0 @@
-#!/usr/bin/env node
-
-import fs from "fs";
-import path from "path";
-import { glob } from "glob";
-import { dirname } from "path";
-import { fileURLToPath } from "url";
-
-const verbose = false;
-
-const run = async () => {
-  const __filename = fileURLToPath(import.meta.url);
-  const __dirname = dirname(__filename);
-
-  // Copy template files to the new directory
-  const recipePath = path.join(__dirname, "../../../recipes");
-  const templatePath = path.join(__dirname, "../templates");
-
-  if (!fs.existsSync(recipePath)) {
-    console.error(`No recipe directory could be found at ${recipePath}.`);
-    return;
-  }
-
-  if (!fs.existsSync(templatePath)) {
-    console.error(`No template directory could be found at ${templatePath}.`);
-    return;
-  }
-
-  // Copy recipe files
-  const recipeFiles = glob.sync(`**/*`, {
-    cwd: recipePath,
-    nodir: true,
-    dot: true,
-  });
-
-  console.warn(
-    `⚠️   The following files use handlebars templates. Please manually update them:`
-  );
-
-  let counter = 0;
-
-  for (const recipeFile of recipeFiles) {
-    const filePath = path.join(recipePath, recipeFile);
-
-    const targetPath = filePath
-      .replace(recipePath, templatePath)
-      .replace(".gitignore", "gitignore"); // rename .gitignore to gitignore so NPM publish doesn't ignore it
-
-    // Don't copy file if it's templated by handlebars
-    if (fs.existsSync(`${targetPath}.hbs`)) {
-      console.warn(`- ${recipeFile}`);
-    } else {
-      if (verbose) {
-        console.log(`Copying ${filePath} -> ${targetPath}`);
-      }
-
-      const data = await fs.readFileSync(filePath, "utf-8");
-
-      const dir = path.dirname(targetPath);
-
-      await fs.mkdirSync(dir, { recursive: true });
-
-      await fs.writeFileSync(targetPath, data);
-
-      counter += 1;
-    }
-  }
-
-  console.log(`Copied ${counter} files into generator!`);
-};
-
-await run();