@nx/angular:federate-module
Create a federated module, which is exposed by a remote and can be subsequently loaded by a host.
Monorepo World: October 7, 2024Monorepo World: October 7, 2024Join us!
Create a federated module, which is exposed by a remote and can be subsequently loaded by a host.
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
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
^[a-zA-Z][^:]*$
The name of the module.
The path to locate the federated module.
The name of the remote.
cypress
cypress
, none
Test runner to use for end to end (e2e) tests of the remote if it needs to be created.
The host / shell application for this remote.
as-provided
, derived
Whether to generate the project name and root directory as provided (as-provided
) or generate them composing their values and taking the configured layout into account (derived
).
The directory of the new remote application if one needs to be created.
css
css
, scss
, sass
, less
The file extension to be used for style files for the remote if one needs to be created.
true
Whether to generate the remote application with standalone components if it needs to be created.
jest
jest
, vitest
, none
Test runner to use for unit tests of the remote if it needs to be created.
false
Skip formatting files.