@cedarjs/cli 4.2.1-next.0 → 4.2.1-next.258

package/dist/commands/experimental/setupStreamingSsrHandler.js

@@ -13,18 +13,18 @@ import {
   EXPERIMENTAL_TOPIC_ID
 } from "./setupStreamingSsr.js";
 import { printTaskEpilogue } from "./util.js";
-const handler = async ({ force, verbose }) => {
-  const rwPaths = getPaths();
+const handler = async (options) => {
+  const cedarPaths = getPaths();
   const configPath = getConfigPath();
   const configContent = fs.readFileSync(configPath, "utf-8");
   const ts = isTypeScriptProject();
-  const ext = path.extname(rwPaths.web.entryClient || "");
-  const tasks = new Listr(
-    [
+  const ext = path.extname(cedarPaths.web.entryClient || "");
+  function buildTaskData() {
+    return [
       {
         title: "Check prerequisites",
         task: () => {
-          if (!rwPaths.web.entryClient || !rwPaths.web.viteConfig) {
+          if (!cedarPaths.web.entryClient || !cedarPaths.web.viteConfig) {
             throw new Error(
               "Vite needs to be setup before you can enable Streaming SSR"
             );
@@ -49,7 +49,7 @@ const handler = async ({ force, verbose }) => {
               }
             );
           } else {
-            if (force) {
+            if (options.force) {
               task.output = "Overwriting config in cedar.toml";
               writeFile(
                 configPath,
@@ -75,8 +75,7 @@ const handler = async ({ force, verbose }) => {
               );
             }
           }
-        },
-        rendererOptions: { persistentOutput: true }
+        }
       },
       {
         title: `Adding entry.client${ext}...`,
@@ -90,10 +89,13 @@ const handler = async ({ force, verbose }) => {
             ),
             "utf-8"
           );
-          let entryClientPath = rwPaths.web.entryClient;
+          let entryClientPath = cedarPaths.web.entryClient;
+          if (!entryClientPath) {
+            throw new Error("entryClient is not set");
+          }
           const entryClientContent = ts ? entryClientTemplate : await transformTSToJS(entryClientPath, entryClientTemplate);
-          let overwriteExisting = force;
-          if (!force) {
+          let overwriteExisting = options.force;
+          if (!options.force) {
             const prompt = task.prompt(ListrEnquirerPromptAdapter);
             overwriteExisting = await prompt.run({
               type: "Confirm",
@@ -106,8 +108,7 @@ You'll manually need to merge it with your existing entry.client${ext} file.`;
             }
           }
           writeFile(entryClientPath, entryClientContent, { overwriteExisting });
-        },
-        rendererOptions: { persistentOutput: true }
+        }
       },
       {
         title: `Adding entry.server${ext}...`,
@@ -122,12 +123,12 @@ You'll manually need to merge it with your existing entry.client${ext} file.`;
             "utf-8"
           );
           const entryServerPath = path.join(
-            rwPaths.web.src,
+            cedarPaths.web.src,
             `entry.server${ext}`
           );
           const entryServerContent = ts ? entryServerTemplate : await transformTSToJS(entryServerPath, entryServerTemplate);
           writeFile(entryServerPath, entryServerContent, {
-            overwriteExisting: force
+            overwriteExisting: options.force
           });
         }
       },
@@ -143,10 +144,10 @@ You'll manually need to merge it with your existing entry.client${ext} file.`;
             ),
             "utf-8"
           );
-          const documentPath = path.join(rwPaths.web.src, `Document${ext}`);
+          const documentPath = path.join(cedarPaths.web.src, `Document${ext}`);
           const documentContent = ts ? documentTemplate : await transformTSToJS(documentPath, documentTemplate);
           writeFile(documentPath, documentContent, {
-            overwriteExisting: force
+            overwriteExisting: options.force
           });
         }
       },
@@ -163,18 +164,18 @@ You'll manually need to merge it with your existing entry.client${ext} file.`;
             "utf-8"
           );
           const tsconfigPath = path.join(
-            rwPaths.web.base,
+            cedarPaths.web.base,
             ts ? "tsconfig.json" : "jsconfig.json"
           );
           writeFile(tsconfigPath, tsconfigTemplate, {
-            overwriteExisting: force
+            overwriteExisting: options.force
           });
         }
       },
       {
         title: 'Adding resolution for "@apollo/client-react-streaming/superjson"',
         task: () => {
-          const pkgJsonPath = path.join(rwPaths.base, "package.json");
+          const pkgJsonPath = path.join(cedarPaths.base, "package.json");
           const pkgJson = JSON.parse(fs.readFileSync(pkgJsonPath, "utf-8"));
           const resolutions = pkgJson.resolutions || {};
           resolutions["@apollo/client-react-streaming/superjson"] = "^1.12.2";
@@ -188,18 +189,32 @@ You'll manually need to merge it with your existing entry.client${ext} file.`;
           printTaskEpilogue(command, description, EXPERIMENTAL_TOPIC_ID);
         }
       }
-    ],
-    {
-      rendererOptions: { collapseSubtasks: false, persistentOutput: true },
-      renderer: verbose ? "verbose" : "default"
-    }
-  );
+    ];
+  }
   try {
-    await tasks.run();
+    if (options.verbose) {
+      await new Listr(buildTaskData(), {
+        exitOnError: true,
+        renderer: "verbose"
+      }).run();
+    } else {
+      await new Listr(
+        buildTaskData().map((t) => ({
+          ...t,
+          rendererOptions: { persistentOutput: true }
+        })),
+        {
+          exitOnError: true,
+          rendererOptions: { collapseSubtasks: false }
+        }
+      ).run();
+    }
   } catch (e) {
-    errorTelemetry(process.argv, e.message);
-    console.error(c.error(e.message));
-    process.exit(e?.exitCode || 1);
+    const message = e instanceof Error ? e.message : String(e);
+    const exitCode = e instanceof Error && "exitCode" in e && typeof e.exitCode === "number" ? e.exitCode : 1;
+    errorTelemetry(process.argv, message);
+    console.error(c.error(message));
+    process.exit(exitCode);
   }
 };
 export {

package/dist/commands/experimental/templates/rsc/Document.tsx.template

@@ -20,7 +20,7 @@ export const Document: React.FC<DocumentProps> = ({ children, css, meta }) => {
         <Meta tags={meta} />
       </head>
       <body>
-        <div id="redwood-app">{children}</div>
+        <div id="cedar-app">{children}</div>
       </body>
     </html>
   )

package/dist/commands/experimental/templates/rsc/entry.client.tsx.template

@@ -4,29 +4,29 @@ import App from './App'
 import Routes from './Routes'
 
 /**
- * When `#redwood-app` isn't empty then it's very likely that you're using
+ * When `#cedar-app` isn't empty then it's very likely that you're using
  * pre-rendering. So React attaches event listeners to the existing markup
  * rather than replacing it.
  * https://react.dev/reference/react-dom/client/hydrateRoot
  */
-const redwoodAppElement = document.getElementById('redwood-app')
+const cedarAppElement = document.getElementById('cedar-app')
 
-if (!redwoodAppElement) {
+if (!cedarAppElement) {
   throw new Error(
-    "Could not find an element with ID 'redwood-app'. Please ensure it " +
-      "exists in your 'web/src/index.html' file."
+    'Could not find an element with ID "cedar-app". Please ensure it exists ' +
+      'in your `web/index.html` file.'
   )
 }
 
-if (redwoodAppElement.children?.length > 0) {
+if (cedarAppElement.children?.length > 0) {
   hydrateRoot(
-    redwoodAppElement,
+    cedarAppElement,
     <App>
       <Routes />
     </App>
   )
 } else {
-  const root = createRoot(redwoodAppElement)
+  const root = createRoot(cedarAppElement)
   root.render(
     <App>
       <Routes />

package/dist/commands/experimental/templates/streamingSsr/Document.tsx.template

@@ -20,7 +20,7 @@ export const Document: React.FC<DocumentProps> = ({ children, css, meta }) => {
         <Meta tags={meta} />
       </head>
       <body>
-        <div id="redwood-app">{children}</div>
+        <div id="cedar-app">{children}</div>
       </body>
     </html>
   )

package/dist/commands/experimental/templates/streamingSsr/entry.client.tsx.template

@@ -5,21 +5,21 @@ import { Document } from './Document'
 import Routes from './Routes'
 
 /**
- * When `#redwood-app` isn't empty then it's very likely that you're using
+ * When `#cedar-app` isn't empty then it's very likely that you're using
  * prerendering. So React attaches event listeners to the existing markup
  * rather than replacing it.
  * https://react.dev/reference/react-dom/client/hydrateRoot
  */
-const redwoodAppElement = document.getElementById('redwood-app')
+const cedarAppElement = document.getElementById('cedar-app')
 
-if (!redwoodAppElement) {
+if (!cedarAppElement) {
   throw new Error(
-    "Could not find an element with ID 'redwood-app'. Please ensure it " +
-      "exists in your 'web/src/index.html' file."
+    'Could not find an element with ID "cedar-app". Please ensure it exists ' +
+      'in your `web/index.html` file.'
   )
 }
 
-if (redwoodAppElement.children?.length > 0) {
+if (cedarAppElement.children?.length > 0) {
   hydrateRoot(
     document,
     <Document css={window.__assetMap?.()?.css}>

package/dist/commands/experimental/util.js

@@ -2,6 +2,7 @@ import fs from "node:fs";
 import path from "node:path";
 import ansis from "ansis";
 import { terminalLink } from "termi-link";
+import { formatCedarCommand } from "@cedarjs/cli-helpers/packageManager/display";
 import { getPaths } from "../../lib/index.js";
 import { isTypeScriptProject, serverFileExists } from "../../lib/project.js";
 function link(topicId, isTerminal = false) {
@@ -41,7 +42,7 @@ function printTaskEpilogue(command, description, topicId) {
 const isServerFileSetup = () => {
   if (!serverFileExists()) {
     throw new Error(
-      "CedarJS Realtime requires a serverful environment. Please run `yarn cedarjs setup server-file` first."
+      `CedarJS Realtime requires a serverful environment. Please run \`${formatCedarCommand(["setup", "server-file"])}\` first.`
     );
   }
   return true;
@@ -56,7 +57,7 @@ const realtimeExists = () => {
 const isRealtimeSetup = () => {
   if (!realtimeExists()) {
     throw new Error(
-      "Adding realtime events requires that CedarJS Realtime is setup. Please run `yarn cedar setup realtime` first."
+      `Adding realtime events requires that CedarJS Realtime is setup. Please run \`${formatCedarCommand(["setup", "realtime"])}\` first.`
     );
   }
   return true;

package/dist/commands/generate/cell/cellHandler.js

@@ -1,7 +1,8 @@
 import pascalcase from "pascalcase";
+import { formatCedarCommand } from "@cedarjs/cli-helpers/packageManager/display";
 import { generate as generateTypes } from "@cedarjs/internal/dist/generate/generate";
 import { isPlural, singularize } from "@cedarjs/utils/cedarPluralize";
-import { nameVariants, transformTSToJS } from "../../../lib/index.js";
+import { nameVariants, transformTSToJSMap } from "../../../lib/index.js";
 import { isWordPluralizable } from "../../../lib/pluralHelpers.js";
 import { addFunctionToRollback } from "../../../lib/rollback.js";
 import { getSchema } from "../../../lib/schemaHelpers.js";
@@ -18,8 +19,15 @@ import {
   uniqueOperationName
 } from "./utils/utils.js";
 const COMPONENT_SUFFIX = "Cell";
-const REDWOOD_WEB_PATH_NAME = "components";
-const files = async ({ name, typescript, ...argv }) => {
+const CEDAR_WEB_PATH_NAME = "components";
+const files = async ({
+  name,
+  typescript = false,
+  list = false,
+  query,
+  stories,
+  tests
+}) => {
   let cellName = removeGeneratorName(name, "cell");
   let idName = "id";
   let idType;
@@ -27,7 +35,7 @@ const files = async ({ name, typescript, ...argv }) => {
   let model = null;
   let templateNameSuffix = "";
   let typeName = cellName;
-  const shouldGenerateList = (isWordPluralizable(cellName) ? isPlural(cellName) : argv.list) || argv.list;
+  const shouldGenerateList = (isWordPluralizable(cellName) ? isPlural(cellName) : list) || list;
   try {
     model = await getSchema(pascalcase(singularize(cellName)));
     idName = getIdName(model);
@@ -41,7 +49,7 @@ const files = async ({ name, typescript, ...argv }) => {
     cellName = forcePluralizeWord(cellName);
     templateNameSuffix = "List";
   }
-  let operationName = argv.query;
+  let operationName = query;
   if (operationName) {
     const userSpecifiedOperationNameIsUnique = await operationNameIsUnique(operationName);
     if (!userSpecifiedOperationNameIsUnique) {
@@ -57,7 +65,7 @@ const files = async ({ name, typescript, ...argv }) => {
     name: cellName,
     suffix: COMPONENT_SUFFIX,
     extension,
-    webPathSection: REDWOOD_WEB_PATH_NAME,
+    webPathSection: CEDAR_WEB_PATH_NAME,
     generator: "cell",
     templatePath: `cell${templateNameSuffix}.tsx.template`,
     templateVars: {
@@ -70,7 +78,7 @@ const files = async ({ name, typescript, ...argv }) => {
     name: cellName,
     suffix: COMPONENT_SUFFIX,
     extension: `.test${extension}`,
-    webPathSection: REDWOOD_WEB_PATH_NAME,
+    webPathSection: CEDAR_WEB_PATH_NAME,
     generator: "cell",
     templatePath: "test.js.template",
     templateVars: {
@@ -82,7 +90,7 @@ const files = async ({ name, typescript, ...argv }) => {
     name: cellName,
     suffix: COMPONENT_SUFFIX,
     extension: `.stories${extension}`,
-    webPathSection: REDWOOD_WEB_PATH_NAME,
+    webPathSection: CEDAR_WEB_PATH_NAME,
     generator: "cell",
     templatePath: "stories.tsx.template"
   });
@@ -90,7 +98,7 @@ const files = async ({ name, typescript, ...argv }) => {
     name: cellName,
     suffix: COMPONENT_SUFFIX,
     extension: typescript ? ".mock.ts" : ".mock.js",
-    webPathSection: REDWOOD_WEB_PATH_NAME,
+    webPathSection: CEDAR_WEB_PATH_NAME,
     generator: "cell",
     templatePath: `mock${templateNameSuffix}.ts.template`,
     templateVars: {
@@ -100,23 +108,16 @@ const files = async ({ name, typescript, ...argv }) => {
     }
   });
   const files2 = [cellFile];
-  if (argv.stories) {
+  if (stories) {
     files2.push(storiesFile);
   }
-  if (argv.tests) {
+  if (tests) {
     files2.push(testFile);
   }
-  if (argv.stories || argv.tests) {
+  if (stories || tests) {
     files2.push(mockFile);
   }
-  return files2.reduce(async (accP, [outputPath, content]) => {
-    const acc = await accP;
-    const template = typescript ? content : await transformTSToJS(outputPath, content);
-    return {
-      [outputPath]: template,
-      ...acc
-    };
-  }, Promise.resolve({}));
+  return transformTSToJSMap(files2, typescript);
 };
 const handler = createHandler({
   componentName: "cell",
@@ -141,7 +142,7 @@ const handler = createHandler({
             addFunctionToRollback(generateTypes, true);
           } else {
             task.skip(
-              `Skipping type generation: no SDL defined for "${queryFieldName}". To generate types, run 'yarn cedar generate sdl ${queryFieldName}'.`
+              `Skipping type generation: no SDL defined for "${queryFieldName}". To generate types, run '${formatCedarCommand(["generate", "sdl", queryFieldName])}'.`
             );
           }
         }

package/dist/commands/generate/component/componentHandler.js

@@ -1,14 +1,19 @@
-import { transformTSToJS } from "../../../lib/index.js";
+import { transformTSToJSMap } from "../../../lib/index.js";
 import {
   createHandler,
   templateForComponentFile
 } from "../yargsHandlerHelpers.js";
-const REDWOOD_WEB_PATH_NAME = "components";
-const files = async ({ name, typescript = false, ...argv }) => {
+const CEDAR_WEB_PATH_NAME = "components";
+const files = async ({
+  name,
+  typescript = false,
+  stories,
+  tests
+}) => {
   const extension = typescript ? ".tsx" : ".jsx";
   const componentFile = await templateForComponentFile({
     name,
-    webPathSection: REDWOOD_WEB_PATH_NAME,
+    webPathSection: CEDAR_WEB_PATH_NAME,
     extension,
     generator: "component",
     templatePath: "component.tsx.template"
@@ -16,34 +21,27 @@ const files = async ({ name, typescript = false, ...argv }) => {
   const testFile = await templateForComponentFile({
     name,
     extension: `.test${extension}`,
-    webPathSection: REDWOOD_WEB_PATH_NAME,
+    webPathSection: CEDAR_WEB_PATH_NAME,
     generator: "component",
     templatePath: "test.tsx.template"
   });
   const storiesFile = await templateForComponentFile({
     name,
     extension: `.stories${extension}`,
-    webPathSection: REDWOOD_WEB_PATH_NAME,
+    webPathSection: CEDAR_WEB_PATH_NAME,
     generator: "component",
     // Using two different template files here because we have a TS-specific
     // information in a comment in the .tsx template
     templatePath: typescript ? "stories.tsx.template" : "stories.jsx.template"
   });
   const files2 = [componentFile];
-  if (argv.stories) {
+  if (stories) {
     files2.push(storiesFile);
   }
-  if (argv.tests) {
+  if (tests) {
     files2.push(testFile);
   }
-  return files2.reduce(async (accP, [outputPath, content]) => {
-    const acc = await accP;
-    const template = typescript ? content : await transformTSToJS(outputPath, content);
-    return {
-      [outputPath]: template,
-      ...acc
-    };
-  }, Promise.resolve({}));
+  return transformTSToJSMap(files2, typescript);
 };
 const handler = createHandler({
   componentName: "component",

package/dist/commands/generate/dataMigration/dataMigration.js

@@ -3,6 +3,7 @@ import { paramCase } from "change-case";
 import { Listr } from "listr2";
 import { terminalLink } from "termi-link";
 import { recordTelemetryAttributes, colors as c } from "@cedarjs/cli-helpers";
+import { formatCedarCommand } from "@cedarjs/cli-helpers/packageManager/display";
 import { getDataMigrationsPath } from "@cedarjs/project-config";
 import {
   generateTemplate,
@@ -11,15 +12,16 @@ import {
 } from "../../../lib/index.js";
 import { prepareForRollback } from "../../../lib/rollback.js";
 import { validateName } from "../helpers.js";
-import { getYargsDefaults } from "../yargsCommandHelpers.js";
-const POST_RUN_INSTRUCTIONS = `Next steps...
+function getPostRunInstructions() {
+  const text = c.warning("After writing your migration, you can run it with:");
+  const command2 = formatCedarCommand(["dataMigrate", "up"]);
+  return `Next steps...
 
-   ${c.warning(
-  "After writing your migration, you can run it with:"
-)}
+   ${text}
 
-     yarn cedar dataMigrate up
+   ${command2}
 `;
+}
 const TEMPLATE_PATHS = {
   js: path.resolve(
     import.meta.dirname,
@@ -54,22 +56,30 @@ const command = "data-migration <name>";
 const aliases = ["dataMigration", "dm"];
 const description = "Generate a data migration";
 const builder = (yargs) => {
-  yargs.positional("name", {
+  return yargs.positional("name", {
     description: "A descriptor of what this data migration does",
-    type: "string"
+    type: "string",
+    demandOption: true
   }).option("rollback", {
     description: "Revert all generator actions if an error occurs",
     type: "boolean",
     default: true
+  }).option("force", {
+    alias: "f",
+    default: false,
+    description: "Overwrite existing files",
+    type: "boolean"
+  }).option("typescript", {
+    alias: "ts",
+    default: false,
+    description: "Generate TypeScript files",
+    type: "boolean"
   }).epilogue(
     `Also see the ${terminalLink(
       "CedarJS CLI Reference",
       "https://cedarjs.com/docs/cli-commands#generate-datamigration"
     )}`
   );
-  Object.entries(getYargsDefaults()).forEach(([option, config]) => {
-    yargs.option(option, config);
-  });
 };
 const handler = async (args) => {
   recordTelemetryAttributes({
@@ -89,7 +99,7 @@ const handler = async (args) => {
       {
         title: "Next steps...",
         task: (_ctx, task) => {
-          task.title = POST_RUN_INSTRUCTIONS;
+          task.title = getPostRunInstructions();
         }
       }
     ].filter(Boolean),
@@ -101,7 +111,7 @@ const handler = async (args) => {
     }
     await tasks.run();
   } catch (e) {
-    console.log(c.error(e.message));
+    console.log(c.error(e instanceof Error ? e.message : String(e)));
     process.exit(1);
   }
 };
@@ -111,5 +121,6 @@ export {
   command,
   description,
   files,
+  getPostRunInstructions,
   handler
 };

package/dist/commands/generate/dbAuth/dbAuth.js

@@ -45,6 +45,7 @@ const builder = (yargs) => {
   Object.entries(getYargsDefaults()).forEach(([option, config]) => {
     yargs.option(option, config);
   });
+  return yargs;
 };
 const handler = createHandler("dbAuth");
 export {