@nx/angular:host

Create an Angular Host Module Federation Application.

Usage

nx generate host ...

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

You can specify the collection explicitly as follows:

Show what will be generated without writing to disk:

nx g host ... --dry-run

Examples

Create an Angular application with configuration in place for Module Federation. If the remotes option is provided, attach the remote application to this application's configuration:

nx g @nrwl/angular:host appName --remotes=remote1

Options

name

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

The name to give to the host Angular application.

remotes

Array<anything>

The names of the remote applications to add to the host.

ssr

boolean
Default: false

Whether to configure SSR for the host application

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.

dynamic

boolean
Default: false

Should the host application use dynamic federation?

directory

string

The directory of the new application.

e2eTestRunner

string
Default: cypress
Accepted values: cypress, 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.

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 host application that uses standalone components. Note: This is only supported in Angular versions >= 14.1.0

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.

skipPostInstall

boolean
Default: false

Do not add or append ngcc to the postinstall script in 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