create-plasmic-app 0.0.43 → 0.0.46

package/README.md

@@ -1,5 +1,5 @@
-
 # Create Plasmic App
+
 The easiest way to get started with Plasmic for a new code base is with `create-plasmic-app`. Under the hood, we'll use `create-next-app`, `create-gatsby`, or `create-react-app` to help create a new app, and set it up with Plasmic.
 
 ## Quickstart

package/dist/index.js

@@ -202,8 +202,8 @@ function run() {
             const rawProjectId = yield maybePrompt({
                 name: "projectId",
                 message: `What is the URL of your project?
-(If you don't have a project yet, create one by going to
-https://studio.plasmic.app/starters/simple-light):
+If you don't have a project yet, create one by going to
+https://studio.plasmic.app/starters/blank
 `,
             });
             projectId = rawProjectId

package/dist/strategies/gatsby.js

@@ -49,16 +49,27 @@ const npm_utils_1 = require("../utils/npm-utils");
 const common_1 = require("./common");
 const gatsbyStrategy = {
     create: (args) => __awaiter(void 0, void 0, void 0, function* () {
-        const { projectPath, template } = args;
-        const createCommand = `npx -p gatsby gatsby new ${projectPath}`;
-        const templateArg = template ? ` ${template}` : "";
-        yield cmd_utils_1.spawnOrFail(`${createCommand}${templateArg}`);
+        const { projectPath, template, useTypescript } = args;
+        if (template) {
+            console.log(`Warning: Ignoring template '${template}' (argument is not supported by Gatsby).`);
+        }
+        // create-gatsby does not support absolute paths as of 2022-08-12
+        // (see https://github.com/gatsbyjs/gatsby/issues/36381).
+        const parent = path_1.default.dirname(projectPath);
+        yield fs_1.promises.mkdir(parent, { recursive: true });
+        const dir = path_1.default.basename(projectPath);
+        const createCommand = `npx -p create-gatsby create-gatsby ${useTypescript ? "-ts" : ""} -y ${dir}`;
+        yield cmd_utils_1.spawnOrFail(`${createCommand}`, parent);
     }),
     installDeps: ({ projectPath, scheme }) => __awaiter(void 0, void 0, void 0, function* () {
         if (scheme === "loader") {
-            return yield npm_utils_1.installUpgrade("@plasmicapp/loader-gatsby", {
+            return ((yield npm_utils_1.installUpgrade("@plasmicapp/loader-gatsby", {
                 workingDir: projectPath,
-            });
+            })) &&
+                (yield npm_utils_1.installUpgrade("react-helmet", { workingDir: projectPath })) &&
+                (yield npm_utils_1.installUpgrade("gatsby-plugin-react-helmet", {
+                    workingDir: projectPath,
+                })));
         }
         else {
             return yield common_1.installCodegenDeps({ projectPath });
@@ -67,21 +78,27 @@ const gatsbyStrategy = {
     overwriteConfig: (args) => __awaiter(void 0, void 0, void 0, function* () {
         var e_1, _a;
         const { projectId, projectPath, projectApiToken, useTypescript, scheme, } = args;
+        const extension = useTypescript ? "ts" : "js";
         if (scheme === "loader") {
-            // create-gatsby will create a default gatsby-config.js that we need to modify
-            const gatsbyConfigFile = path_1.default.join(projectPath, "gatsby-config.js");
+            // create-gatsby will create a default gatsby-config that we need to modify
+            const gatsbyConfigFile = path_1.default.join(projectPath, `gatsby-config.${extension}`);
             const rl = readline.createInterface({
                 input: fs_1.createReadStream(gatsbyConfigFile),
                 crlfDelay: Infinity,
             });
             let result = "";
+            const pluginConfig = gatsby_1.GATSBY_PLUGIN_CONFIG(projectId, lang_utils_1.ensure(projectApiToken), useTypescript);
             try {
                 for (var rl_1 = __asyncValues(rl), rl_1_1; rl_1_1 = yield rl_1.next(), !rl_1_1.done;) {
                     const line = rl_1_1.value;
-                    result += line + "\n";
-                    // Prepend PlasmicLoader to list of plugins
-                    if (line.includes("plugins:")) {
-                        result += gatsby_1.GATSBY_PLUGIN_CONFIG(projectId, lang_utils_1.ensure(projectApiToken), useTypescript);
+                    if (line.includes("plugins: []")) {
+                        result += "  plugins: [" + pluginConfig + "]\n";
+                    }
+                    else if (line.includes("plugins: [")) {
+                        result += line + pluginConfig + "\n";
+                    }
+                    else {
+                        result += line + "\n";
                     }
                 }
             }
@@ -102,16 +119,16 @@ const gatsbyStrategy = {
         const extension = useTypescript ? "ts" : "js";
         file_utils_1.deleteGlob(path_1.default.join(projectPath, "src/@(pages|components|templates)/*.*"));
         // Create a very basic 404 page - `gatsby build` fails without it.
-        yield fs_1.promises.writeFile(path_1.default.join(projectPath, `src/pages/404.js`), gatsby_1.GATSBY_404);
+        yield fs_1.promises.writeFile(path_1.default.join(projectPath, `src/pages/404.${extension}`), gatsby_1.GATSBY_404);
         // Add plasmic-host page
         yield fs_1.promises.writeFile(path_1.default.join(projectPath, `src/pages/plasmic-host.${extension}x`), gatsby_1.makeGatsbyHostPage({
             useTypescript,
             scheme,
         }));
-        // Start with an empty gatsby-node.js
-        yield fs_1.promises.writeFile(path_1.default.join(projectPath, "gatsby-node.js"), "");
+        // Start with an empty gatsby-node
+        yield fs_1.promises.writeFile(path_1.default.join(projectPath, `gatsby-node.${extension}`), "");
         // Updates `gatsby-ssr` to include script tag for preamble
-        yield fs_1.promises.writeFile(path_1.default.join(projectPath, "gatsby-ssr.js"), gatsby_1.GATSBY_SSR_CONFIG);
+        yield fs_1.promises.writeFile(path_1.default.join(projectPath, `gatsby-ssr.${extension}x`), gatsby_1.GATSBY_SSR_CONFIG);
         if (scheme === "loader") {
             yield fs_1.promises.writeFile(path_1.default.join(projectPath, `src/plasmic-init.${extension}`), gatsby_1.makeGatsbyPlasmicInit(extension));
             const templatesFolder = path_1.default.join(projectPath, "src/templates");
@@ -131,9 +148,9 @@ const gatsbyStrategy = {
             yield file_utils_1.overwriteIndex(projectPath, "gatsby", scheme);
             // Overwrite the wrapper files to wrap PlasmicRootProvider
             const wrapperContent = gatsby_1.wrapAppRootForCodegen();
-            const browserFilePath = path_1.default.join(projectPath, "gatsby-browser.js");
+            const browserFilePath = path_1.default.join(projectPath, `gatsby-browser.${extension}x`);
             yield fs_1.promises.writeFile(browserFilePath, wrapperContent);
-            const ssrFilePath = path_1.default.join(projectPath, "gatsby-ssr.js");
+            const ssrFilePath = path_1.default.join(projectPath, `gatsby-ssr.${extension}x`);
             yield fs_1.promises.writeFile(ssrFilePath, wrapperContent);
         }
     }),

package/dist/templates/gatsby.js

@@ -73,9 +73,13 @@ const GATSBY_PLUGIN_CONFIG = (projectId, projectApiToken, useTypescript) => `
         token: "${projectApiToken}",
       },
     ], // An array of project ids.
+    preview: false,
     defaultPlasmicPage: require.resolve("./src/templates/defaultPlasmicPage.${useTypescript ? "tsx" : "jsx"}"),
   },
 },
+{
+  resolve: "gatsby-plugin-react-helmet",
+}
 `;
 exports.GATSBY_PLUGIN_CONFIG = GATSBY_PLUGIN_CONFIG;
 const makeGatsbyHostPage = (opts) => {

package/dist/templates/nextjs.js

@@ -40,8 +40,9 @@ import {
   ComponentRenderData,
   PlasmicRootProvider,
 } from "@plasmicapp/loader-nextjs";
-${file_utils_1.ifTs(ts, `import { GetStaticPaths, GetStaticProps } from "next";\n`)}
+${file_utils_1.ifTs(ts, `import type { GetStaticPaths, GetStaticProps } from "next";\n`)}
 import Error from "next/error";
+import { useRouter } from "next/router";
 import { PLASMIC } from "../plasmic-init";
 
 export default function PlasmicLoaderPage(props${file_utils_1.ifTs(ts, `: {
@@ -49,16 +50,20 @@ export default function PlasmicLoaderPage(props${file_utils_1.ifTs(ts, `: {
   queryCache?: Record<string, any>;
 }`)}) {
   const { plasmicData, queryCache } = props;
+  const router = useRouter();
   if (!plasmicData || plasmicData.entryCompMetas.length === 0) {
     return <Error statusCode={404} />;
   }
+  const pageMeta = plasmicData.entryCompMetas[0];
   return (
     <PlasmicRootProvider
       loader={PLASMIC}
       prefetchedData={plasmicData}
       prefetchedQueryData={queryCache}
+      pageParams={pageMeta.params}
+      pageQuery={router.query${file_utils_1.ifTs(ts, " as Record<string, string>")}}
     >
-      <PlasmicComponent component={plasmicData.entryCompMetas[0].displayName} />
+      <PlasmicComponent component={pageMeta.displayName} />
     </PlasmicRootProvider>
   );
 }
@@ -71,10 +76,15 @@ export const getStaticProps${file_utils_1.ifTs(ts, `: GetStaticProps`)} = async
     // non-Plasmic catch-all
     return { props: {} };
   }
+  const pageMeta = plasmicData.entryCompMetas[0];
   // Cache the necessary data fetched for the page
   const queryCache = await extractPlasmicQueryData(
-    <PlasmicRootProvider loader={PLASMIC} prefetchedData={plasmicData}>
-      <PlasmicComponent component={plasmicData.entryCompMetas[0].name} />
+    <PlasmicRootProvider
+      loader={PLASMIC}
+      prefetchedData={plasmicData}
+      pageParams={pageMeta.params}
+    >
+      <PlasmicComponent component={pageMeta.displayName} />
     </PlasmicRootProvider>
   );
   // Use revalidate if you want incremental static regeneration
@@ -89,10 +99,7 @@ export const getStaticPaths${file_utils_1.ifTs(ts, `: GetStaticPaths`)} = async
         catchall: mod.path.substring(1).split("/"),
       },
     })),
-
-    // Turn on "fallback: 'blocking'" if you would like new paths created
-    // in Plasmic to be automatically available
-    fallback: false,
+    fallback: "blocking",
   };
 }
   `.trim();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-plasmic-app",
-  "version": "0.0.43",
+  "version": "0.0.46",
   "description": "Create Plasmic-powered React apps",
   "main": "./dist/lib.js",
   "types": "./dist/lib.d.ts",
@@ -17,7 +17,7 @@
     "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand --watch",
     "build": "eslint 'src/**' && tsc",
     "create-plasmic-app": "ts-node src/index.ts",
-    "prepare": "yarn build"
+    "prepare": "if-env PREPARE_NO_BUILD=true || yarn build"
   },
   "devDependencies": {
     "@types/findup-sync": "^2.0.2",
@@ -40,7 +40,7 @@
     "typescript": "^4.2.3"
   },
   "dependencies": {
-    "@plasmicapp/cli": "^0.1.166",
+    "@plasmicapp/cli": "^0.1.185",
     "@sentry/node": "^6.2.2",
     "chalk": "^4.1.0",
     "execa": "^5.0.0",

package/src/index.ts

@@ -185,8 +185,8 @@ async function run(): Promise<void> {
     const rawProjectId = await maybePrompt({
       name: "projectId",
       message: `What is the URL of your project?
-(If you don't have a project yet, create one by going to
-https://studio.plasmic.app/starters/simple-light):
+If you don't have a project yet, create one by going to
+https://studio.plasmic.app/starters/blank
 `,
     });
     projectId = rawProjectId

package/src/strategies/gatsby.ts

@@ -19,17 +19,34 @@ import { CPAStrategy } from "./types";
 
 const gatsbyStrategy: CPAStrategy = {
   create: async (args) => {
-    const { projectPath, template } = args;
-    const createCommand = `npx -p gatsby gatsby new ${projectPath}`;
-    const templateArg = template ? ` ${template}` : "";
+    const { projectPath, template, useTypescript } = args;
+    if (template) {
+      console.log(
+        `Warning: Ignoring template '${template}' (argument is not supported by Gatsby).`
+      );
+    }
 
-    await spawnOrFail(`${createCommand}${templateArg}`);
+    // create-gatsby does not support absolute paths as of 2022-08-12
+    // (see https://github.com/gatsbyjs/gatsby/issues/36381).
+    const parent = path.dirname(projectPath);
+    await fs.mkdir(parent, { recursive: true });
+    const dir = path.basename(projectPath);
+    const createCommand = `npx -p create-gatsby create-gatsby ${
+      useTypescript ? "-ts" : ""
+    } -y ${dir}`;
+    await spawnOrFail(`${createCommand}`, parent);
   },
   installDeps: async ({ projectPath, scheme }) => {
     if (scheme === "loader") {
-      return await installUpgrade("@plasmicapp/loader-gatsby", {
-        workingDir: projectPath,
-      });
+      return (
+        (await installUpgrade("@plasmicapp/loader-gatsby", {
+          workingDir: projectPath,
+        })) &&
+        (await installUpgrade("react-helmet", { workingDir: projectPath })) &&
+        (await installUpgrade("gatsby-plugin-react-helmet", {
+          workingDir: projectPath,
+        }))
+      );
     } else {
       return await installCodegenDeps({ projectPath });
     }
@@ -42,24 +59,31 @@ const gatsbyStrategy: CPAStrategy = {
       useTypescript,
       scheme,
     } = args;
+    const extension = useTypescript ? "ts" : "js";
 
     if (scheme === "loader") {
-      // create-gatsby will create a default gatsby-config.js that we need to modify
-      const gatsbyConfigFile = path.join(projectPath, "gatsby-config.js");
+      // create-gatsby will create a default gatsby-config that we need to modify
+      const gatsbyConfigFile = path.join(
+        projectPath,
+        `gatsby-config.${extension}`
+      );
       const rl = readline.createInterface({
         input: createReadStream(gatsbyConfigFile),
         crlfDelay: Infinity,
       });
       let result = "";
+      const pluginConfig = GATSBY_PLUGIN_CONFIG(
+        projectId,
+        ensure(projectApiToken),
+        useTypescript
+      );
       for await (const line of rl) {
-        result += line + "\n";
-        // Prepend PlasmicLoader to list of plugins
-        if (line.includes("plugins:")) {
-          result += GATSBY_PLUGIN_CONFIG(
-            projectId,
-            ensure(projectApiToken),
-            useTypescript
-          );
+        if (line.includes("plugins: []")) {
+          result += "  plugins: [" + pluginConfig + "]\n";
+        } else if (line.includes("plugins: [")) {
+          result += line + pluginConfig + "\n";
+        } else {
+          result += line + "\n";
         }
       }
       await fs.writeFile(gatsbyConfigFile, result);
@@ -81,7 +105,10 @@ const gatsbyStrategy: CPAStrategy = {
     deleteGlob(path.join(projectPath, "src/@(pages|components|templates)/*.*"));
 
     // Create a very basic 404 page - `gatsby build` fails without it.
-    await fs.writeFile(path.join(projectPath, `src/pages/404.js`), GATSBY_404);
+    await fs.writeFile(
+      path.join(projectPath, `src/pages/404.${extension}`),
+      GATSBY_404
+    );
 
     // Add plasmic-host page
     await fs.writeFile(
@@ -92,12 +119,12 @@ const gatsbyStrategy: CPAStrategy = {
       })
     );
 
-    // Start with an empty gatsby-node.js
-    await fs.writeFile(path.join(projectPath, "gatsby-node.js"), "");
+    // Start with an empty gatsby-node
+    await fs.writeFile(path.join(projectPath, `gatsby-node.${extension}`), "");
 
     // Updates `gatsby-ssr` to include script tag for preamble
     await fs.writeFile(
-      path.join(projectPath, "gatsby-ssr.js"),
+      path.join(projectPath, `gatsby-ssr.${extension}x`),
       GATSBY_SSR_CONFIG
     );
 
@@ -128,10 +155,13 @@ const gatsbyStrategy: CPAStrategy = {
 
       // Overwrite the wrapper files to wrap PlasmicRootProvider
       const wrapperContent = wrapAppRootForCodegen();
-      const browserFilePath = path.join(projectPath, "gatsby-browser.js");
+      const browserFilePath = path.join(
+        projectPath,
+        `gatsby-browser.${extension}x`
+      );
       await fs.writeFile(browserFilePath, wrapperContent);
 
-      const ssrFilePath = path.join(projectPath, "gatsby-ssr.js");
+      const ssrFilePath = path.join(projectPath, `gatsby-ssr.${extension}x`);
       await fs.writeFile(ssrFilePath, wrapperContent);
     }
   },

package/src/templates/gatsby.ts

@@ -83,11 +83,15 @@ export const GATSBY_PLUGIN_CONFIG = (
         token: "${projectApiToken}",
       },
     ], // An array of project ids.
+    preview: false,
     defaultPlasmicPage: require.resolve("./src/templates/defaultPlasmicPage.${
       useTypescript ? "tsx" : "jsx"
     }"),
   },
 },
+{
+  resolve: "gatsby-plugin-react-helmet",
+}
 `;
 
 export const makeGatsbyHostPage = (opts: {

package/src/templates/nextjs.ts

@@ -43,8 +43,9 @@ import {
   ComponentRenderData,
   PlasmicRootProvider,
 } from "@plasmicapp/loader-nextjs";
-${ifTs(ts, `import { GetStaticPaths, GetStaticProps } from "next";\n`)}
+${ifTs(ts, `import type { GetStaticPaths, GetStaticProps } from "next";\n`)}
 import Error from "next/error";
+import { useRouter } from "next/router";
 import { PLASMIC } from "../plasmic-init";
 
 export default function PlasmicLoaderPage(props${ifTs(
@@ -55,16 +56,20 @@ export default function PlasmicLoaderPage(props${ifTs(
 }`
   )}) {
   const { plasmicData, queryCache } = props;
+  const router = useRouter();
   if (!plasmicData || plasmicData.entryCompMetas.length === 0) {
     return <Error statusCode={404} />;
   }
+  const pageMeta = plasmicData.entryCompMetas[0];
   return (
     <PlasmicRootProvider
       loader={PLASMIC}
       prefetchedData={plasmicData}
       prefetchedQueryData={queryCache}
+      pageParams={pageMeta.params}
+      pageQuery={router.query${ifTs(ts, " as Record<string, string>")}}
     >
-      <PlasmicComponent component={plasmicData.entryCompMetas[0].displayName} />
+      <PlasmicComponent component={pageMeta.displayName} />
     </PlasmicRootProvider>
   );
 }
@@ -80,10 +85,15 @@ export const getStaticProps${ifTs(
     // non-Plasmic catch-all
     return { props: {} };
   }
+  const pageMeta = plasmicData.entryCompMetas[0];
   // Cache the necessary data fetched for the page
   const queryCache = await extractPlasmicQueryData(
-    <PlasmicRootProvider loader={PLASMIC} prefetchedData={plasmicData}>
-      <PlasmicComponent component={plasmicData.entryCompMetas[0].name} />
+    <PlasmicRootProvider
+      loader={PLASMIC}
+      prefetchedData={plasmicData}
+      pageParams={pageMeta.params}
+    >
+      <PlasmicComponent component={pageMeta.displayName} />
     </PlasmicRootProvider>
   );
   // Use revalidate if you want incremental static regeneration
@@ -98,10 +108,7 @@ export const getStaticPaths${ifTs(ts, `: GetStaticPaths`)} = async () => {
         catchall: mod.path.substring(1).split("/"),
       },
     })),
-
-    // Turn on "fallback: 'blocking'" if you would like new paths created
-    // in Plasmic to be automatically available
-    fallback: false,
+    fallback: "blocking",
   };
 }
   `.trim();