@nx/angular:setup-mf
Create Module Federation configuration files for given Angular Application.
Examples
The setup-mf generator is used to add Module Federation support to existing applications.
To convert an existing application to a host application, run the following
1nx g setup-mf myapp --mfType=host --routing=true
2Usage
1nx generate setup-mf ...
2By default, Nx will search for setup-mf in the default collection provisioned in workspace.json.
You can specify the collection explicitly as follows:
1nx g @nx/angular:setup-mf ...
2Show what will be generated without writing to disk:
1nx g setup-mf ... --dry-run
2Options
appName
Required
string
The name of the application to generate the Module Federation configuration for.
mfType
Required
string
Default:
remoteAccepted values:
host, remoteType of application to generate the Module Federation configuration for.
routing
boolean
Generate a routing setup to allow a host application to route to the remote application.
e2eProjectName
string
The project name of the associated E2E project for the application. This is only required for Cypress E2E projects that do not follow the naming convention <appName>-e2e.
federationType
string
Default:
staticAccepted values:
static, dynamicUse either Static or Dynamic Module Federation pattern for the application.
host
string
The name of the host application that the remote application will be consumed by.
port
number
The port at which the remote application should be served.
prefix
string
The prefix to use for any generated component.
remotes
Array<anything>
A list of remote application names that the host application should consume.
skipE2E
boolean
Default:
falseDo not set up E2E related config.
standalone
boolean
Default:
falseWhether the application is a standalone application. Note: This is only supported in Angular versions >= 14.1.0
skipFormat
boolean
Skip formatting the workspace after the generator completes.
skipPackageJson
boolean
Default:
falseDo not add dependencies to package.json.