mfer 2.1.0 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -14
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -13,6 +13,7 @@ A powerful CLI tool designed to simplify the management and execution of multipl
|
|
|
13
13
|
- [⚙️ Configuration](#️-configuration)
|
|
14
14
|
- [🎯 Use Cases](#-use-cases)
|
|
15
15
|
- [🔧 Advanced Usage](#-advanced-usage)
|
|
16
|
+
- [🛠️ Development](#️-development)
|
|
16
17
|
- [🐛 Troubleshooting](#-troubleshooting)
|
|
17
18
|
- [🤝 Contributing](#-contributing)
|
|
18
19
|
- [📄 License](#-license)
|
|
@@ -415,6 +416,30 @@ mfer respects your existing environment setup and will use the same Node.js and
|
|
|
415
416
|
- Use Ctrl+C to gracefully shut down all running services
|
|
416
417
|
- Failed processes are reported with detailed error information
|
|
417
418
|
|
|
419
|
+
## 🛠️ Development
|
|
420
|
+
|
|
421
|
+
### Local Development Setup
|
|
422
|
+
|
|
423
|
+
For contributing to mfer or setting up a local development environment:
|
|
424
|
+
|
|
425
|
+
```bash
|
|
426
|
+
git clone https://github.com/srimel/mfer.git
|
|
427
|
+
cd mfer
|
|
428
|
+
npm install
|
|
429
|
+
npm run build
|
|
430
|
+
npm install -g .
|
|
431
|
+
```
|
|
432
|
+
|
|
433
|
+
### Testing with Playground
|
|
434
|
+
|
|
435
|
+
The project includes a comprehensive playground for testing mfer commands with sample micro frontends. The playground contains:
|
|
436
|
+
|
|
437
|
+
- **libs/common-utils**: A shared utility library
|
|
438
|
+
- **frontends/mfe1, mfe2, mfe3**: Three React micro frontends with different themes
|
|
439
|
+
- Complete setup instructions and testing scenarios
|
|
440
|
+
|
|
441
|
+
📖 **[View detailed local development guide →](./docs/local-development.md)**
|
|
442
|
+
|
|
418
443
|
## 🐛 Troubleshooting
|
|
419
444
|
|
|
420
445
|
### Common Issues
|
|
@@ -447,20 +472,6 @@ mfer config edit
|
|
|
447
472
|
- Ensure all projects in your configuration are valid git repositories
|
|
448
473
|
- Run `mfer clone` to clone missing repositories
|
|
449
474
|
|
|
450
|
-
### Development Mode
|
|
451
|
-
|
|
452
|
-
For local development of mfer itself:
|
|
453
|
-
|
|
454
|
-
```bash
|
|
455
|
-
git clone https://github.com/srimel/mfer.git
|
|
456
|
-
cd mfer
|
|
457
|
-
npm install
|
|
458
|
-
npm run build
|
|
459
|
-
npm install -g .
|
|
460
|
-
```
|
|
461
|
-
|
|
462
|
-
Refer to [local development](./docs/local-development.md) docs for more information.
|
|
463
|
-
|
|
464
475
|
## 🤝 Contributing
|
|
465
476
|
|
|
466
477
|
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
CHANGED
|
@@ -11,7 +11,7 @@ import { loadConfig } from "./utils/config-utils.js";
|
|
|
11
11
|
program
|
|
12
12
|
.name("mfer")
|
|
13
13
|
.description("Micro Frontend Runner (mfer) - A CLI for running your project's micro frontends.")
|
|
14
|
-
.version("2.1.
|
|
14
|
+
.version("2.1.1", "-v, --version", "mfer CLI version")
|
|
15
15
|
.hook("preAction", () => {
|
|
16
16
|
console.log();
|
|
17
17
|
})
|