@multisystemsuite/create-mf-app 1.0.13 → 1.0.15

package/README.md

@@ -61,6 +61,7 @@ npx create-mf-app my-platform --type=parent --children=billing,orders --shared=c
 npm run build
 node dist/index.js my-platform --control-plane -y
 node dist/index.js my-platform --type=parent --children=admin,billing --shared=corelib -y
+node dist/index.js add-child analytics --cwd=./my-platform --port=4205 -y
 ```
 
 **Global install** (optional):
@@ -257,11 +258,24 @@ npm run release:major
 
 ### Add a new remote after scaffold
 
-Use the built-in MF CLI (recommended):
+**Recommended — use `create-mf-app add-child`** (fully wires federation, host routes, `mf.json`, env ports, and npm scripts):
+
+```bash
+npx create-mf-app add-child analytics --cwd=./my-platform --port=4205 -y
+```
+
+From the CLI repo during development:
+
+```bash
+node dist/index.js add-child analytics --cwd=./mf-structure-test --port=4205 -y
+```
+
+This scaffolds `apps/analytics/`, updates the host router (`/analytics/*`), corelib registries, `remote-manifest.json`, root `package.json` scripts (`npm run analytics`), and `.env` port entries — the same wiring as children created at initial scaffold time.
+
+**Alternative — MF CLI inside the monorepo** (minimal scaffold; manual federation wiring may still be needed):
 
 ```bash
 npm run mf -- generate app inventory
-# wires federation, port, mf.json, and npm scripts
 ```
 
 Or copy an existing child app folder and update `mf.json`, `federation.config.ts`, host routes, and root `package.json` scripts manually.
@@ -270,6 +284,8 @@ Or copy an existing child app folder and update `mf.json`, `federation.config.ts
 
 ## CLI reference (create-mf-app)
 
+### Create a new project
+
 ```bash
 npx create-mf-app <project-name> [options]
 ```
@@ -287,9 +303,64 @@ npx create-mf-app <project-name> [options]
 | `--federation=true\|false` | Module Federation (default: `true`) |
 | `--control-plane` | Workflow Designer & Monitoring preset (6 apps + corelib, control-plane API, mf-* packages) |
 | `--federation-os` | Full Enterprise Federation OS preset (10 apps + corelib, runtime, observability stack) |
+| `--lite` | **Faster install** — skip ESLint/Vitest/Husky stack and optional SDK packages |
 | `-y`, `--yes` | Non-interactive (use defaults where applicable) |
 | `-h`, `--help` | Show help |
 
+**Faster install (`--lite`):**
+
+```bash
+npx create-mf-app my-platform --type=parent --children=billing,orders --shared=corelib --lite -y
+```
+
+Skips ESLint, Prettier, Stylelint, Vitest, Husky, commitlint, and optional SDK packages (`api-client`, `sdk-core`, `websocket-sdk`). Federation, apps, `corelib`, and `query-client` are still included — typical install drops from ~850 to ~400 packages.
+
+**Other ways to speed up install:**
+
+- Exclude the project folder from Windows Defender real-time scan
+- Second `npm install` is much faster (npm cache)
+- Use `HUSKY=0 npm install` to skip git hooks on any scaffold
+- Fewer `--children` = fewer apps = less to resolve
+
+### Add a child to an existing parent workspace
+
+```bash
+npx create-mf-app add-child <child-name> --cwd=./my-platform [options]
+```
+
+| Option | Description |
+|--------|-------------|
+| `--cwd=./my-platform` | Parent monorepo root (must contain `mf.json`; default: current directory) |
+| `--port=4205` | Dev/preview port for the new remote (default: next free port after existing apps) |
+| `-y`, `--yes` | Non-interactive |
+| `-h`, `--help` | Show add-child help |
+
+**Example:**
+
+```bash
+npx create-mf-app add-child analytics --cwd=./my-platform --port=4205 -y
+cd my-platform
+npm run analytics
+```
+
+**What gets updated:**
+
+- `apps/<child-name>/` — full enterprise child remote scaffold
+- `mf.json` — project registry + federation remotes
+- `apps/main` — host routes, federation config, remote type declarations
+- `apps/corelib` — permission/module/feature registries, sidebar menu
+- `runtime-config/remote-manifest.json` — remote entry map
+- Root `package.json` — `npm run <child>`, watch/preview/build scripts
+- `.env` / env variants — port and remoteEntry URLs
+- `docker-compose.yml` and `infrastructure/` — when present in the workspace
+
+**Rules:**
+
+- Workspace must be an existing **parent monorepo** with `mf.json`
+- Child name: letters, numbers, dashes only (`^[a-z0-9-]+$`)
+- Do not use `main` or the shared lib name (e.g. `corelib`)
+- Child must not already exist under `apps/`
+
 **Parent mode rules:**
 
 - `main` is **always** created as the host — never pass it in `--children` or `--shared`
@@ -1376,6 +1447,8 @@ Node 18 will fail on Vite 7 commands.
 | `Cannot find module 'billing/App'` | Add federation `.d.ts` declarations in host |
 | `Task not found: live-reload` | Root `"live-reload": "node live-reload.js"` |
 | Vite binary missing after install | Clean reinstall (see below) |
+| **`npm install` very slow (~2 min+)** | Use `--lite` for faster scaffold; exclude project from antivirus scan; second install uses npm cache |
+| **`npm run local` fails on `api-client` build** | Update to latest CLI (smart-build skips source-only packages) or patch `smart-build.js` |
 | Sidebar overlaps main content | Use generated flex sidebar in corelib |
 | **Text invisible on dark header/sidebar** | Clear `localStorage` key `mf-enterprise-config`; hard refresh |
 | `provider support react(undefined)` / `useState` null | Rebuild all apps after federation config change; host uses exact `version: "19.0.0"`, remotes use `requiredVersion: "^19.0.0"` |
@@ -1416,6 +1489,7 @@ node dist/index.js my-platform --control-plane -y
 node dist/index.js my-platform --type=parent --children=admin,billing --shared=corelib -y
 node dist/index.js my-federation-platform --federation-os -y
 node dist/index.js test-app --type=child --port=3001 --template=tsx
+node dist/index.js add-child analytics --cwd=./mf-structure-test --port=4205 -y
 
 # patch in-repo test workspaces (mf-test-jsx, my-platform-cp) after pillar changes
 node scripts/patch-architect-level-test-repos.js
@@ -1457,7 +1531,7 @@ npm publish --access public
 | **Federation OS preset** | `--federation-os` → full runtime, governance, observability stack |
 | **Daily dev** | `npm run local` (all apps) or `npm run billing` (one module) |
 | **Shared UI / theme** | Import from `corelib/*` federation exposes |
-| **New remote** | `npm run mf -- generate app <name>` |
+| **New remote** | `npx create-mf-app add-child <name> --cwd=./my-platform` or `npm run mf -- generate app <name>` |
 | **Enterprise modules** | Flags: `--auth`, `--charts`, `--i18n`, … |
 | **Architect pillars** | 10 enterprise audits — start with `npm run architect-level:audit` |
 | **Monorepo platform** | `mf graph`, `mf affected build`, `mf doctor` |