@cedarjs/cli 0.0.4

package/dist/commands/setup/docker/dockerHandler.js

@@ -0,0 +1,265 @@
+import { createRequire } from "node:module";
+import path from "node:path";
+import execa from "execa";
+import fs from "fs-extra";
+import { Listr } from "listr2";
+import { writeFile } from "@cedarjs/cli-helpers";
+import { getConfig, getConfigPath, getPaths } from "@cedarjs/project-config";
+import { errorTelemetry } from "@cedarjs/telemetry";
+import c from "../../../lib/colors.js";
+async function handler({ force }) {
+  const TEMPLATE_DIR = path.join(import.meta.dirname, "templates");
+  let dockerfileTemplateContent = fs.readFileSync(
+    path.resolve(TEMPLATE_DIR, "Dockerfile"),
+    "utf-8"
+  );
+  const dockerComposeDevTemplateContent = fs.readFileSync(
+    path.resolve(TEMPLATE_DIR, "docker-compose.dev.yml"),
+    "utf-8"
+  );
+  const dockerComposeProdTemplateContent = fs.readFileSync(
+    path.resolve(TEMPLATE_DIR, "docker-compose.prod.yml"),
+    "utf-8"
+  );
+  const dockerignoreTemplateContent = fs.readFileSync(
+    path.resolve(TEMPLATE_DIR, "dockerignore"),
+    "utf-8"
+  );
+  const dockerfilePath = path.join(getPaths().base, "Dockerfile");
+  const dockerComposeDevFilePath = path.join(
+    getPaths().base,
+    "docker-compose.dev.yml"
+  );
+  const dockerComposeProdFilePath = path.join(
+    getPaths().base,
+    "docker-compose.prod.yml"
+  );
+  const dockerignoreFilePath = path.join(getPaths().base, ".dockerignore");
+  const tasks = new Listr(
+    [
+      {
+        title: "Adding the official yarn workspace-tools plugin...",
+        task: async (_ctx, task) => {
+          const { stdout } = await execa.command("yarn plugin runtime --json", {
+            cwd: getPaths().base
+          });
+          const hasWorkspaceToolsPlugin = stdout.trim().split("\n").map(JSON.parse).some(({ name }) => name === "@yarnpkg/plugin-workspace-tools");
+          if (hasWorkspaceToolsPlugin) {
+            task.skip(
+              "The official yarn workspace-tools plugin is already installed"
+            );
+            return;
+          }
+          return execa.command("yarn plugin import workspace-tools", {
+            cwd: getPaths().base
+          }).stdout;
+        }
+      },
+      {
+        title: "Adding @cedarjs/api-server and @cedarjs/web-server...",
+        task: async (_ctx, task) => {
+          const apiServerPackageName = "@cedarjs/api-server";
+          const { dependencies: apiDependencies } = fs.readJSONSync(
+            path.join(getPaths().api.base, "package.json")
+          );
+          const hasApiServerPackage = Object.keys(apiDependencies).includes(apiServerPackageName);
+          const webServerPackageName = "@cedarjs/web-server";
+          const { dependencies: webDependencies } = fs.readJSONSync(
+            path.join(getPaths().web.base, "package.json")
+          );
+          const hasWebServerPackage = Object.keys(webDependencies).includes(webServerPackageName);
+          if (hasApiServerPackage && hasWebServerPackage) {
+            task.skip(
+              `${apiServerPackageName} and ${webServerPackageName} are already installed`
+            );
+            return;
+          }
+          if (!hasApiServerPackage) {
+            const apiServerPackageVersion = await getVersionOfRedwoodPackageToInstall(apiServerPackageName);
+            await execa.command(
+              `yarn workspace api add ${apiServerPackageName}@${apiServerPackageVersion}`,
+              {
+                cwd: getPaths().base
+              }
+            );
+          }
+          if (!hasWebServerPackage) {
+            const webServerPackageVersion = await getVersionOfRedwoodPackageToInstall(webServerPackageName);
+            await execa.command(
+              `yarn workspace web add ${webServerPackageName}@${webServerPackageVersion}`,
+              {
+                cwd: getPaths().base
+              }
+            );
+          }
+          return execa.command(`yarn dedupe`, {
+            cwd: getPaths().base
+          }).stdout;
+        }
+      },
+      {
+        title: "Adding the Dockerfile and compose files...",
+        task: (_ctx, task) => {
+          const shouldSkip = [
+            dockerfilePath,
+            dockerComposeDevFilePath,
+            dockerComposeProdFilePath,
+            dockerignoreFilePath
+          ].every(fs.existsSync);
+          if (!force && shouldSkip) {
+            task.skip("The Dockerfile and compose files already exist");
+            return;
+          }
+          const config = getConfig();
+          const { includeEnvironmentVariables } = config.web;
+          if (includeEnvironmentVariables.length) {
+            const webBuildWithPrerenderStageDelimeter = "FROM api_build as web_build_with_prerender\n";
+            const webBuildStageDelimeter = "FROM base as web_build\n";
+            const [
+              beforeWebBuildWithPrerenderStageDelimeter,
+              afterWebBuildWithPrerenderStageDelimeter
+            ] = dockerfileTemplateContent.split(
+              webBuildWithPrerenderStageDelimeter
+            );
+            const [beforeWebBuildStageDelimeter, afterWebBuildStageDelimeter] = afterWebBuildWithPrerenderStageDelimeter.split(
+              webBuildStageDelimeter
+            );
+            dockerfileTemplateContent = [
+              beforeWebBuildWithPrerenderStageDelimeter.trim(),
+              webBuildWithPrerenderStageDelimeter,
+              ...includeEnvironmentVariables.map((envVar) => `ARG ${envVar}`),
+              "",
+              beforeWebBuildStageDelimeter.trim(),
+              webBuildStageDelimeter,
+              ...includeEnvironmentVariables.map((envVar) => `ARG ${envVar}`),
+              afterWebBuildStageDelimeter
+            ].join("\n");
+          }
+          writeFile(
+            dockerfilePath,
+            dockerfileTemplateContent,
+            {
+              existingFiles: force ? "OVERWRITE" : "SKIP"
+            },
+            task
+          );
+          writeFile(
+            dockerComposeDevFilePath,
+            dockerComposeDevTemplateContent,
+            {
+              existingFiles: force ? "OVERWRITE" : "SKIP"
+            },
+            task
+          );
+          writeFile(
+            dockerComposeProdFilePath,
+            dockerComposeProdTemplateContent,
+            { existingFiles: force ? "OVERWRITE" : "SKIP" },
+            task
+          );
+          writeFile(
+            dockerignoreFilePath,
+            dockerignoreTemplateContent,
+            {
+              existingFiles: force ? "OVERWRITE" : "SKIP"
+            },
+            task
+          );
+        }
+      },
+      {
+        title: "Adding postgres to .gitignore...",
+        task: (_ctx, task) => {
+          const gitignoreFilePath = path.join(getPaths().base, ".gitignore");
+          const gitignoreFileContent = fs.readFileSync(
+            gitignoreFilePath,
+            "utf-8"
+          );
+          if (gitignoreFileContent.includes("postgres")) {
+            task.skip("postgres is already ignored by git");
+            return;
+          }
+          writeFile(
+            gitignoreFilePath,
+            gitignoreFileContent.concat("\npostgres\n"),
+            { existingFiles: "OVERWRITE" }
+          );
+        }
+      },
+      {
+        title: "Adding config to redwood.toml...",
+        task: () => {
+          const redwoodTomlPath = getConfigPath();
+          let configContent = fs.readFileSync(redwoodTomlPath, "utf-8");
+          const browserOpenRegExp = /open\s*=\s*true/;
+          if (browserOpenRegExp.test(configContent)) {
+            configContent = configContent.replace(
+              /open\s*=\s*true/,
+              "open = false"
+            );
+          }
+          writeFile(redwoodTomlPath, configContent, {
+            existingFiles: "OVERWRITE"
+          });
+        }
+      }
+    ],
+    {
+      renderer: process.env.NODE_ENV === "test" ? "verbose" : "default"
+    }
+  );
+  try {
+    await tasks.run();
+    console.log(
+      [
+        "",
+        "We've written four files:",
+        "",
+        "- ./Dockerfile",
+        "- ./.dockerignore",
+        "- ./docker-compose.dev.yml",
+        "- ./docker-compose.prod.yml",
+        "",
+        "To start the docker compose dev:",
+        "",
+        "  docker compose -f docker-compose.dev.yml up ",
+        "",
+        "Then, connect to the container and migrate your database:",
+        "",
+        "  docker compose -f ./docker-compose.dev.yml run --rm -it console /bin/bash",
+        "  root@...:/home/node/app# yarn rw prisma migrate dev",
+        "",
+        "We assume you're using Postgres. If you're not, you'll need to make other changes to switch over.",
+        "Lastly, ensure you have Docker. If you don't, see https://docs.docker.com/desktop/",
+        "",
+        "There's a lot in the Dockerfile and there's a reason for every line.",
+        "Be sure to check out the docs: https://redwoodjs.com/docs/docker"
+      ].join("\n")
+    );
+  } catch (e) {
+    errorTelemetry(process.argv, e.message);
+    console.error(c.error(e.message));
+    process.exit(e?.exitCode || 1);
+  }
+}
+async function getVersionOfRedwoodPackageToInstall(module) {
+  const createdRequire = createRequire(import.meta.url);
+  const packageJsonPath = createdRequire.resolve("@cedarjs/cli/package.json", {
+    paths: [getPaths().base]
+  });
+  let { version } = fs.readJSONSync(packageJsonPath);
+  const packumentP = await fetch(`https://registry.npmjs.org/${module}`);
+  const packument = await packumentP.json();
+  if (version.includes("+")) {
+    version = version.split("+")[0];
+  }
+  const versionIsPublished = Object.keys(packument.versions).includes(version);
+  if (!versionIsPublished) {
+    version = "canary";
+  }
+  return version;
+}
+export {
+  getVersionOfRedwoodPackageToInstall,
+  handler
+};

package/dist/commands/setup/docker/templates/Dockerfile

@@ -0,0 +1,154 @@
+# base
+# ----
+FROM node:20-bookworm-slim as base
+
+RUN corepack enable
+
+# We tried to make the Dockerfile as lean as possible. In some cases, that means we excluded a dependency your project needs.
+# By far the most common is Python. If you're running into build errors because `python3` isn't available,
+# add `python3 make gcc \` before the `openssl \` line below and in other stages as necessary:
+RUN apt-get update && apt-get install -y \
+  openssl \
+  && rm -rf /var/lib/apt/lists/*
+
+USER node
+WORKDIR /home/node/app
+
+COPY --chown=node:node .yarnrc.yml .
+COPY --chown=node:node package.json .
+COPY --chown=node:node api/package.json api/
+COPY --chown=node:node web/package.json web/
+COPY --chown=node:node yarn.lock .
+
+RUN mkdir -p /home/node/.yarn/berry/index
+RUN mkdir -p /home/node/.cache
+
+RUN --mount=type=cache,target=/home/node/.yarn/berry/cache,uid=1000 \
+  --mount=type=cache,target=/home/node/.cache,uid=1000 \
+  CI=1 yarn install
+
+COPY --chown=node:node redwood.toml .
+COPY --chown=node:node graphql.config.js .
+COPY --chown=node:node .env.defaults .env.defaults
+
+# api build
+# ---------
+FROM base as api_build
+
+# If your api side build relies on build-time environment variables,
+# specify them here as ARGs. (But don't put secrets in your Dockerfile!)
+#
+# ARG MY_BUILD_TIME_ENV_VAR
+
+COPY --chown=node:node api api
+RUN yarn rw build api
+
+# web prerender build
+# -------------------
+FROM api_build as web_build_with_prerender
+
+COPY --chown=node:node web web
+RUN yarn rw build web
+
+# web build
+# ---------
+FROM base as web_build
+
+COPY --chown=node:node web web
+RUN yarn rw build web --no-prerender
+
+# api serve
+# ---------
+FROM node:20-bookworm-slim as api_serve
+
+RUN corepack enable
+
+RUN apt-get update && apt-get install -y \
+  openssl \
+  && rm -rf /var/lib/apt/lists/*
+
+USER node
+WORKDIR /home/node/app
+
+COPY --chown=node:node .yarnrc.yml .
+COPY --chown=node:node package.json .
+COPY --chown=node:node api/package.json api/
+COPY --chown=node:node yarn.lock .
+
+RUN mkdir -p /home/node/.yarn/berry/index
+RUN mkdir -p /home/node/.cache
+
+RUN --mount=type=cache,target=/home/node/.yarn/berry/cache,uid=1000 \
+  --mount=type=cache,target=/home/node/.cache,uid=1000 \
+  CI=1 yarn workspaces focus api --production
+
+COPY --chown=node:node redwood.toml .
+COPY --chown=node:node graphql.config.js .
+COPY --chown=node:node .env.defaults .env.defaults
+
+COPY --chown=node:node --from=api_build /home/node/app/api/dist /home/node/app/api/dist
+COPY --chown=node:node --from=api_build /home/node/app/api/db /home/node/app/api/db
+COPY --chown=node:node --from=api_build /home/node/app/node_modules/.prisma /home/node/app/node_modules/.prisma
+
+ENV NODE_ENV=production
+
+# default api serve command
+# ---------
+# If you are using a custom server file, you must use the following
+# command to launch your server instead of the default api-server below.
+# This is important if you intend to configure GraphQL to use Realtime.
+#
+# CMD [ "./api/dist/server.js" ]
+CMD [ "node_modules/.bin/rw-server", "api" ]
+
+# web serve
+# ---------
+FROM node:20-bookworm-slim as web_serve
+
+RUN corepack enable
+
+USER node
+WORKDIR /home/node/app
+
+COPY --chown=node:node .yarnrc.yml .
+COPY --chown=node:node package.json .
+COPY --chown=node:node web/package.json web/
+COPY --chown=node:node yarn.lock .
+
+RUN mkdir -p /home/node/.yarn/berry/index
+RUN mkdir -p /home/node/.cache
+
+RUN --mount=type=cache,target=/home/node/.yarn/berry/cache,uid=1000 \
+  --mount=type=cache,target=/home/node/.cache,uid=1000 \
+  CI=1 yarn workspaces focus web --production
+
+COPY --chown=node:node redwood.toml .
+COPY --chown=node:node graphql.config.js .
+COPY --chown=node:node .env.defaults .env.defaults
+
+COPY --chown=node:node --from=web_build /home/node/app/web/dist /home/node/app/web/dist
+
+ENV NODE_ENV=production \
+  API_PROXY_TARGET=http://api:8911
+
+# We use the shell form here for variable expansion.
+CMD "node_modules/.bin/rw-web-server" "--api-proxy-target" "$API_PROXY_TARGET"
+
+# console
+# -------
+FROM base as console
+
+# To add more packages:
+#
+# ```
+# USER root
+#
+# RUN apt-get update && apt-get install -y \
+#     curl
+#
+# USER node
+# ```
+
+COPY --chown=node:node api api
+COPY --chown=node:node web web
+COPY --chown=node:node scripts scripts

package/dist/commands/setup/docker/templates/docker-compose.dev.yml

@@ -0,0 +1,58 @@
+services:
+  redwood:
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+      target: base
+    command: yarn rw dev
+    volumes:
+      - .:/home/node/app
+      - node_modules:/home/node/app/node_modules
+    ports:
+      - '8910:8910'
+    depends_on:
+      - db
+    environment:
+      - DATABASE_URL=postgresql://redwood:redwood@db:5432/redwood
+      - TEST_DATABASE_URL=postgresql://redwood:redwood@db:5432/redwood_test
+      - SESSION_SECRET=super_secret_session_key_change_me_in_production_please
+      - CI=
+      - NODE_ENV=development
+      - REDWOOD_API_HOST=0.0.0.0
+
+  db:
+    image: postgres:16-bookworm
+    environment:
+      POSTGRES_USER: redwood
+      POSTGRES_PASSWORD: redwood
+      POSTGRES_DB: redwood
+    ports:
+      - '5432:5432'
+    volumes:
+      - postgres:/var/lib/postgresql/data
+
+  # After starting with `docker compose -f ./docker-compose.dev.yml up`,
+  # use the console to run commands in the container:
+  #
+  # ```
+  # docker compose -f ./docker-compose.dev.yml run --rm -it console /bin/bash
+  # root@...:/home/node/app# yarn rw prisma migrate dev
+  # ```
+  console:
+    user: root
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+      target: console
+    tmpfs:
+      - /tmp
+    command: 'true'
+    environment:
+      - DATABASE_URL=postgresql://redwood:redwood@db:5432/redwood
+      - TEST_DATABASE_URL=postgresql://redwood:redwood@db:5432/redwood_test
+    depends_on:
+      - db
+
+volumes:
+  node_modules:
+  postgres:

package/dist/commands/setup/docker/templates/docker-compose.prod.yml

@@ -0,0 +1,63 @@
+services:
+  api:
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+      target: api_serve
+    # Without a command specified, the Dockerfile's api_serve CMD will be used.
+    # If you are using a custom server file, you should either use the following
+    # command to launch your server or update the Dockerfile to do so.
+    # This is important if you intend to configure GraphQL to use Realtime.
+    # command: "./api/dist/server.js"
+    ports:
+      - '8911:8911'
+    depends_on:
+      - db
+    environment:
+      - DATABASE_URL=postgresql://redwood:redwood@db:5432/redwood
+      - TEST_DATABASE_URL=postgresql://redwood:redwood@db:5432/redwood_test
+      - SESSION_SECRET=super_secret_session_key_change_me_in_production_please
+
+  web:
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+      target: web_serve
+    ports:
+      - '8910:8910'
+    depends_on:
+      - api
+    environment:
+      - API_PROXY_TARGET=http://api:8911
+
+  db:
+    image: postgres:16-bookworm
+    environment:
+      POSTGRES_USER: redwood
+      POSTGRES_PASSWORD: redwood
+      POSTGRES_DB: redwood
+    ports:
+      - '5432:5432'
+    volumes:
+      - ./postgres:/var/lib/postgresql/data
+
+  # After starting with `docker compose -f ./docker-compose.prod.yml up`,
+  # use the console to run commands in the container:
+  #
+  # ```
+  # docker compose -f ./docker-compose.prod.yml run --rm -it console /bin/bash
+  # ```
+  console:
+    user: root
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+      target: console
+    tmpfs:
+      - /tmp
+    command: 'true'
+    environment:
+      - DATABASE_URL=postgresql://redwood:redwood@db:5432/redwood
+      - TEST_DATABASE_URL=postgresql://redwood:redwood@db:5432/redwood_test
+    depends_on:
+      - db

package/dist/commands/setup/docker/templates/dockerignore

@@ -0,0 +1,18 @@
+**/node_modules
+**/dist
+.redwood
+
+.env
+
+README.md
+LICENSE
+
+.git
+.gitignore
+
+.vscode
+.editorconfig
+
+Dockerfile
+docker-compose*
+.dockerignore

package/dist/commands/setup/generator/generator.js

@@ -0,0 +1,49 @@
+import path from "path";
+import fs from "fs-extra";
+import terminalLink from "terminal-link";
+import { recordTelemetryAttributes } from "@cedarjs/cli-helpers";
+const command = "generator <name>";
+const description = "Copies generator templates locally for customization";
+const EXCLUDE_GENERATORS = [
+  "dataMigration",
+  "dbAuth",
+  "generator",
+  "script",
+  "secret"
+];
+const builder = (yargs) => {
+  const availableGenerators = fs.readdirSync(path.join(import.meta.dirname, "../../generate"), {
+    withFileTypes: true
+  }).filter((dir) => dir.isDirectory() && !dir.name.match(/__/)).map((dir) => dir.name);
+  yargs.positional("name", {
+    description: "Name of the generator to copy templates from",
+    choices: availableGenerators.filter(
+      (dir) => !EXCLUDE_GENERATORS.includes(dir)
+    )
+  }).option("force", {
+    alias: "f",
+    default: false,
+    description: "Overwrite existing files",
+    type: "boolean"
+  }).epilogue(
+    `Also see the ${terminalLink(
+      "Redwood CLI Reference",
+      "https://redwoodjs.com/docs/cli-commands#setup-generator"
+    )}`
+  );
+};
+const handler = async (options) => {
+  recordTelemetryAttributes({
+    command: "setup generator",
+    name: options.name,
+    force: options.force
+  });
+  const { handler: handler2 } = await import("./generatorHandler.js");
+  return handler2(options);
+};
+export {
+  builder,
+  command,
+  description,
+  handler
+};

package/dist/commands/setup/generator/generatorHandler.js

@@ -0,0 +1,55 @@
+import path from "path";
+import fse from "fs-extra";
+import { Listr } from "listr2";
+import c from "../../../lib/colors.js";
+import { getPaths } from "../../../lib/index.js";
+const SIDE_MAP = {
+  web: ["cell", "component", "layout", "page", "scaffold"],
+  api: ["function", "sdl", "service"]
+};
+const copyGenerator = (name, { force }) => {
+  const side = SIDE_MAP["web"].includes(name) ? "web" : "api";
+  const from = path.join(
+    import.meta.dirname,
+    "../../generate",
+    name,
+    "templates"
+  );
+  const to = path.join(getPaths()[side].generators, name);
+  fse.copySync(from, to, { overwrite: force, errorOnExist: true });
+  return to;
+};
+let destination;
+const tasks = ({ name, force }) => {
+  return new Listr(
+    [
+      {
+        title: "Copying generator templates...",
+        task: () => {
+          destination = copyGenerator(name, { force });
+        }
+      },
+      {
+        title: "Destination:",
+        task: (ctx, task) => {
+          task.title = `  Wrote templates to ${destination.replace(
+            getPaths().base,
+            ""
+          )}`;
+        }
+      }
+    ],
+    { rendererOptions: { collapseSubtasks: false }, errorOnExist: true }
+  );
+};
+const handler = async ({ name, force }) => {
+  const t = tasks({ name, force });
+  try {
+    await t.run();
+  } catch (e) {
+    console.log(c.error(e.message));
+  }
+};
+export {
+  handler
+};