MFE Forge

Scope-based scaffolding

init creates the workspace; generate creates hosts, remotes, packages, libraries and a design system. Apps live at apps//, and names, package names, federation names and dev scripts are derived from that path.

Host and remote sync

generate and sync rewrite each host's remotes block and remote type declarations from the apps in its scope, and record the topology in mfe-forge.manifest.json. sync --check fails CI when a host is out of date.

Port allocation

Each new host or remote gets the first free port in dev.portRange that no other app uses, written into vite.config.ts and the dev script. doctor reports conflicts.

Orchestration with real exit codes

dev, build and test run per-app scripts for all apps, one scope or one app. A failed build or test exits with code 2, an invalid config with code 3.

Diagnostics

doctor, status, graph, inspect, deps, check and config, most with --json output for scripts and CI.

Resilient runtime

@mfe-forge/core provides an accessible error boundary with retry, lazy remote loading, a remote registry and an event bus. router, store, design and testing cover navigation, Zustand state, tokens and tests.

Quick start

bash

npx mfe-forge@latest init my-platform --package-manager npm
cd my-platform
# set "workspaces": ["apps/*/*", "packages/*"] in package.json (see Installation)
npx mfe generate host platform/host
npx mfe generate app platform/dashboard
npm install
npx mfe doctor

The npm package is mfe-forge; it installs the binaries mfe-forge and mfe. The Quick start continues from here and renders the remote inside the host. Requirements are listed under Installation.

Status

MFE Forge is on the 0.x line and minor versions may break. Templates currently use @originjs/vite-plugin-federation with Vite 5.4; Module Federation 2.0 support is planned. See Status and maturity.

Packages

Package	Description
`mfe-forge`	CLI: `init`, `generate`, `dev`, `build`, `test`, `sync`, `doctor`, `config` and diagnostics
`@mfe-forge/core`	`MFErrorBoundary`, `LazyRemote`, `RemoteLoader`, `RemoteRegistry`, `EventBus`
`@mfe-forge/router`	`useMFENavigation`, `useRouteSync`, `generateRoutes`, `createRouteGuard` for React Router 7
`@mfe-forge/store`	`useGlobalStore`, `createScopedStore`, `syncStoreAcrossMFEs` for Zustand 5
`@mfe-forge/design`	Design `tokens` and `applyTokens` for CSS custom properties
`@mfe-forge/testing`	`renderMFE`, `mockRemoteModule`, `waitForRemoteLoad`, Playwright `e2eHelpers`

Package

Description

mfe-forge

CLI: init, generate, dev, build, test, sync, doctor, config and diagnostics

@mfe-forge/core

MFErrorBoundary, LazyRemote, RemoteLoader, RemoteRegistry, EventBus

@mfe-forge/router

useMFENavigation, useRouteSync, generateRoutes, createRouteGuard for React Router 7

@mfe-forge/store

useGlobalStore, createScopedStore, syncStoreAcrossMFEs for Zustand 5

@mfe-forge/design

Design tokens and applyTokens for CSS custom properties