@cedarjs/cli 9.0.0-canary.1784 → 9.0.0-canary.3124

package/dist/commands/generate/package/packageHandler.js

@@ -2,17 +2,21 @@ import fs from "node:fs";
 import path from "node:path";
 import { ListrEnquirerPromptAdapter } from "@listr2/prompt-adapter-enquirer";
 import { paramCase, camelCase } from "change-case";
-import execa from "execa";
 import { modify, applyEdits } from "jsonc-parser";
 import { Listr } from "listr2";
 import { terminalLink } from "termi-link";
 import ts from "typescript";
-import { recordTelemetryAttributes } from "@cedarjs/cli-helpers";
+import { colors as c } from "@cedarjs/cli-helpers/colors";
+import { workspacePackageSpecifier } from "@cedarjs/cli-helpers/packageManager";
+import { runScript, runBinSync } from "@cedarjs/cli-helpers/packageManager/exec";
+import { installPackages } from "@cedarjs/cli-helpers/packageManager/packages";
+import { addWorkspaceDir } from "@cedarjs/cli-helpers/packageManager/workspaces";
+import { recordTelemetryAttributes } from "@cedarjs/cli-helpers/telemetry";
 import { getConfig } from "@cedarjs/project-config";
+import { getPackageManager } from "@cedarjs/project-config/packageManager";
 import { errorTelemetry } from "@cedarjs/telemetry";
-import c from "../../../lib/colors.js";
 import { getPaths, writeFilesTask } from "../../../lib/index.js";
-import { prepareForRollback } from "../../../lib/rollback.js";
+import { addFileToRollback, prepareForRollback } from "../../../lib/rollback.js";
 import { files } from "./filesTask.js";
 function nameVariants(nameArg) {
   const base = path.basename(getPaths().base);
@@ -29,8 +33,10 @@ async function updateTsconfig(task) {
       path: path.join(getPaths().api.base, "tsconfig.json"),
       expectedModule: "node20",
       // While Cedar doesn't officially endorse NodeNext, it will still work
-      // here, so we'll keep it
-      acceptable: ["node20", "nodenext"]
+      // here, so we'll keep it. ESNext is also acceptable: it's the current
+      // create-cedar-app default, paired with `moduleResolution: bundler` so
+      // extensionless scaffold/generator imports resolve correctly.
+      acceptable: ["node20", "nodenext", "esnext"]
     },
     {
       name: "web",
@@ -60,7 +66,7 @@ async function updateTsconfig(task) {
         "Failed to parse tsconfig: " + JSON.stringify(error, null, 2)
       );
     }
-    if (!tsconfig?.compilerOptions || typeof tsconfig.compilerOptions.module === "undefined") {
+    if (tsconfig.compilerOptions?.module === void 0) {
       continue;
     }
     const currentModule = typeof tsconfig.compilerOptions.module === "string" ? tsconfig.compilerOptions.module.toLowerCase() : String(tsconfig.compilerOptions.module).toLowerCase();
@@ -126,14 +132,12 @@ async function addDependencyToPackageJson(task, packageJsonPath, packageName) {
   const packageJson = JSON.parse(
     await fs.promises.readFile(packageJsonPath, "utf8")
   );
-  if (!packageJson.dependencies) {
-    packageJson.dependencies = {};
-  }
-  if (packageJson.dependencies[packageName]) {
+  packageJson.dependencies ??= {};
+  if (packageJson?.dependencies[packageName]) {
     task.skip("Dependency already exists");
     return;
   }
-  packageJson.dependencies[packageName] = "workspace:*";
+  packageJson.dependencies[packageName] = workspacePackageSpecifier();
   await fs.promises.writeFile(
     packageJsonPath,
     JSON.stringify(packageJson, null, 2)
@@ -200,7 +204,7 @@ function updateWorkspaceTsconfigReferences(task, folderName, targetWorkspaces) {
             readFile: (p) => {
               try {
                 return fs.readFileSync(p, "utf8");
-              } catch (e) {
+              } catch {
                 return ts.sys.readFile(p);
               }
             },
@@ -213,21 +217,21 @@ function updateWorkspaceTsconfigReferences(task, folderName, targetWorkspaces) {
           },
           path.dirname(ws.tsconfigPath)
         );
-        if (configParseResult.errors && configParseResult.errors.length) {
+        if (configParseResult.errors?.length) {
           console.error("Parse errors:", configParseResult.errors);
         }
         if (!Array.isArray(tsconfig.references)) {
           tsconfig.references = [];
         }
-        const packageDir2 = ws.packageDir || path.join(getPaths().base, "packages", folderName);
-        const referencePath = path.relative(path.dirname(ws.tsconfigPath), packageDir2).split(path.sep).join("/");
+        const wsPackageDir = ws.packageDir || path.join(getPaths().base, "packages", folderName);
+        const referencePath = path.relative(path.dirname(ws.tsconfigPath), wsPackageDir).split(path.sep).join("/");
         const references = tsconfig.references;
-        if (references.some((ref) => ref && ref.path === referencePath)) {
+        if (references.some((ref) => ref?.path === referencePath)) {
           subtask.skip("tsconfig already up to date");
           return;
         }
         const newReferences = references.concat([{ path: referencePath }]);
-        let text = await fs.promises.readFile(ws.tsconfigPath, "utf8");
+        const text = await fs.promises.readFile(ws.tsconfigPath, "utf8");
         const edits = modify(text, ["references"], newReferences, {
           formattingOptions: { insertSpaces: true, tabSize: 2 }
         });
@@ -244,14 +248,21 @@ function updateWorkspaceTsconfigReferences(task, folderName, targetWorkspaces) {
 }
 async function installAndBuild(folderName) {
   const packagePath = path.join("packages", folderName);
-  await execa("yarn", ["install"], { stdio: "inherit", cwd: getPaths().base });
-  await execa("yarn", ["build"], { stdio: "inherit", cwd: packagePath });
+  await installPackages({ stdio: "inherit", cwd: getPaths().base });
+  addFileToRollback(
+    path.join(getPaths().base, packagePath, "tsconfig.tsbuildinfo")
+  );
+  await runScript("build", [], { stdio: "inherit", cwd: packagePath });
 }
-const handler = async ({ name, force, ...rest }) => {
+const handler = async ({
+  name,
+  force,
+  ...rest
+}) => {
   recordTelemetryAttributes({
     command: "generate package",
     force,
-    rollback: rest.rollback
+    rollback: typeof rest.rollback === "boolean" ? rest.rollback : void 0
   });
   if (name.replaceAll("/", "").length < name.length - 1) {
     throw new Error(
@@ -272,7 +283,6 @@ const handler = async ({ name, force, ...rest }) => {
   }
   let packageFiles = {};
   const tasks = new Listr(
-    /** @type {import('listr2').ListrTask<ListrContext>[]} */
     [
       {
         title: "Parsing package name...",
@@ -282,34 +292,12 @@ const handler = async ({ name, force, ...rest }) => {
       },
       {
         title: "Updating workspace config...",
-        task: async (ctx, task) => {
-          const rootPackageJsonPath = path.join(getPaths().base, "package.json");
-          const packageJson = JSON.parse(
-            await fs.promises.readFile(rootPackageJsonPath, "utf8")
-          );
-          if (!Array.isArray(packageJson.workspaces)) {
-            throw new Error(
-              "Invalid workspace config in " + rootPackageJsonPath
-            );
-          }
+        task: (ctx, task) => {
+          const pm = getPackageManager();
           const packagePath = `packages/${ctx.nameVariants.folderName}`;
-          const hasWildcardPackagesWorkspace = packageJson.workspaces.includes("packages/*");
-          const hasNamedPackagesWorkspace = packageJson.workspaces.includes(packagePath);
-          const hasOtherNamedPackages = packageJson.workspaces.some(
-            (workspace) => workspace.startsWith("packages/") && workspace !== packagePath
-          );
-          if (hasWildcardPackagesWorkspace || hasNamedPackagesWorkspace) {
+          const result = addWorkspaceDir(getPaths().base, packagePath, pm);
+          if (result === "exists") {
             task.skip("Workspaces already configured");
-          } else {
-            if (hasOtherNamedPackages) {
-              packageJson.workspaces.push(packagePath);
-            } else {
-              packageJson.workspaces.push("packages/*");
-            }
-            await fs.promises.writeFile(
-              rootPackageJsonPath,
-              JSON.stringify(packageJson, null, 2)
-            );
           }
         }
       },
@@ -326,7 +314,7 @@ const handler = async ({ name, force, ...rest }) => {
               return;
             }
           } catch (e) {
-            throw new Error(e.message);
+            throw new Error(e instanceof Error ? e.message : String(e));
           }
           const prompt = task.prompt(ListrEnquirerPromptAdapter);
           const response = await prompt.run({
@@ -353,7 +341,10 @@ const handler = async ({ name, force, ...rest }) => {
       {
         title: "Generating package files...",
         task: async (ctx) => {
-          packageFiles = await files({ ...ctx.nameVariants, ...rest });
+          packageFiles = await files({
+            ...ctx.nameVariants,
+            ...rest
+          });
           return writeFilesTask(packageFiles, { overwriteExisting: force });
         }
       },
@@ -425,13 +416,9 @@ const handler = async ({ name, force, ...rest }) => {
       {
         title: "Cleaning up...",
         task: () => {
-          execa.sync("yarn", [
-            "eslint",
-            "--fix",
-            "--config",
-            `${getPaths().base}/node_modules/@cedarjs/eslint-config/index.js`,
-            ...Object.keys(packageFiles)
-          ]);
+          runBinSync("eslint", ["--fix", ...Object.keys(packageFiles)], {
+            cwd: getPaths().base
+          });
         }
       }
     ],
@@ -443,9 +430,11 @@ const handler = async ({ name, force, ...rest }) => {
     }
     await tasks.run();
   } catch (e) {
-    errorTelemetry(process.argv, e.message);
-    console.error(c.error(e.message));
-    process.exit(e?.exitCode || 1);
+    const msg = 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, msg);
+    console.error(c.error(msg));
+    process.exit(exitCode);
   }
 };
 export {

package/dist/commands/generate/package/templates/test.ts.template

@@ -1,7 +1,7 @@
 import { ${camelName} } from './index.js'
 
 describe('${camelName}', () => {
-  it('should not throw any errors', async () => {
-    expect(${camelName}()).not.toThrow()
+  it('should not throw any errors', () => {
+    expect(() => ${camelName}()).not.toThrow()
   })
 })

package/dist/commands/generate/package/templates/vitest.config.ts.template

@@ -0,0 +1,9 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    name: '${folderName}',
+    // Enables global test APIs like describe, it, expect
+    globals: true,
+  },
+})

package/dist/commands/generate/page/pageHandler.js

@@ -2,14 +2,14 @@ import { execSync } from "child_process";
 import camelcase from "camelcase";
 import { Listr } from "listr2";
 import pascalcase from "pascalcase";
-import { recordTelemetryAttributes } from "@cedarjs/cli-helpers";
+import { colors as c } from "@cedarjs/cli-helpers/colors";
+import { recordTelemetryAttributes } from "@cedarjs/cli-helpers/telemetry";
 import { generate as generateTypes } from "@cedarjs/internal/dist/generate/generate";
 import { getConfig } from "@cedarjs/project-config";
 import { errorTelemetry } from "@cedarjs/telemetry";
-import c from "../../../lib/colors.js";
 import {
   addRoutesToRouterTask,
-  transformTSToJS,
+  transformTSToJSMap,
   writeFilesTask
 } from "../../../lib/index.js";
 import {
@@ -24,8 +24,8 @@ import {
 } from "../helpers.js";
 import { templateForComponentFile } from "../yargsHandlerHelpers.js";
 const COMPONENT_SUFFIX = "Page";
-const REDWOOD_WEB_PATH_NAME = "pages";
-const mapRouteParamTypeToDefaultValue = (paramType) => {
+const CEDAR_WEB_PATH_NAME = "pages";
+function mapRouteParamTypeToDefaultValue(paramType) {
   switch (paramType) {
     case "Int":
       return 42;
@@ -36,7 +36,7 @@ const mapRouteParamTypeToDefaultValue = (paramType) => {
     default:
       return "42";
   }
-};
+}
 const paramVariants = (path) => {
   const param = path?.match(/(\{[\w:]+\})/)?.[1];
   const paramName = param?.replace(/:[^}]+/, "").slice(1, -1);
@@ -63,13 +63,19 @@ const paramVariants = (path) => {
     paramType: mapRouteParamTypeToTsType(routeParamType)
   };
 };
-const files = async ({ name, tests, stories, typescript, ...rest }) => {
+const files = async ({
+  name,
+  tests,
+  stories,
+  typescript = false,
+  ...rest
+}) => {
   const extension = typescript ? ".tsx" : ".jsx";
   const pageFile = await templateForComponentFile({
     name,
     suffix: COMPONENT_SUFFIX,
     extension,
-    webPathSection: REDWOOD_WEB_PATH_NAME,
+    webPathSection: CEDAR_WEB_PATH_NAME,
     generator: "page",
     templatePath: "page.tsx.template",
     templateVars: {
@@ -81,7 +87,7 @@ const files = async ({ name, tests, stories, typescript, ...rest }) => {
     name,
     suffix: COMPONENT_SUFFIX,
     extension: `.test${extension}`,
-    webPathSection: REDWOOD_WEB_PATH_NAME,
+    webPathSection: CEDAR_WEB_PATH_NAME,
     generator: "page",
     templatePath: "test.tsx.template",
     templateVars: rest
@@ -90,7 +96,7 @@ const files = async ({ name, tests, stories, typescript, ...rest }) => {
     name,
     suffix: COMPONENT_SUFFIX,
     extension: `.stories${extension}`,
-    webPathSection: REDWOOD_WEB_PATH_NAME,
+    webPathSection: CEDAR_WEB_PATH_NAME,
     generator: "page",
     templatePath: rest.paramName !== "" ? "stories.tsx.parameters.template" : "stories.tsx.template",
     templateVars: rest
@@ -102,16 +108,12 @@ const files = async ({ name, tests, stories, typescript, ...rest }) => {
   if (stories) {
     files2.push(storiesFile);
   }
-  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 routes = ({ name, path }) => {
+const routes = ({
+  name,
+  path
+}) => {
   return [
     `<Route path="${path}" page={${pascalcase(name)}Page} name="${camelcase(
       name
@@ -160,7 +162,6 @@ const handler = async ({
           path = pathName(path, pageName);
           const f = await files({
             name: pageName,
-            path,
             tests,
             stories,
             typescript,
@@ -192,7 +193,7 @@ const handler = async ({
       },
       {
         title: "One more thing...",
-        task: (ctx, task) => {
+        task: (_ctx, task) => {
           task.title = `One more thing...
 
    ${c.warning("Page created! A note about <Metadata>:")}
@@ -214,9 +215,11 @@ const handler = async ({
     }
     await tasks.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/generate/realtime/realtime.js

@@ -1,8 +1,8 @@
-import { recordTelemetryAttributes } from "@cedarjs/cli-helpers";
+import { recordTelemetryAttributes } from "@cedarjs/cli-helpers/telemetry";
 const command = "realtime <name>";
 const description = "Generate a subscription or live query used with RedwoodJS Realtime";
 function builder(yargs) {
-  yargs.positional("name", {
+  return yargs.positional("name", {
     type: "string",
     description: "Name of the realtime event to setup. This should be a type or model name like: Widget, Sprocket, etc.",
     demandOption: true

package/dist/commands/generate/realtime/realtimeHandler.js

@@ -2,12 +2,11 @@ import path from "path";
 import camelcase from "camelcase";
 import { Listr } from "listr2";
 import pascalcase from "pascalcase";
-import pluralize, { singular } from "pluralize";
+import pluralize from "pluralize";
 import prompts from "prompts";
+import { colors as c } from "@cedarjs/cli-helpers/colors";
 import { generate as generateTypes } from "@cedarjs/internal/dist/generate/generate";
-import { projectIsEsm } from "@cedarjs/project-config";
 import { errorTelemetry } from "@cedarjs/telemetry";
-import c from "../../../lib/colors.js";
 import {
   generateTemplate,
   getPaths,
@@ -17,7 +16,7 @@ import {
 import { isTypeScriptProject } from "../../../lib/project.js";
 import { isRealtimeSetup, isServerFileSetup } from "../../experimental/util.js";
 const templateVariables = (name) => {
-  name = singular(name.toLowerCase());
+  name = pluralize.singular(name.toLowerCase());
   return {
     name,
     collectionName: pluralize(name),
@@ -35,10 +34,16 @@ const templateVariables = (name) => {
     subscriptionServiceResolver: `publishTo${pascalcase(name)}Channel`
   };
 };
-async function handler({ name, type, force, verbose, silent }) {
-  const redwoodPaths = getPaths();
+async function handler({
+  name,
+  type,
+  force,
+  verbose,
+  silent
+}) {
+  const cedarPaths = getPaths();
   const ts = isTypeScriptProject();
-  name = singular(name.toLowerCase());
+  name = pluralize.singular(name.toLowerCase());
   let functionType = type;
   if (!functionType) {
     const response = await prompts({
@@ -60,12 +65,13 @@ async function handler({ name, type, force, verbose, silent }) {
     });
     functionType = response.functionType;
   }
-  const tasks = new Listr(
-    [
+  function buildTaskData() {
+    return [
       {
         title: "Checking for realtime environment prerequisites ...",
         task: () => {
-          isServerFileSetup() && isRealtimeSetup();
+          isServerFileSetup();
+          isRealtimeSetup();
         }
       },
       {
@@ -80,7 +86,7 @@ async function handler({ name, type, force, verbose, silent }) {
             `blank.sdl.ts.template`
           );
           const sdlFile = path.join(
-            redwoodPaths.api.graphql,
+            cedarPaths.api.graphql,
             `${name}.sdl.${isTypeScriptProject() ? "ts" : "js"}`
           );
           const sdlContent = ts ? exampleSdlTemplateContent : await transformTSToJS(sdlFile, exampleSdlTemplateContent);
@@ -92,7 +98,7 @@ async function handler({ name, type, force, verbose, silent }) {
             `blank.service.ts.template`
           );
           const serviceFile = path.join(
-            redwoodPaths.api.services,
+            cedarPaths.api.services,
             `${name}`,
             `${name}.${isTypeScriptProject() ? "ts" : "js"}`
           );
@@ -105,7 +111,7 @@ async function handler({ name, type, force, verbose, silent }) {
             `blank.ts.template`
           );
           const exampleFile = path.join(
-            redwoodPaths.api.subscriptions,
+            cedarPaths.api.subscriptions,
             `${name}`,
             `${name}.${isTypeScriptProject() ? "ts" : "js"}`
           );
@@ -113,16 +119,10 @@ async function handler({ name, type, force, verbose, silent }) {
             exampleFile,
             exampleSubscriptionTemplateContent
           );
-          let blankTemplateContent = await generateTemplate(
+          const blankTemplateContent = await generateTemplate(
             setupScriptContent,
             templateVariables(name)
           );
-          if (projectIsEsm()) {
-            blankTemplateContent = blankTemplateContent.replace(
-              "import gql from 'graphql-tag'",
-              "import { gql } from 'graphql-tag'"
-            );
-          }
           return [
             writeFile(
               sdlFile,
@@ -156,7 +156,7 @@ async function handler({ name, type, force, verbose, silent }) {
             `blank.sdl.ts.template`
           );
           const sdlFile = path.join(
-            redwoodPaths.api.graphql,
+            cedarPaths.api.graphql,
             `${name}.sdl.${isTypeScriptProject() ? "ts" : "js"}`
           );
           const sdlContent = ts ? exampleSdlTemplateContent : await transformTSToJS(sdlFile, exampleSdlTemplateContent);
@@ -168,7 +168,7 @@ async function handler({ name, type, force, verbose, silent }) {
             "blank.service.ts.template"
           );
           const serviceFile = path.join(
-            redwoodPaths.api.services,
+            cedarPaths.api.services,
             `${name}`,
             `${name}.${isTypeScriptProject() ? "ts" : "js"}`
           );
@@ -200,18 +200,37 @@ async function handler({ name, type, force, verbose, silent }) {
           );
         }
       }
-    ],
-    {
-      rendererOptions: { collapseSubtasks: false, persistentOutput: true },
-      renderer: silent ? "silent" : verbose ? "verbose" : "default"
-    }
-  );
+    ];
+  }
   try {
-    await tasks.run();
+    if (silent) {
+      await new Listr(buildTaskData(), {
+        exitOnError: true,
+        renderer: "silent"
+      }).run();
+    } else if (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/generate/realtime/templates/subscriptions/blank/blank.ts.template

@@ -1,4 +1,4 @@
-import gql from 'graphql-tag'
+import { gql } from 'graphql-tag'
 
 import type { PubSub } from '@cedarjs/realtime'
 

package/dist/commands/generate/scaffold/scaffold.js

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