mfer 0.0.0-alpha.1

package/README.md

@@ -0,0 +1,19 @@
+# Micro Frontend Runner (mfer)
+
+A CLI tool that helps manage and run multiple micro frontends.
+
+## Development
+
+### Getting Started
+
+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`.
+
+### Troubleshooting
+
+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.

package/dist/commands/config/add-config.js

@@ -0,0 +1 @@
+export {};

package/dist/commands/config/config.js

@@ -0,0 +1,16 @@
+import { Command } from "commander";
+import { currentConfig } from "../../utils/config-utils.js";
+const configCommand = new Command("config")
+    .description("prism configuration settings")
+    .option("-l, --list", "list the current configuration")
+    .action((options) => {
+    const { list, path } = options;
+    if (list) {
+        console.log(`\nCurrent configuration:\n`);
+        console.log(currentConfig);
+        console.log("");
+    }
+    if (path) {
+    }
+});
+export default configCommand;

package/dist/commands/config/index.js

@@ -0,0 +1,7 @@
+import { Command } from "commander";
+import { listConfigCommand } from "./sub-commands/list-config.js";
+import { editConfigCommand } from "./sub-commands/edit-config.js";
+const configCommand = new Command("config").description("configuration settings");
+configCommand.addCommand(listConfigCommand);
+configCommand.addCommand(editConfigCommand);
+export default configCommand;

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

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

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

@@ -0,0 +1,24 @@
+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";
+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 {
+        warnOfMissingConfig();
+    }
+}));

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

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

package/dist/commands/config.js

@@ -0,0 +1,16 @@
+import { Command } from "commander";
+import { currentConfig } from "../utils/config-utils.js";
+const configCommand = new Command("config")
+    .description("prism configuration settings")
+    .option("-l, --list", "list the current configuration")
+    .action((options) => {
+    const { list, path } = options;
+    if (list) {
+        console.log(`\nCurrent configuration:\n`);
+        console.log(currentConfig);
+        console.log("");
+    }
+    if (path) {
+    }
+});
+export default configCommand;

package/dist/commands/init.js

@@ -0,0 +1,32 @@
+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, editConfigAsync, saveConfig, } from "../utils/config-utils.js";
+import YAML from "yaml";
+const templateConfig = {
+    mfe_directory: "path/to/folder/containing/microfrontends",
+    groups: {
+        all: ["repo_name_1", "repo_name_2", "repo_name_3"],
+        customGroup1: ["repo_name2", "repo_name_3"],
+    },
+};
+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);
+    }
+    else {
+        console.log("config already exists, you can edit it with 'mfer config edit'");
+    }
+}));
+export default initCommand;

package/dist/commands/run.js

@@ -0,0 +1,15 @@
+import { Command } from "commander";
+import { configExists, currentConfig, warnOfMissingConfig, } from "../utils/config-utils.js";
+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) => {
+    if (!configExists) {
+        warnOfMissingConfig();
+        return;
+    }
+    console.log("options", options);
+    const runGroup = currentConfig.groups[options];
+    console.log("Running the following micro frontends:\n", runGroup);
+});
+export default runCommand;

package/dist/index.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+import { program } from "commander";
+import configCommand from "./commands/config/index.js";
+import initCommand from "./commands/init.js";
+import runCommand from "./commands/run.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")
+    .hook("preAction", (thisCommand, actionCommand) => {
+    console.log();
+})
+    .hook("postAction", (thisCommand, actionCommand) => {
+    console.log();
+});
+program.addCommand(configCommand);
+program.addCommand(initCommand);
+program.addCommand(runCommand);
+loadConfig();
+program.parse();

package/dist/utils/config-utils.js

@@ -0,0 +1,50 @@
+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";
+export const configPath = path.join(os.homedir(), ".mfer/config.yaml");
+export const configExists = fs.existsSync(configPath);
+export let currentConfig;
+export const loadConfig = () => {
+    if (configExists) {
+        const configFile = fs.readFileSync(configPath, "utf8");
+        currentConfig = YAML.parse(configFile);
+    }
+};
+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.`);
+    }
+};
+export const saveConfig = (newConfig) => {
+    try {
+        const configDir = path.dirname(configPath);
+        if (!fs.existsSync(configDir)) {
+            fs.mkdirSync(configDir, { recursive: true });
+        }
+        fs.writeFileSync(configPath, YAML.stringify(newConfig));
+    }
+    catch (e) {
+        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;
+});

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "mfer",
+  "version": "0.0.0-alpha.1",
+  "description": "CLI tool designed to sensibly run micro-frontends from the terminal.",
+  "bin": {
+    "mfer": "dist/index.js"
+  },
+  "main": "index.ts",
+  "scripts": {
+    "build": "tsc",
+    "clean": "rimraf dist",
+    "watch": "tsc --watch"
+  },
+  "keywords": [
+    "micro frontends",
+    "CLI",
+    "runner"
+  ],
+  "author": "Stuart Rimel",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/srimel/run-mfs.git"
+  },
+  "bugs": {
+    "url": "https://github.com/srimel/run-mfs/issues"
+  },
+  "homepage": "https://github.com/srimel/run-mfs#readme",
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.3",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^7.5.3",
+    "chalk": "^5.4.1",
+    "commander": "^14.0.0",
+    "concurrently": "^9.2.0",
+    "yaml": "^2.8.0"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ]
+}