@defer/redwood/esm/plugin/tasks.js

Setup Defer in RedwoodJS

import path from "path";
import execa from "execa";
import { Listr } from "listr2";
import fs from "fs-extra";
import { getPaths, writeFile } from "@redwoodjs/cli-helpers";
import { getConfigPath } from "@redwoodjs/project-config";
export const tasks = (options) => {
    const SRC_DEFER_PATH = path.join(getPaths().api.src, "jobs", "defer");
    const SRC_DEFER_CLIENT_PATH_FILE = path.join(getPaths().api.src, "jobs", "clients", "defer.ts");
    const commandPaths = {
        SRC_DEFER_PATH,
        SRC_DEFER_CLIENT_PATH_FILE,
    };
    const existingFiles = options.force ? "OVERWRITE" : "FAIL";
    return new Listr([
        {
            title: "Install Defer packages ...",
            task: () => {
                execa.commandSync("yarn workspace api add @defer/client", process.env["RWJS_CWD"]
                    ? {
                        cwd: process.env["RWJS_CWD"],
                    }
                    : {});
            },
        },
        {
            title: "Adding config to redwood.toml...",
            task: () => {
                updateTomlConfig();
            },
        },
        {
            title: "Configure Defer client ...",
            task: () => {
                configureDeferClient({ commandPaths, existingFiles });
            },
        },
        {
            title: "Add Defer helloWorld function example ...",
            task: () => {
                addDeferHelloWorldExampleTask({ commandPaths, existingFiles });
            },
        },
    ], { rendererOptions: {} });
};
export const addDeferHelloWorldExampleTask = ({ commandPaths, existingFiles, }) => {
    // save example Defer function in the defer folder
    fs.ensureDirSync(commandPaths["SRC_DEFER_PATH"]);
    const deferHelloWorldTemplate = fs.readFileSync(path.resolve(__dirname, "..", "..", "templates", "plugin", "helloWorld.ts.template"), "utf-8");
    return writeFile(path.join(commandPaths["SRC_DEFER_PATH"], "helloWorld.ts"), deferHelloWorldTemplate, {
        existingFiles,
    });
};
export const configureDeferClient = ({ commandPaths, existingFiles, }) => {
    const deferHelloWorldTemplate = fs.readFileSync(path.resolve(__dirname, "..", "..", "templates", "plugin", "client.ts.template"), "utf-8");
    return writeFile(commandPaths["SRC_DEFER_CLIENT_PATH_FILE"], deferHelloWorldTemplate, {
        existingFiles,
    });
};
const tomlString = `
[experimental.cli]
  autoInstall = false
  [[experimental.cli.plugins]]
    package = "@defer/redwood"`;
export const updateTomlConfig = () => {
    const redwoodTomlPath = getConfigPath();
    const configContent = fs.readFileSync(redwoodTomlPath, "utf-8");
    if (!configContent.includes("@defer/redwood")) {
        writeFile(redwoodTomlPath, configContent.concat(tomlString), {
            existingFiles: "OVERWRITE",
        });
    }
};