@nx/angularSee schema

@nx/angular:federate-module

Create a federated module, which is exposed by a remote and can be subsequently loaded by a host.

Usage

1nx generate federate-module ... 2

By default, Nx will search for federate-module in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

1nx g @nx/angular:federate-module ... 2

Show what will be generated without writing to disk:

1nx g federate-module ... --dry-run 2

Examples

Create a federated module from my-remote-app, that exposes my-cmp from ./src/component/my-cmp.ts as MyModule.:

1nx g federate-module MyModule --path=./src/component/my-cmp.ts --remote=my-remote-app --remoteDirectory=apps/my-remote-app 2

Options

name

Required
string
Pattern: ^[a-zA-Z][^:]*$

The name of the module.

path

Required
string

The path to locate the federated module.

remote

Required
string

The name of the remote.

e2eTestRunner

string
Default: cypress
Accepted values: cypress, none

Test runner to use for end to end (e2e) tests of the remote if it needs to be created.

host

string

The host / shell application for this remote.

remoteDirectory

string

The directory of the new remote application if one needs to be created.

style

string
Default: css
Accepted values: css, scss, sass, less

The file extension to be used for style files for the remote if one needs to be created.

standalone

boolean
Default: true

Whether to generate the remote application with standalone components if it needs to be created.

unitTestRunner

string
Default: jest
Accepted values: jest, vitest, none

Test runner to use for unit tests of the remote if it needs to be created.

skipFormat

Internal
boolean
Default: false

Skip formatting files.