create-mfe-kit/lib/scaffold.js

CLI to scaffold Micro Frontend apps using Module Federation

import { ask } from "./util/cliPrompts.js";
import fs from "fs-extra";
import path from "path";
import ora from "ora";
import chalk from "chalk";
import { fileURLToPath } from "url";

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);

const TEMPLATE_BASE = path.resolve(__dirname, "../templates");

/**
 * Scafolds a new MFE project.
 *
 * prompts the user for the project name and the state library,
 * copies the selected template, and provides post setup instructions.
 *
 * @async
 * @function
 * @returns {Promise<void>}
 *
 */
export async function mfeScaffold() {
  try {
    console.log(chalk.cyan("\n Welcome to create-mfe-kit"));

    const { projectName } = await ask({
      type: "text",
      name: "projectName",
      message: "Project name:",
      validate: (name) => (name ? true : "Name cannot be empty"),
    });

    const { stateLib } = await ask({
      type: "select",
      name: "stateLib",
      message: "Choose a shared state management library:",
      choices: [
        { title: "None", value: "base" },
        { title: "Redux Toolkit", value: "with-redux" },
        { title: "Zustand (WIP)", value: "with-zustand" },
      ],
    });

    const selectedTemplateDir = path.resolve(
      TEMPLATE_BASE,
      `../templates/${stateLib}`
    );

    const targetDir = path.resolve(process.cwd(), projectName);

    const spinner = ora("Creating project...").start();

    await fs.copy(selectedTemplateDir, targetDir);

    spinner.succeed("Project created successfully!");

    console.log(chalk.green("\n Project created at:"), chalk.yellow(targetDir));
    console.log(chalk.cyan("\n Run the following to get started\n"));
    console.log(`  cd ${projectName}`);
    console.log(chalk.white(`  cd container >> npm install >> npm start`));
    console.log(chalk.cyan("\n In a new terminal:"));
    console.log(chalk.white(`  cd app1 >> npm install >> npm start`));
  } catch (err) {
    console.error(chalk.red("Failed to scaffold project:"), err.message);
    process.exit(1);
  }
}