mfer 0.0.0-alpha.1 → 0.0.0-alpha.3

package/README.md

@@ -1,19 +1,25 @@
-# Micro Frontend Runner (mfer)
+# mfer (Micro-frontend Runner)
 
 A CLI tool that helps manage and run multiple micro frontends.
 
-## Development
+Created with: 
+- inquirer, for prompting
+- commander, for cli
+- chalk, for colors
+- concurrently, for running commands
 
-### Getting Started
+```
+Usage: mfer [options] [command]
 
-1. Run `npm i` to install dependencies.
-2. Run `npm run build` to build the project.
-3. Run `npm install -g .` to link the project globally.
-4. Now you can run the CLI as `mfer` for locally development anywhere on your system. Try `mfer --help` to begin.
-5. Updating the code will require another `npm run build`.
+Micro Frontend Runner (mfer) - A CLI for running your project's micro frontends.
 
-### Troubleshooting
+Options:
+  -v, --version     mfer CLI version
+  -h, --help        display help for command
 
-If you run into problems first check `npm list -g` if the project is successfully linked globally.
-
-Sometimes you may need to run `npm uninstall -g run-mfs` and then follow up with another `npm install -g .` within the project's root directory.
+Commands:
+  config            configuration settings
+  init              setup a new configuration
+  run [group_name]  run micro-frontend applications
+  help [command]    display help for command
+```

package/dist/commands/config/sub-commands/edit-config.js

@@ -1,24 +1,21 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { Command } from "commander";
-import YAML from "yaml";
-import { configExists, currentConfig, editConfigAsync, saveConfig, warnOfMissingConfig, } from "../../../utils/config-utils.js";
+import { configExists, configPath, warnOfMissingConfig } from "../../../utils/config-utils.js";
+import chalk from "chalk";
+import { spawn } from "child_process";
+import * as os from "os";
 export const editConfigCommand = new Command("edit")
-    .description("edit configuration")
-    .action(() => __awaiter(void 0, void 0, void 0, function* () {
-    if (configExists) {
-        const answer = yield editConfigAsync("edit configuration file, this will overwrite your existing configuration", currentConfig);
-        const newConfig = YAML.parse(answer);
-        saveConfig(newConfig);
-    }
-    else {
+    .description("edit configuration in your preferred editor")
+    .action(() => {
+    if (!configExists) {
         warnOfMissingConfig();
+        return;
     }
-}));
+    const editor = process.env.EDITOR || process.env.VISUAL || (os.platform() === "win32" ? "notepad" : "vi");
+    console.log(chalk.green(`Opening config file in editor: ${editor}\n`));
+    spawn(editor, [configPath], {
+        stdio: "ignore",
+        detached: true,
+        shell: true
+    }).unref();
+    process.exit(0);
+});

package/dist/commands/config/sub-commands/list-config.js

@@ -1,7 +1,12 @@
 import { Command } from "commander";
-import { currentConfig } from "../../../utils/config-utils.js";
+import { configExists, currentConfig, warnOfMissingConfig, } from "../../../utils/config-utils.js";
 export const listConfigCommand = new Command("list")
     .description("display the current configuration settings")
     .action(() => {
-    console.log(currentConfig);
+    if (configExists) {
+        console.log(currentConfig);
+    }
+    else {
+        warnOfMissingConfig();
+    }
 });

package/dist/commands/init.js

@@ -8,9 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { Command } from "commander";
-import { configExists, editConfigAsync, saveConfig, } from "../utils/config-utils.js";
-import YAML from "yaml";
+import { configExists, editConfig, } from "../utils/config-utils.js";
+import chalk from "chalk";
+import * as fs from "fs";
+import { input, confirm, checkbox } from "@inquirer/prompts";
 const templateConfig = {
+    base_github_url: "https://github.com/your-username",
     mfe_directory: "path/to/folder/containing/microfrontends",
     groups: {
         all: ["repo_name_1", "repo_name_2", "repo_name_3"],
@@ -21,12 +24,53 @@ const initCommand = new Command("init")
     .description("setup a new configuration")
     .action((options) => __awaiter(void 0, void 0, void 0, function* () {
     if (!configExists) {
-        const answer = yield editConfigAsync("create a new configuration file", templateConfig);
-        const newConfig = YAML.parse(answer);
-        saveConfig(newConfig);
+        const usesGithub = yield confirm({
+            message: "Do you use GitHub to host your repositories?",
+            default: true,
+        });
+        if (!usesGithub) {
+            console.log(chalk.red("Currently, only GitHub is supported for repository hosting. Other providers are not yet supported."));
+            return;
+        }
+        const githubUsername = yield input({
+            message: "What is your GitHub username?",
+            validate: (val) => val && val.trim() !== "" ? true : "Username cannot be empty"
+        });
+        const mfeDirectory = yield input({
+            message: [
+                "Enter the path to the folder containing all your micro frontends.",
+                "  (Tip: Drag a folder from your file explorer into this terminal to paste its path)",
+                "  >>>"
+            ].join("\n"),
+            validate: (val) => val && val.trim() !== "" ? true : "Folder path cannot be empty"
+        });
+        let allGroup = [];
+        let promptMessage = "Add the names of your micro frontends to the 'groups' section.";
+        try {
+            if (fs.existsSync(mfeDirectory) && fs.statSync(mfeDirectory).isDirectory()) {
+                const entries = fs.readdirSync(mfeDirectory, { withFileTypes: true });
+                const folders = entries.filter(e => e.isDirectory()).map(e => e.name);
+                if (folders.length > 0) {
+                    allGroup = yield checkbox({
+                        message: "Select which folders to include in the default 'all' group:",
+                        choices: folders.map(f => ({ name: f, value: f })),
+                        validate: (arr) => arr.length > 0 ? true : "Select at least one folder"
+                    });
+                    promptMessage = "";
+                }
+            }
+        }
+        catch (e) {
+        }
+        if (promptMessage) {
+            console.log(promptMessage);
+            editConfig();
+        }
     }
     else {
-        console.log("config already exists, you can edit it with 'mfer config edit'");
+        const messagePrefix = chalk.red("Error");
+        const mferCommandHint = chalk.blue("mfer config edit");
+        console.log(`${messagePrefix}: config already exists, you can edit it with ${mferCommandHint}`);
     }
 }));
 export default initCommand;

package/dist/commands/install.js

@@ -0,0 +1,73 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { Command } from "commander";
+import { configExists, currentConfig, warnOfMissingConfig, } from "../utils/config-utils.js";
+import chalk from "chalk";
+import path from "path";
+import { spawnSync } from "child_process";
+const installCommand = new Command("install")
+    .description("run 'npm install' in micro-frontend applications synchronously")
+    .argument("[group_name]", "name of the group as specified in the configuration", "all")
+    .action((groupName) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!configExists) {
+        warnOfMissingConfig();
+        return;
+    }
+    const group = currentConfig.groups[groupName];
+    if (!group) {
+        const messagePrefix = chalk.red("Error");
+        console.log(`${messagePrefix}: no group found with name '${groupName}'`);
+        console.log(`Available groups: ${chalk.green(Object.keys(currentConfig.groups).join(" "))}`);
+        return;
+    }
+    if (!Array.isArray(group) || group.length === 0) {
+        const messagePrefix = chalk.red("Error");
+        console.log(`${messagePrefix}: group '${groupName}' has no micro frontends defined.`);
+        return;
+    }
+    const mfeDir = currentConfig.mfe_directory;
+    let hadError = false;
+    console.log(chalk.green(`Running 'npm install' in group: ${groupName}`));
+    let interrupted = false;
+    const handleSigint = () => {
+        interrupted = true;
+        console.log(chalk.yellow("\nReceived SIGINT. Stopping installs..."));
+    };
+    process.once('SIGINT', handleSigint);
+    for (const mfe of group) {
+        if (interrupted)
+            break;
+        const cwd = path.join(mfeDir, mfe);
+        console.log(chalk.blue(`[${mfe}] Running 'npm install' in ${cwd}`));
+        const result = spawnSync("npm", ["install"], {
+            cwd,
+            stdio: "inherit",
+            shell: true
+        });
+        if (result.status !== 0) {
+            hadError = true;
+            console.error(chalk.red(`  MFE ${mfe} failed to install (cwd: ${cwd}) with exit code ${result.status}`));
+        }
+        else {
+            console.log(chalk.green(`  MFE ${mfe} installed successfully (cwd: ${cwd})`));
+        }
+    }
+    if (hadError) {
+        console.error(chalk.red("One or more installs failed."));
+        process.exitCode = 1;
+    }
+    else if (interrupted) {
+        process.exitCode = 130;
+    }
+    else {
+        console.log(chalk.green("All installs completed successfully."));
+    }
+}));
+export default installCommand;

package/dist/commands/run.js

@@ -1,15 +1,65 @@
 import { Command } from "commander";
 import { configExists, currentConfig, warnOfMissingConfig, } from "../utils/config-utils.js";
+import concurrently from "concurrently";
+import chalk from "chalk";
+import path from "path";
 const runCommand = new Command("run")
     .description("run micro-frontend applications")
     .argument("[group_name]", "name of the group as specified in the configuration", "all")
-    .action((options) => {
+    .action((groupName) => {
     if (!configExists) {
         warnOfMissingConfig();
         return;
     }
-    console.log("options", options);
-    const runGroup = currentConfig.groups[options];
-    console.log("Running the following micro frontends:\n", runGroup);
+    const group = currentConfig.groups[groupName];
+    if (!group) {
+        const messagePrefix = chalk.red("Error");
+        console.log(`${messagePrefix}: no group found with name '${groupName}'`);
+        console.log(`Available groups: ${chalk.green(Object.keys(currentConfig.groups).join(" "))}`);
+        return;
+    }
+    if (!Array.isArray(group) || group.length === 0) {
+        const messagePrefix = chalk.red("Error");
+        console.log(`${messagePrefix}: group '${groupName}' has no micro frontends defined.`);
+        return;
+    }
+    const mfeDir = currentConfig.mfe_directory;
+    const commands = group.map((mfe) => ({
+        command: "npm start",
+        name: mfe,
+        cwd: path.join(mfeDir, mfe),
+        prefixColor: "blue"
+    }));
+    console.log(chalk.green(`Running micro frontends in group: ${groupName}...`));
+    const concurrentlyResult = concurrently(commands, {
+        prefix: "{name} |",
+        killOthersOn: ["failure", "success"],
+        restartTries: 0,
+    });
+    const handleSigint = () => {
+        console.log(chalk.yellow("\nReceived SIGINT. Stopping all micro frontends..."));
+        concurrentlyResult.commands.forEach(cmd => {
+            if (cmd && typeof cmd.kill === 'function') {
+                cmd.kill();
+            }
+        });
+        process.exit(0);
+    };
+    process.once('SIGINT', handleSigint);
+    concurrentlyResult.result.then(() => { }, (err) => {
+        console.error(chalk.red("One or more micro frontends failed to start."));
+        if (Array.isArray(err)) {
+            err.forEach((fail) => {
+                var _a, _b;
+                const name = ((_a = fail.command) === null || _a === void 0 ? void 0 : _a.name) || "unknown";
+                const exitCode = fail.exitCode;
+                const cwd = ((_b = fail.command) === null || _b === void 0 ? void 0 : _b.cwd) || "unknown";
+                console.error(chalk.yellow(`  MFE ${name} failed to start (cwd: ${cwd}) with exit code ${exitCode}`));
+            });
+        }
+        else if (err && err.message) {
+            console.error(err.message);
+        }
+    });
 });
 export default runCommand;

package/dist/index.js

@@ -3,11 +3,12 @@ import { program } from "commander";
 import configCommand from "./commands/config/index.js";
 import initCommand from "./commands/init.js";
 import runCommand from "./commands/run.js";
+import installCommand from "./commands/install.js";
 import { loadConfig } from "./utils/config-utils.js";
 program
     .name("mfer")
     .description("Micro Frontend Runner (mfer) - A CLI for running your project's micro frontends.")
-    .version("0.0.0-alpha.1", "-v, --version", "mfer CLI version")
+    .version("0.0.0-alpha.2", "-v, --version", "mfer CLI version")
     .hook("preAction", (thisCommand, actionCommand) => {
     console.log();
 })
@@ -17,5 +18,6 @@ program
 program.addCommand(configCommand);
 program.addCommand(initCommand);
 program.addCommand(runCommand);
+program.addCommand(installCommand);
 loadConfig();
 program.parse();

package/dist/utils/config-utils.js

@@ -1,18 +1,9 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import * as fs from "fs";
 import * as path from "path";
 import * as os from "os";
 import YAML from "yaml";
 import chalk from "chalk";
-import { editor } from "@inquirer/prompts";
+import { spawn } from "child_process";
 export const configPath = path.join(os.homedir(), ".mfer/config.yaml");
 export const configExists = fs.existsSync(configPath);
 export let currentConfig;
@@ -24,7 +15,7 @@ export const loadConfig = () => {
 };
 export const warnOfMissingConfig = () => {
     if (!configExists) {
-        console.log(`${chalk.red("Error")}: No configuration file detected.\n       Please run ${chalk.blue.bold("mfer init")} to create one.`);
+        console.log(`${chalk.red("Error")}: No configuration file detected\n       Please run ${chalk.blue.bold("mfer init")} to create one`);
     }
 };
 export const saveConfig = (newConfig) => {
@@ -39,12 +30,12 @@ export const saveConfig = (newConfig) => {
         console.log(`Error writing config file!\n\n${e}`);
     }
 };
-export const editConfigAsync = (message, config) => __awaiter(void 0, void 0, void 0, function* () {
-    const prefixMessage = "# This file is whitespace sensitive. Tabs are two spaces, and file must be valid YAML.";
-    const answer = yield editor({
-        message,
-        default: `${prefixMessage}\n${YAML.stringify(config)}`,
-        postfix: ".yaml",
-    });
-    return answer;
-});
+export const editConfig = () => {
+    const editor = process.env.EDITOR || process.env.VISUAL || (os.platform() === "win32" ? "notepad" : "vi");
+    console.log(chalk.green(`Opening config file in editor: ${editor}\n`));
+    spawn(editor, [configPath], {
+        stdio: "ignore",
+        detached: true,
+        shell: true
+    }).unref();
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mfer",
-  "version": "0.0.0-alpha.1",
+  "version": "0.0.0-alpha.3",
   "description": "CLI tool designed to sensibly run micro-frontends from the terminal.",
   "bin": {
     "mfer": "dist/index.js"
@@ -13,6 +13,11 @@
   },
   "keywords": [
     "micro frontends",
+    "micro frontend",
+    "microfrontend",
+    "micro-frontend",
+    "micro-frontends",
+    "mfe",
     "CLI",
     "runner"
   ],