@nx/angular:remote

Create an Angular Remote Module Federation Application.

Usage

nx generate remote ...

By default, Nx will search for remote in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

nx g @nx/angular:remote ...
Nx 15 and lower use @nrwl/ instead of @nx/

Show what will be generated without writing to disk:

nx g remote ... --dry-run

Examples

Create an Angular app with configuration in place for Module Federation. If host is provided, attach this remote app to host app's configuration.:

nx g @nx/angular:remote appName --host=host --port=4201
Nx 15 and lower use @nrwl/ instead of @nx/

Options

name

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

The name to give to the remote Angular app.

host

string

The name of the host app to attach this remote app to.

addTailwind

boolean
Default: false

Whether to configure Tailwind CSS for the application.

backendProject

string

Backend project that provides data to this application. This sets up proxy.config.json.

directory

string

The directory of the new application.

e2eTestRunner

string
Default: cypress
Accepted values: cypress, playwright, none

Test runner to use for end to end (E2E) tests.

inlineStyle

s
boolean
Default: false

Specifies if the style will be in the ts file.

inlineTemplate

t
boolean
Default: false

Specifies if the template will be in the ts file.

linter

string
Default: eslint
Accepted values: eslint, none

The tool to use for running lint checks.

port

number

The port on which this app should be served.

prefix

p
string
Format: html-selector

The prefix to apply to generated selectors.

style

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

The file extension to be used for style files.

skipTests

S
boolean
Default: false

Skip creating spec files.

strict

boolean
Default: true

Create an application with stricter type checking and build optimization options.

setParserOptionsProject

boolean
Default: false

Whether or not to configure the ESLint parserOptions.project option. We do not do this by default for lint performance reasons.

standalone

boolean
Default: false

Whether to generate a remote application with standalone components. Note: This is only supported in Angular versions >= 14.1.0

ssr

boolean
Default: false

Whether to configure SSR for the remote application to be consumed by a host application using SSR.

tags

string

Add tags to the application (used for linting).

unitTestRunner

string
Default: jest
Accepted values: jest, none

Test runner to use for unit tests.

viewEncapsulation

string
Accepted values: Emulated, None, ShadowDom

Specifies the view encapsulation strategy.

skipPackageJson

boolean
Default: false

Do not add dependencies to package.json.

skipFormat

boolean
Default: false

Skip formatting files.

standaloneConfig

Deprecated
boolean
Default: true

Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json.

Nx only supports standaloneConfig