mfer 2.0.0 → 2.1.1

package/README.md

@@ -2,7 +2,6 @@
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![npm version](https://img.shields.io/npm/v/mfer.svg)](https://www.npmjs.com/package/mfer)
 
-
 A powerful CLI tool designed to simplify the management and execution of multiple micro frontend applications. mfer helps developers run, update, and organize their micro frontend projects with minimal configuration and maximum efficiency.
 
 ## 📋 Table of Contents
@@ -14,6 +13,7 @@ A powerful CLI tool designed to simplify the management and execution of multipl
 - [⚙️ Configuration](#️-configuration)
 - [🎯 Use Cases](#-use-cases)
 - [🔧 Advanced Usage](#-advanced-usage)
+- [🛠️ Development](#️-development)
 - [🐛 Troubleshooting](#-troubleshooting)
 - [🤝 Contributing](#-contributing)
 - [📄 License](#-license)
@@ -99,6 +99,7 @@ mfer pull frontend
 - [`mfer pull`](#mfer-pull-group_name) - Pull latest changes from git repositories
 - [`mfer install`](#mfer-install-group_name) - Install dependencies for micro frontends
 - [`mfer clone`](#mfer-clone-group_name) - Clone repositories that don't exist locally
+- [`mfer lib`](#mfer-lib) - Manage internal npm packages
 - [`mfer config`](#mfer-config) - Manage configuration settings
 - [`mfer help`](#mfer-help) - Display help information
 
@@ -215,6 +216,87 @@ mfer help run       # Show help for run command
 mfer help config    # Show help for config command
 ```
 
+### `mfer lib`
+
+Manage internal npm packages and their distribution to micro frontends.
+
+**Subcommands:**
+
+- [`mfer lib build`](#mfer-lib-build-lib-name) - Build internal npm packages
+- [`mfer lib deploy`](#mfer-lib-deploy-lib-name) - Copy built libraries to micro frontends
+- [`mfer lib publish`](#mfer-lib-publish-lib-name) - Build and deploy libraries to micro frontends
+- [`mfer lib list`](#mfer-lib-list) - List configured libraries and their status
+
+### `mfer lib build [lib-name]`
+
+Build internal npm packages.
+
+**Arguments:**
+
+- `lib-name`: Name of the library to build (builds all if not specified)
+
+**Options:**
+
+- `-s, --select`: Prompt to select which libraries to build
+
+**Examples:**
+
+```bash
+mfer lib build                    # Build all libraries
+mfer lib build my-shared-utils    # Build specific library
+mfer lib build --select           # Select libraries to build interactively
+```
+
+### `mfer lib deploy [lib-name]`
+
+Copy built libraries to micro frontends.
+
+**Arguments:**
+
+- `lib-name`: Name of the library to deploy (deploys all if not specified)
+
+**Options:**
+
+- `-s, --select`: Prompt to select which libraries to deploy
+
+**Examples:**
+
+```bash
+mfer lib deploy                    # Deploy all libraries
+mfer lib deploy my-shared-utils    # Deploy specific library
+mfer lib deploy --select           # Select libraries to deploy interactively
+```
+
+### `mfer lib publish [lib-name]`
+
+Build and deploy libraries to micro frontends.
+
+**Arguments:**
+
+- `lib-name`: Name of the library to publish (publishes all if not specified)
+
+**Options:**
+
+- `-s, --select`: Prompt to select which libraries to publish
+
+**Examples:**
+
+```bash
+mfer lib publish                    # Publish all libraries
+mfer lib publish my-shared-utils    # Publish specific library
+mfer lib publish --select           # Select libraries to publish interactively
+```
+
+### `mfer lib list`
+
+List configured libraries and their status.
+
+**Example:**
+
+```bash
+mfer lib list    # Show all configured libraries and their build status
+```
+
 ## ⚙️ Configuration
 
 mfer uses a YAML configuration file located at `~/.mfer/config.yaml`. Here's an example structure:
@@ -222,6 +304,11 @@ mfer uses a YAML configuration file located at `~/.mfer/config.yaml`. Here's an
 ```yaml
 base_github_url: "https://github.com/your-username"
 mfe_directory: "/path/to/your/micro-frontends"
+lib_directory: "/path/to/your/internal-libs"
+libs:
+  - my-shared-utils
+  - my-design-system
+  - my-common-components
 groups:
   all:
     - my-main-app
@@ -239,6 +326,8 @@ groups:
 
 - **`base_github_url`**: Your GitHub base URL for repository operations
 - **`mfe_directory`**: Path to the directory containing all your micro frontend projects
+- **`lib_directory`**: Path to the directory containing your internal npm packages (optional)
+- **`libs`**: List of internal npm package names to manage (optional)
 - **`groups`**: Named collections of micro frontend projects
   - **`all`**: Default group containing all projects (required)
   - **Custom groups**: Any additional groups you want to create
@@ -327,6 +416,30 @@ mfer respects your existing environment setup and will use the same Node.js and
 - Use Ctrl+C to gracefully shut down all running services
 - Failed processes are reported with detailed error information
 
+## 🛠️ Development
+
+### Local Development Setup
+
+For contributing to mfer or setting up a local development environment:
+
+```bash
+git clone https://github.com/srimel/mfer.git
+cd mfer
+npm install
+npm run build
+npm install -g .
+```
+
+### Testing with Playground
+
+The project includes a comprehensive playground for testing mfer commands with sample micro frontends. The playground contains:
+
+- **libs/common-utils**: A shared utility library
+- **frontends/mfe1, mfe2, mfe3**: Three React micro frontends with different themes
+- Complete setup instructions and testing scenarios
+
+📖 **[View detailed local development guide →](./docs/local-development.md)**
+
 ## 🐛 Troubleshooting
 
 ### Common Issues
@@ -359,20 +472,6 @@ mfer config edit
 - Ensure all projects in your configuration are valid git repositories
 - Run `mfer clone` to clone missing repositories
 
-### Development Mode
-
-For local development of mfer itself:
-
-```bash
-git clone https://github.com/srimel/mfer.git
-cd mfer
-npm install
-npm run build
-npm install -g .
-```
-
-Refer to [local development](./docs/local-development.md) docs for more information.
-
 ## 🤝 Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

package/dist/commands/init.js

@@ -37,7 +37,7 @@ function createAndSaveConfig(githubUsername, mfeDirectory, allGroup = [], libDir
         console.log(chalk.yellow("Please replace 'my_mfe_1' and 'my_mfe_2' with your actual repository names."));
     }
     if (libDirectory && libs.length > 0) {
-        console.log(chalk.green(`\nLibrary configuration added: ${libs.length} librar${libs.length === 1 ? 'y' : 'ies'} configured.`));
+        console.log(chalk.green(`\nLibrary configuration added: ${libs.length} librar${libs.length === 1 ? "y" : "ies"} configured.`));
         console.log(chalk.yellow("You can now use 'mfer lib build', 'mfer lib deploy', and 'mfer lib publish' commands."));
     }
 }
@@ -136,7 +136,7 @@ function promptForLibSelection(libs) {
             return yield checkbox({
                 message: "Select which libraries to include in the configuration:",
                 choices: libs.map((lib) => ({ name: lib, value: lib })),
-                validate: (arr) => (arr.length > 0 ? true : "Select at least one library"),
+                validate: (arr) => arr.length > 0 ? true : "Select at least one library",
             });
         }
         catch (error) {

package/dist/commands/lib/build.js

@@ -12,11 +12,14 @@ import chalk from "chalk";
 import { spawn } from "child_process";
 import * as fs from "fs";
 import * as path from "path";
+import { checkbox } from "@inquirer/prompts";
 import { currentConfig, configExists, warnOfMissingConfig, } from "../../utils/config-utils.js";
 const buildCommand = new Command("build")
     .description("Build internal npm packages")
     .argument("[lib-name]", "Name of the library to build (builds all if not specified)")
-    .action((libName) => __awaiter(void 0, void 0, void 0, function* () {
+    .option("-s, --select", "prompt to select which libraries to build")
+    .action((libName, options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
     if (!configExists) {
         warnOfMissingConfig();
         return;
@@ -26,19 +29,47 @@ const buildCommand = new Command("build")
         console.log(chalk.yellow("Please run 'mfer init' to configure library settings."));
         return;
     }
-    const libsToBuild = libName
-        ? [libName].filter(lib => currentConfig.libs.includes(lib))
-        : currentConfig.libs;
-    if (libName && !currentConfig.libs.includes(libName)) {
-        console.log(chalk.red(`Error: Library '${libName}' not found in configuration.`));
-        console.log(chalk.yellow(`Available libraries: ${currentConfig.libs.join(", ")}`));
-        return;
+    let libsToBuild;
+    if (options === null || options === void 0 ? void 0 : options.select) {
+        try {
+            console.log(chalk.blue(`Select libraries to build:`));
+            const selectedLibs = yield checkbox({
+                message: "Choose which libraries to build:",
+                choices: currentConfig.libs.map((lib) => ({ name: lib, value: lib })),
+                validate: (arr) => arr.length > 0 ? true : "Select at least one library",
+            });
+            libsToBuild = selectedLibs;
+        }
+        catch (error) {
+            if (error instanceof Error &&
+                (((_a = error.message) === null || _a === void 0 ? void 0 : _a.includes("SIGINT")) ||
+                    ((_b = error.message) === null || _b === void 0 ? void 0 : _b.includes("User force closed")))) {
+                console.log(chalk.yellow("\nReceived SIGINT. Stopping..."));
+                process.exit(130);
+            }
+            throw error;
+        }
+    }
+    else {
+        libsToBuild = libName
+            ? [libName].filter((lib) => currentConfig.libs.includes(lib))
+            : currentConfig.libs;
+        if (libName && !currentConfig.libs.includes(libName)) {
+            console.log(chalk.red(`Error: Library '${libName}' not found in configuration.`));
+            console.log(chalk.yellow(`Available libraries: ${currentConfig.libs.join(", ")}`));
+            return;
+        }
     }
     if (libsToBuild.length === 0) {
         console.log(chalk.yellow("No libraries to build."));
         return;
     }
-    console.log(chalk.blue(`Building ${libsToBuild.length} librar${libsToBuild.length === 1 ? 'y' : 'ies'}...`));
+    const libsText = (options === null || options === void 0 ? void 0 : options.select)
+        ? `selected libraries (${libsToBuild.length})`
+        : libName
+            ? `library '${libName}'`
+            : `all libraries (${libsToBuild.length})`;
+    console.log(chalk.blue(`Building ${libsText}...`));
     for (const lib of libsToBuild) {
         const libPath = path.join(currentConfig.lib_directory, lib);
         if (!fs.existsSync(libPath)) {
@@ -56,7 +87,7 @@ const buildCommand = new Command("build")
     }
     console.log(chalk.green("\nBuild process completed!"));
 }));
-function buildLibrary(libPath, libName) {
+function buildLibrary(libPath, _libName) {
     return __awaiter(this, void 0, void 0, function* () {
         return new Promise((resolve, reject) => {
             const buildProcess = spawn("npm", ["run", "build"], {

package/dist/commands/lib/deploy.js

@@ -11,11 +11,14 @@ import { Command } from "commander";
 import chalk from "chalk";
 import * as fs from "fs";
 import * as path from "path";
+import { checkbox } from "@inquirer/prompts";
 import { currentConfig, configExists, warnOfMissingConfig, } from "../../utils/config-utils.js";
 const deployCommand = new Command("deploy")
     .description("Copy built libraries to micro frontends")
     .argument("[lib-name]", "Name of the library to deploy (deploys all if not specified)")
-    .action((libName) => __awaiter(void 0, void 0, void 0, function* () {
+    .option("-s, --select", "prompt to select which libraries to deploy")
+    .action((libName, options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
     if (!configExists) {
         warnOfMissingConfig();
         return;
@@ -25,20 +28,48 @@ const deployCommand = new Command("deploy")
         console.log(chalk.yellow("Please run 'mfer init' to configure library settings."));
         return;
     }
-    const libsToDeploy = libName
-        ? [libName].filter(lib => currentConfig.libs.includes(lib))
-        : currentConfig.libs;
-    if (libName && !currentConfig.libs.includes(libName)) {
-        console.log(chalk.red(`Error: Library '${libName}' not found in configuration.`));
-        console.log(chalk.yellow(`Available libraries: ${currentConfig.libs.join(", ")}`));
-        return;
+    let libsToDeploy;
+    if (options === null || options === void 0 ? void 0 : options.select) {
+        try {
+            console.log(chalk.blue(`Select libraries to deploy:`));
+            const selectedLibs = yield checkbox({
+                message: "Choose which libraries to deploy:",
+                choices: currentConfig.libs.map((lib) => ({ name: lib, value: lib })),
+                validate: (arr) => arr.length > 0 ? true : "Select at least one library",
+            });
+            libsToDeploy = selectedLibs;
+        }
+        catch (error) {
+            if (error instanceof Error &&
+                (((_a = error.message) === null || _a === void 0 ? void 0 : _a.includes("SIGINT")) ||
+                    ((_b = error.message) === null || _b === void 0 ? void 0 : _b.includes("User force closed")))) {
+                console.log(chalk.yellow("\nReceived SIGINT. Stopping..."));
+                process.exit(130);
+            }
+            throw error;
+        }
+    }
+    else {
+        libsToDeploy = libName
+            ? [libName].filter((lib) => currentConfig.libs.includes(lib))
+            : currentConfig.libs;
+        if (libName && !currentConfig.libs.includes(libName)) {
+            console.log(chalk.red(`Error: Library '${libName}' not found in configuration.`));
+            console.log(chalk.yellow(`Available libraries: ${currentConfig.libs.join(", ")}`));
+            return;
+        }
     }
     if (libsToDeploy.length === 0) {
         console.log(chalk.yellow("No libraries to deploy."));
         return;
     }
-    console.log(chalk.blue(`Deploying ${libsToDeploy.length} librar${libsToDeploy.length === 1 ? 'y' : 'ies'}...`));
-    const mfeDirectories = currentConfig.groups.all.map(mfe => path.join(currentConfig.mfe_directory, mfe));
+    const libsText = (options === null || options === void 0 ? void 0 : options.select)
+        ? `selected libraries (${libsToDeploy.length})`
+        : libName
+            ? `library '${libName}'`
+            : `all libraries (${libsToDeploy.length})`;
+    console.log(chalk.blue(`Deploying ${libsText}...`));
+    const mfeDirectories = currentConfig.groups.all.map((mfe) => path.join(currentConfig.mfe_directory, mfe));
     for (const lib of libsToDeploy) {
         const libDistPath = path.join(currentConfig.lib_directory, lib, "dist");
         if (!fs.existsSync(libDistPath)) {
@@ -69,7 +100,7 @@ const deployCommand = new Command("deploy")
             }
         }
         if (deployedCount > 0) {
-            console.log(chalk.green(`✓ ${lib} deployed to ${deployedCount} MFE${deployedCount === 1 ? '' : 's'}`));
+            console.log(chalk.green(`✓ ${lib} deployed to ${deployedCount} MFE${deployedCount === 1 ? "" : "s"}`));
         }
         else {
             console.log(chalk.yellow(`⚠ ${lib} not deployed (not found in any MFE's node_modules)`));
@@ -77,9 +108,9 @@ const deployCommand = new Command("deploy")
     }
     console.log(chalk.green("\nDeploy process completed!"));
 }));
-function copyLibraryToMfe(sourcePath, targetPath, libName) {
+function copyLibraryToMfe(sourcePath, targetPath, _libName) {
     return __awaiter(this, void 0, void 0, function* () {
-        return new Promise((resolve, reject) => {
+        return new Promise((resolve, _reject) => {
             if (fs.existsSync(targetPath)) {
                 fs.rmSync(targetPath, { recursive: true, force: true });
             }

package/dist/commands/lib/publish.js

@@ -12,11 +12,14 @@ import chalk from "chalk";
 import { spawn } from "child_process";
 import * as fs from "fs";
 import * as path from "path";
+import { checkbox } from "@inquirer/prompts";
 import { currentConfig, configExists, warnOfMissingConfig, } from "../../utils/config-utils.js";
 const publishCommand = new Command("publish")
     .description("Build and deploy libraries to micro frontends")
     .argument("[lib-name]", "Name of the library to publish (publishes all if not specified)")
-    .action((libName) => __awaiter(void 0, void 0, void 0, function* () {
+    .option("-s, --select", "prompt to select which libraries to publish")
+    .action((libName, options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
     if (!configExists) {
         warnOfMissingConfig();
         return;
@@ -26,20 +29,48 @@ const publishCommand = new Command("publish")
         console.log(chalk.yellow("Please run 'mfer init' to configure library settings."));
         return;
     }
-    const libsToPublish = libName
-        ? [libName].filter(lib => currentConfig.libs.includes(lib))
-        : currentConfig.libs;
-    if (libName && !currentConfig.libs.includes(libName)) {
-        console.log(chalk.red(`Error: Library '${libName}' not found in configuration.`));
-        console.log(chalk.yellow(`Available libraries: ${currentConfig.libs.join(", ")}`));
-        return;
+    let libsToPublish;
+    if (options === null || options === void 0 ? void 0 : options.select) {
+        try {
+            console.log(chalk.blue(`Select libraries to publish:`));
+            const selectedLibs = yield checkbox({
+                message: "Choose which libraries to publish:",
+                choices: currentConfig.libs.map((lib) => ({ name: lib, value: lib })),
+                validate: (arr) => arr.length > 0 ? true : "Select at least one library",
+            });
+            libsToPublish = selectedLibs;
+        }
+        catch (error) {
+            if (error instanceof Error &&
+                (((_a = error.message) === null || _a === void 0 ? void 0 : _a.includes("SIGINT")) ||
+                    ((_b = error.message) === null || _b === void 0 ? void 0 : _b.includes("User force closed")))) {
+                console.log(chalk.yellow("\nReceived SIGINT. Stopping..."));
+                process.exit(130);
+            }
+            throw error;
+        }
+    }
+    else {
+        libsToPublish = libName
+            ? [libName].filter((lib) => currentConfig.libs.includes(lib))
+            : currentConfig.libs;
+        if (libName && !currentConfig.libs.includes(libName)) {
+            console.log(chalk.red(`Error: Library '${libName}' not found in configuration.`));
+            console.log(chalk.yellow(`Available libraries: ${currentConfig.libs.join(", ")}`));
+            return;
+        }
     }
     if (libsToPublish.length === 0) {
         console.log(chalk.yellow("No libraries to publish."));
         return;
     }
-    console.log(chalk.blue(`Publishing ${libsToPublish.length} librar${libsToPublish.length === 1 ? 'y' : 'ies'}...`));
-    const mfeDirectories = currentConfig.groups.all.map(mfe => path.join(currentConfig.mfe_directory, mfe));
+    const libsText = (options === null || options === void 0 ? void 0 : options.select)
+        ? `selected libraries (${libsToPublish.length})`
+        : libName
+            ? `library '${libName}'`
+            : `all libraries (${libsToPublish.length})`;
+    console.log(chalk.blue(`Publishing ${libsText}...`));
+    const mfeDirectories = currentConfig.groups.all.map((mfe) => path.join(currentConfig.mfe_directory, mfe));
     for (const lib of libsToPublish) {
         const libPath = path.join(currentConfig.lib_directory, lib);
         if (!fs.existsSync(libPath)) {
@@ -80,7 +111,7 @@ const publishCommand = new Command("publish")
             }
         }
         if (deployedCount > 0) {
-            console.log(chalk.green(`  ✓ ${lib} published to ${deployedCount} MFE${deployedCount === 1 ? '' : 's'}`));
+            console.log(chalk.green(`  ✓ ${lib} published to ${deployedCount} MFE${deployedCount === 1 ? "" : "s"}`));
         }
         else {
             console.log(chalk.yellow(`  ⚠ ${lib} not deployed (not found in any MFE's node_modules)`));
@@ -88,7 +119,7 @@ const publishCommand = new Command("publish")
     }
     console.log(chalk.green("\nPublish process completed!"));
 }));
-function buildLibrary(libPath, libName) {
+function buildLibrary(libPath, _libName) {
     return __awaiter(this, void 0, void 0, function* () {
         return new Promise((resolve, reject) => {
             const buildProcess = spawn("npm", ["run", "build"], {
@@ -110,9 +141,9 @@ function buildLibrary(libPath, libName) {
         });
     });
 }
-function copyLibraryToMfe(sourcePath, targetPath, libName) {
+function copyLibraryToMfe(sourcePath, targetPath, _libName) {
     return __awaiter(this, void 0, void 0, function* () {
-        return new Promise((resolve, reject) => {
+        return new Promise((resolve, _reject) => {
             if (fs.existsSync(targetPath)) {
                 fs.rmSync(targetPath, { recursive: true, force: true });
             }

package/dist/index.js

@@ -11,7 +11,7 @@ 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("2.0.0", "-v, --version", "mfer CLI version")
+    .version("2.1.1", "-v, --version", "mfer CLI version")
     .hook("preAction", () => {
     console.log();
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mfer",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "CLI tool designed to sensibly run micro-frontends from the terminal.",
   "bin": {
     "mfer": "dist/index.js"