@cedarjs/cli 0.0.4

package/dist/commands/setup/graphql/features/fragments/appGqlConfigTransform.js

@@ -0,0 +1,117 @@
+function isJsxExpressionContainer(node) {
+  return node.type === "JSXExpressionContainer";
+}
+function isObjectExpression(node) {
+  return node.type === "ObjectExpression";
+}
+function isObjectProperty(node) {
+  return node.type === "ObjectProperty";
+}
+function isIdentifier(node) {
+  return node.type === "Identifier";
+}
+function isPropertyWithName(node, name) {
+  return isObjectProperty(node) && node.key.type === "Identifier" && node.key.name === name;
+}
+function transform(file, api) {
+  const j = api.jscodeshift;
+  const root = j(file.source);
+  const redwoodApolloProvider = root.findJSXElements("RedwoodApolloProvider");
+  const graphQLClientConfigCollection = redwoodApolloProvider.find(
+    j.JSXAttribute,
+    {
+      name: { name: "graphQLClientConfig" }
+    }
+  );
+  let graphQLClientConfig;
+  if (graphQLClientConfigCollection.length === 0) {
+    graphQLClientConfig = j.jsxAttribute(
+      j.jsxIdentifier("graphQLClientConfig"),
+      j.jsxExpressionContainer(j.objectExpression([]))
+    );
+  } else {
+    graphQLClientConfig = graphQLClientConfigCollection.get(0).node;
+  }
+  const graphQLClientConfigExpression = isJsxExpressionContainer(
+    graphQLClientConfig.value
+  ) ? graphQLClientConfig.value.expression : j.jsxEmptyExpression();
+  let graphQLClientConfigVariableName = "";
+  if (isIdentifier(graphQLClientConfigExpression)) {
+    graphQLClientConfigVariableName = graphQLClientConfigExpression.name;
+  }
+  if (!graphQLClientConfigVariableName && !isObjectExpression(graphQLClientConfigExpression)) {
+    throw new Error(
+      "Error configuring possibleTypes. You'll have to do it manually. (Could not find a graphQLClientConfigExpression of the correct type, it's a " + graphQLClientConfigExpression.type + ")"
+    );
+  }
+  if (isObjectExpression(graphQLClientConfigExpression)) {
+    graphQLClientConfigVariableName = "graphQLClientConfig";
+    root.find(j.VariableDeclaration, {
+      declarations: [
+        {
+          type: "VariableDeclarator",
+          id: { type: "Identifier", name: "App" }
+        }
+      ]
+    }).insertBefore(
+      j.variableDeclaration("const", [
+        j.variableDeclarator(
+          j.identifier(graphQLClientConfigVariableName),
+          graphQLClientConfigExpression
+        )
+      ])
+    );
+  }
+  const configVariableDeclarators = root.findVariableDeclarators(
+    graphQLClientConfigVariableName
+  );
+  const configExpression = configVariableDeclarators.get(0)?.node.init;
+  if (!isObjectExpression(configExpression)) {
+    throw new Error(
+      "Error configuring possibleTypes. You'll have to do it manually. (Could not find a graphQLClientConfig variable ObjectExpression)"
+    );
+  }
+  let cacheConfig = configExpression.properties.find(
+    (prop) => isPropertyWithName(prop, "cacheConfig")
+  );
+  if (!cacheConfig) {
+    cacheConfig = j.objectProperty(
+      j.identifier("cacheConfig"),
+      j.objectExpression([])
+    );
+    configExpression.properties.push(cacheConfig);
+  }
+  if (!isObjectProperty(cacheConfig)) {
+    throw new Error(
+      "Error configuring possibleTypes. You'll have to do it manually. (cacheConfig is not an ObjectProperty)"
+    );
+  }
+  const cacheConfigValue = cacheConfig.value;
+  if (!isObjectExpression(cacheConfigValue)) {
+    throw new Error(
+      "Error configuring possibleTypes. You'll have to do it manually. (cacheConfigValue is not an ObjectExpression)"
+    );
+  }
+  const possibleTypes = cacheConfigValue.properties.find(
+    (prop) => isPropertyWithName(prop, "possibleTypes")
+  );
+  if (!possibleTypes) {
+    const property = j.property(
+      "init",
+      j.identifier("possibleTypes"),
+      j.identifier("possibleTypes.possibleTypes")
+    );
+    cacheConfigValue.properties.push(property);
+  }
+  graphQLClientConfigCollection.remove();
+  redwoodApolloProvider.get(0).node.openingElement.attributes.push(
+    j.jsxAttribute(
+      j.jsxIdentifier("graphQLClientConfig"),
+      j.jsxExpressionContainer(j.identifier(graphQLClientConfigVariableName))
+    )
+  );
+  return root.toSource();
+}
+export {
+  transform as default
+};

package/dist/commands/setup/graphql/features/fragments/appImportTransform.js

@@ -0,0 +1,20 @@
+function transform(file, api) {
+  const j = api.jscodeshift;
+  const root = j(file.source);
+  const possibleTypesImports = root.find(j.ImportDeclaration);
+  const hasPossibleTypesImport = possibleTypesImports.some((i) => {
+    return i.get("source").value.value === "src/graphql/possibleTypes" || i.get("source").value.value === "./graphql/possibleTypes";
+  });
+  if (!hasPossibleTypesImport) {
+    possibleTypesImports.at(1).insertAfter(
+      j.importDeclaration(
+        [j.importDefaultSpecifier(j.identifier("possibleTypes"))],
+        j.literal("src/graphql/possibleTypes")
+      )
+    );
+  }
+  return root.toSource();
+}
+export {
+  transform as default
+};

package/dist/commands/setup/graphql/features/fragments/fragments.js

@@ -0,0 +1,25 @@
+import { recordTelemetryAttributes } from "@cedarjs/cli-helpers";
+const command = "fragments";
+const description = "Set up Fragments for GraphQL";
+function builder(yargs) {
+  return yargs.option("force", {
+    alias: "f",
+    default: false,
+    description: "Overwrite existing configuration",
+    type: "boolean"
+  });
+}
+async function handler({ force }) {
+  recordTelemetryAttributes({
+    command: "setup graphql fragments",
+    force
+  });
+  const { handler: handler2 } = await import("./fragmentsHandler.js");
+  return handler2({ force });
+}
+export {
+  builder,
+  command,
+  description,
+  handler
+};

package/dist/commands/setup/graphql/features/fragments/fragmentsHandler.js

@@ -0,0 +1,89 @@
+import fs from "node:fs";
+import path from "node:path";
+import execa from "execa";
+import { Listr } from "listr2";
+import { format } from "prettier";
+import {
+  colors,
+  getPrettierOptions,
+  setTomlSetting
+} from "@cedarjs/cli-helpers";
+import { getConfig, getPaths } from "@cedarjs/project-config";
+import { runTransform } from "../../../../../lib/runTransform.js";
+const command = "fragments";
+const description = "Set up Fragments for GraphQL";
+async function handler({ force }) {
+  const tasks = new Listr(
+    [
+      {
+        title: "Update Redwood Project Configuration to enable GraphQL Fragments",
+        skip: () => {
+          if (force) {
+            return false;
+          }
+          const config = getConfig();
+          if (config.graphql.fragments) {
+            return "GraphQL Fragments are already enabled.";
+          }
+          return false;
+        },
+        task: () => {
+          setTomlSetting("graphql", "fragments", true);
+        }
+      },
+      {
+        title: "Generate possibleTypes.ts",
+        task: () => {
+          execa.commandSync("yarn redwood generate types", { stdio: "ignore" });
+        }
+      },
+      {
+        title: "Import possibleTypes in App.tsx",
+        task: () => {
+          return runTransform({
+            transformPath: path.join(
+              import.meta.dirname,
+              "appImportTransform.js"
+            ),
+            targetPaths: [getPaths().web.app]
+          });
+        }
+      },
+      {
+        title: "Add possibleTypes to the GraphQL cache config",
+        task: async () => {
+          const transformResult = await runTransform({
+            transformPath: path.join(
+              import.meta.dirname,
+              "appGqlConfigTransform.js"
+            ),
+            targetPaths: [getPaths().web.app]
+          });
+          if (transformResult.error) {
+            throw new Error(transformResult.error);
+          }
+          const appPath = getPaths().web.app;
+          const source = fs.readFileSync(appPath, "utf-8");
+          const prettierOptions = await getPrettierOptions();
+          const prettifiedApp = await format(source, {
+            ...prettierOptions,
+            parser: "babel-ts"
+          });
+          fs.writeFileSync(getPaths().web.app, prettifiedApp, "utf-8");
+        }
+      }
+    ],
+    { rendererOptions: { collapseSubtasks: false } }
+  );
+  try {
+    await tasks.run();
+  } catch (e) {
+    console.error(colors.error(e.message));
+    process.exit(e?.exitCode || 1);
+  }
+}
+export {
+  command,
+  description,
+  handler
+};

package/dist/commands/setup/graphql/features/trustedDocuments/graphqlTransform.js

@@ -0,0 +1,51 @@
+function transform(file, api) {
+  const j = api.jscodeshift;
+  const root = j(file.source);
+  const allImports = root.find(j.ImportDeclaration);
+  const hasStoreImport = allImports.some((i) => {
+    return i.get("source").value.value === "src/lib/trustedDocumentsStore";
+  });
+  if (!hasStoreImport) {
+    allImports.at(-1).insertAfter(
+      j.importDeclaration(
+        [j.importSpecifier(j.identifier("store"))],
+        j.literal("src/lib/trustedDocumentsStore")
+      )
+    );
+  }
+  const createGraphQLHandlerCalls = root.find(j.CallExpression, {
+    callee: {
+      name: "createGraphQLHandler"
+    }
+  });
+  if (createGraphQLHandlerCalls.length === 0) {
+    throw new Error(
+      "Error updating your graphql handler function. You'll have to do it manually. (Couldn't find a call to `createGraphQLHandler`)"
+    );
+  }
+  const existingTrustedDocumentsProperty = createGraphQLHandlerCalls.find(
+    j.ObjectProperty,
+    {
+      key: {
+        name: "trustedDocuments"
+      }
+    }
+  );
+  if (existingTrustedDocumentsProperty.length === 0) {
+    const storeProperty = j.objectProperty(
+      j.identifier("store"),
+      j.identifier("store")
+    );
+    storeProperty.shorthand = true;
+    createGraphQLHandlerCalls.get(0).node.arguments[0].properties.push(
+      j.objectProperty(
+        j.identifier("trustedDocuments"),
+        j.objectExpression([storeProperty])
+      )
+    );
+  }
+  return root.toSource();
+}
+export {
+  transform as default
+};

package/dist/commands/setup/graphql/features/trustedDocuments/trustedDocuments.js

@@ -0,0 +1,25 @@
+import { recordTelemetryAttributes } from "@cedarjs/cli-helpers";
+const command = "trusted-documents";
+const description = "Set up Trusted Documents for GraphQL";
+function builder(yargs) {
+  return yargs.option("force", {
+    alias: "f",
+    default: false,
+    description: "Overwrite existing configuration",
+    type: "boolean"
+  });
+}
+async function handler({ force }) {
+  recordTelemetryAttributes({
+    command: "setup graphql trusted-documents",
+    force
+  });
+  const { handler: handler2 } = await import("./trustedDocumentsHandler.js");
+  return handler2({ force });
+}
+export {
+  builder,
+  command,
+  description,
+  handler
+};

package/dist/commands/setup/graphql/features/trustedDocuments/trustedDocumentsHandler.js

@@ -0,0 +1,74 @@
+import fs from "node:fs";
+import path from "node:path";
+import execa from "execa";
+import { Listr } from "listr2";
+import { format } from "prettier";
+import { getPrettierOptions, setTomlSetting } from "@cedarjs/cli-helpers";
+import { getConfig, getPaths, resolveFile } from "@cedarjs/project-config";
+import { runTransform } from "../../../../../lib/runTransform.js";
+async function handler({ force }) {
+  const tasks = new Listr(
+    [
+      {
+        title: "Update Redwood Project Configuration to enable GraphQL Trusted Documents ...",
+        skip: () => {
+          if (force) {
+            return false;
+          }
+          const config = getConfig();
+          if (config.graphql.trustedDocuments) {
+            return "GraphQL Trusted Documents are already enabled in your Redwood project.";
+          }
+          return false;
+        },
+        task: () => {
+          setTomlSetting("graphql", "trustedDocuments", true);
+        }
+      },
+      {
+        title: "Generating Trusted Documents store ...",
+        task: () => {
+          execa.commandSync("yarn redwood generate types", { stdio: "ignore" });
+        }
+      },
+      {
+        title: "Configuring the GraphQL Handler to use a Trusted Documents store ...",
+        task: async () => {
+          const graphqlPath = resolveFile(
+            path.join(getPaths().api.functions, "graphql")
+          );
+          if (!graphqlPath) {
+            throw new Error("Could not find a GraphQL handler in your project.");
+          }
+          const transformResult = await runTransform({
+            transformPath: path.join(
+              import.meta.dirname,
+              "graphqlTransform.js"
+            ),
+            targetPaths: [graphqlPath]
+          });
+          if (transformResult.error) {
+            throw new Error(transformResult.error);
+          }
+          const source = fs.readFileSync(graphqlPath, "utf-8");
+          const prettierOptions = await getPrettierOptions();
+          const prettifiedApp = await format(source, {
+            ...prettierOptions,
+            parser: "babel-ts"
+          });
+          fs.writeFileSync(graphqlPath, prettifiedApp, "utf-8");
+        }
+      }
+    ],
+    { rendererOptions: { collapseSubtasks: false } }
+  );
+  try {
+    await tasks.run();
+  } catch (e) {
+    console.error(e.message);
+    process.exit(e?.exitCode || 1);
+  }
+}
+export {
+  handler
+};

package/dist/commands/setup/graphql/graphql.js

@@ -0,0 +1,18 @@
+import terminalLink from "terminal-link";
+import * as fragmentsCommand from "./features/fragments/fragments.js";
+import * as trustedDocumentsCommand from "./features/trustedDocuments/trustedDocuments.js";
+const command = "graphql <feature>";
+const description = "Set up GraphQL feature support";
+function builder(yargs) {
+  return yargs.command(fragmentsCommand).command(trustedDocumentsCommand).epilogue(
+    `Also see the ${terminalLink(
+      "Redwood CLI Reference",
+      "https://redwoodjs.com/docs/cli-commands#setup-graphql"
+    )}`
+  );
+}
+export {
+  builder,
+  command,
+  description
+};

package/dist/commands/setup/i18n/i18n.js

@@ -0,0 +1,25 @@
+import { recordTelemetryAttributes } from "@cedarjs/cli-helpers";
+const command = "i18n";
+const description = "Set up i18n";
+const builder = (yargs) => {
+  yargs.option("force", {
+    alias: "f",
+    default: false,
+    description: "Overwrite existing configuration",
+    type: "boolean"
+  });
+};
+const handler = async (options) => {
+  recordTelemetryAttributes({
+    command: "setup i18n",
+    force: options.force
+  });
+  const { handler: handler2 } = await import("./i18nHandler.js");
+  return handler2(options);
+};
+export {
+  builder,
+  command,
+  description,
+  handler
+};

package/dist/commands/setup/i18n/i18nHandler.js

@@ -0,0 +1,169 @@
+import path from "path";
+import execa from "execa";
+import fs from "fs-extra";
+import { Listr } from "listr2";
+import { errorTelemetry } from "@cedarjs/telemetry";
+import c from "../../../lib/colors.js";
+import extendStorybookConfiguration from "../../../lib/configureStorybook.js";
+import { fileIncludes } from "../../../lib/extendFile.js";
+import { getPaths, writeFile } from "../../../lib/index.js";
+const APP_JS_PATH = getPaths().web.app;
+const i18nImportExist = (appJS) => {
+  let content = appJS.toString();
+  const hasBaseImport = () => /import '.\/i18n'/.test(content);
+  return hasBaseImport();
+};
+const addI18nImport = (appJS) => {
+  var content = appJS.toString().split("\n").reverse();
+  const index = content.findIndex((value) => /import/.test(value));
+  content.splice(index, 0, "import './i18n'");
+  return content.reverse().join(`
+`);
+};
+const i18nConfigExists = () => {
+  return fs.existsSync(path.join(getPaths().web.src, "i18n.js"));
+};
+const localesExists = (lng) => {
+  return fs.existsSync(path.join(getPaths().web.src, "locales", lng + ".json"));
+};
+const handler = async ({ force }) => {
+  const rwPaths = getPaths();
+  const tasks = new Listr(
+    [
+      {
+        title: "Installing packages...",
+        task: async () => {
+          return new Listr(
+            [
+              {
+                title: "Install i18next, react-i18next and i18next-browser-languagedetector",
+                task: async () => {
+                  await execa("yarn", [
+                    "workspace",
+                    "web",
+                    "add",
+                    "i18next",
+                    "react-i18next",
+                    "i18next-browser-languagedetector"
+                  ]);
+                }
+              }
+            ],
+            { rendererOptions: { collapseSubtasks: false } }
+          );
+        }
+      },
+      {
+        title: "Configure i18n...",
+        task: () => {
+          if (!force && i18nConfigExists()) {
+            throw new Error(
+              "i18n config already exists.\nUse --force to override existing config."
+            );
+          } else {
+            return writeFile(
+              path.join(getPaths().web.src, "i18n.js"),
+              fs.readFileSync(
+                path.resolve(
+                  import.meta.dirname,
+                  "templates",
+                  "i18n.js.template"
+                )
+              ).toString(),
+              { overwriteExisting: force }
+            );
+          }
+        }
+      },
+      {
+        title: "Adding locale file for French...",
+        task: () => {
+          if (!force && localesExists("fr")) {
+            throw new Error(
+              "fr.json config already exists.\nUse --force to override existing config."
+            );
+          } else {
+            return writeFile(
+              path.join(getPaths().web.src, "/locales/fr.json"),
+              fs.readFileSync(
+                path.resolve(
+                  import.meta.dirname,
+                  "templates",
+                  "fr.json.template"
+                )
+              ).toString(),
+              { overwriteExisting: force }
+            );
+          }
+        }
+      },
+      {
+        title: "Adding locale file for English...",
+        task: () => {
+          if (!force && localesExists("en")) {
+            throw new Error(
+              "en.json already exists.\nUse --force to override existing config."
+            );
+          } else {
+            return writeFile(
+              path.join(getPaths().web.src, "/locales/en.json"),
+              fs.readFileSync(
+                path.resolve(
+                  import.meta.dirname,
+                  "templates",
+                  "en.json.template"
+                )
+              ).toString(),
+              { overwriteExisting: force }
+            );
+          }
+        }
+      },
+      {
+        title: "Adding import to App.{jsx,tsx}...",
+        task: (_ctx, task) => {
+          let appJS = fs.readFileSync(APP_JS_PATH);
+          if (i18nImportExist(appJS)) {
+            task.skip("Import already exists in App.js");
+          } else {
+            fs.writeFileSync(APP_JS_PATH, addI18nImport(appJS));
+          }
+        }
+      },
+      {
+        title: "Configuring Storybook...",
+        // skip this task if the user's storybook config already includes "withI18n"
+        skip: () => fileIncludes(rwPaths.web.storybookConfig, "withI18n"),
+        task: async () => extendStorybookConfiguration(
+          path.join(
+            import.meta.dirname,
+            "templates",
+            "storybook.preview.tsx.template"
+          )
+        )
+      },
+      {
+        title: "One more thing...",
+        task: (_ctx, task) => {
+          task.title = `One more thing...
+
+          ${c.tip("Quick link to the docs:")}
+
+          ${c.link("https://react.i18next.com/guides/quick-start/")}
+        `;
+        }
+      }
+    ],
+    { rendererOptions: { collapseSubtasks: false } }
+  );
+  try {
+    await tasks.run();
+  } catch (e) {
+    errorTelemetry(process.argv, e.message);
+    console.error(c.error(e.message));
+    process.exit(e?.exitCode || 1);
+  }
+};
+export {
+  handler
+};

package/dist/commands/setup/i18n/templates/en.json.template

@@ -0,0 +1,11 @@
+{
+  "Welcome to Cedar": "Welcome to Cedar",
+  "info": "This is your English translation file",
+  "see": "https://www.i18next.com/translation-function/essentials",
+  "HomePage": {
+    "title": "Home Page",
+    "info": "Find me in",
+    "route": "My default route is named",
+    "link": "link to me with"
+  }
+}

package/dist/commands/setup/i18n/templates/fr.json.template

@@ -0,0 +1,11 @@
+{
+  "Welcome to Cedar": "Bienvenu sur Cedar",
+  "info": "Ceci est votre fichier de traduction",
+  "see": "https://www.i18next.com/translation-function/essentials",
+  "HomePage": {
+    "title": "Page d'accueil",
+    "info": "Trouve moi dans",
+    "route": "Ma route par default se nomme",
+    "link": "le lien vers moi avec"
+  }
+}