mfer 1.0.0 → 1.0.2

package/README.md

@@ -1,7 +1,32 @@
 # mfer (Micro Frontend Runner)
 
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 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
+
+- [🚀 Features](#-features)
+- [📦 Installation](#-installation)
+- [🛠️ Quick Start](#️-quick-start)
+- [📋 Commands](#-commands)
+  - [mfer init](#mfer-init)
+  - [mfer run](#mfer-run)
+  - [mfer pull](#mfer-pull)
+  - [mfer install](#mfer-install)
+  - [mfer clone](#mfer-clone)
+  - [mfer config](#mfer-config)
+    - [mfer config list](#mfer-config-list)
+    - [mfer config edit](#mfer-config-edit)
+  - [mfer help](#mfer-help)
+- [⚙️ Configuration](#️-configuration)
+- [🎯 Use Cases](#-use-cases)
+- [🔧 Advanced Usage](#-advanced-usage)
+- [🐛 Troubleshooting](#-troubleshooting)
+- [🤝 Contributing](#-contributing)
+- [📄 License](#-license)
+- [🙏 Acknowledgments](#-acknowledgments)
+
 ## 🚀 Features
 
 - **Concurrent Execution**: Run multiple micro frontends simultaneously with organized output
@@ -24,8 +49,8 @@ npm install -g mfer
 
 ### Install from source
 ```bash
-git clone https://github.com/srimel/run-mfs.git
-cd run-mfs
+git clone https://github.com/srimel/mfer.git
+cd mfer
 npm install
 npm run build
 npm install -g .
@@ -103,18 +128,52 @@ mfer pull         # Pull from all repositories
 mfer pull shared  # Pull from shared components group only
 ```
 
+### `mfer install [group_name]`
+Install dependencies for all micro frontends in a group.
+
+**Arguments:**
+- `group_name`: Name of the group to install dependencies for (defaults to "all")
+
+**Example:**
+```bash
+mfer install          # Install dependencies for all micro frontends
+mfer install frontend # Install dependencies for frontend group only
+```
+
+### `mfer clone [group_name]`
+Clone repositories that don't exist locally.
+
+**Arguments:**
+- `group_name`: Name of the group to clone repositories from (defaults to "all")
+
+**Example:**
+```bash
+mfer clone          # Clone all repositories
+mfer clone shared   # Clone repositories in shared group only
+```
+
 ### `mfer config`
 Manage your configuration settings.
 
 **Subcommands:**
-- `mfer config edit`: Open configuration file in your default editor
 - `mfer config list`: Display current configuration
+- `mfer config edit`: Open configuration file in your default editor
 
-### `mfer install`
-Install dependencies for all micro frontends in a group.
+**Example:**
+```bash
+mfer config list    # Show current configuration
+mfer config edit    # Edit configuration in your editor
+```
 
-### `mfer clone`
-Clone repositories that don't exist locally.
+### `mfer help`
+Display help information for mfer commands.
+
+**Example:**
+```bash
+mfer help           # Show general help
+mfer help run       # Show help for run command
+mfer help config    # Show help for config command
+```
 
 ## ⚙️ Configuration
 
@@ -248,13 +307,15 @@ mfer config edit
 For local development of mfer itself:
 
 ```bash
-git clone https://github.com/srimel/run-mfs.git
-cd run-mfs
+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/index.js

@@ -10,7 +10,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("1.0.0", "-v, --version", "mfer CLI version")
+    .version("1.0.2", "-v, --version", "mfer CLI version")
     .hook("preAction", (thisCommand, actionCommand) => {
     console.log();
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mfer",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "CLI tool designed to sensibly run micro-frontends from the terminal.",
   "bin": {
     "mfer": "dist/index.js"
@@ -9,7 +9,9 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist",
-    "watch": "tsc --watch"
+    "watch": "tsc --watch",
+    "test": "vitest run",
+    "test:watch": "vitest"
   },
   "keywords": [
     "micro frontends",
@@ -38,7 +40,8 @@
   "devDependencies": {
     "@types/node": "^24.0.3",
     "rimraf": "^6.0.1",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.4"
   },
   "dependencies": {
     "@inquirer/prompts": "^7.5.3",

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

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

package/dist/commands/config/config.js

@@ -1,16 +0,0 @@
-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/sub-commands/add-config.js

@@ -1,8 +0,0 @@
-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.js

@@ -1,16 +0,0 @@
-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;