@nx/remix:error-boundary

Generate an ErrorBoundary for a given route.

Usage

1nx generate error-boundary ... 2

By default, Nx will search for error-boundary in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

1nx g @nx/remix:error-boundary ... 2
Nx 15 and lower use @nrwl/ instead of @nx/

Show what will be generated without writing to disk:

1nx g error-boundary ... --dry-run 2

Examples

Generate an ErrorBoundary for my-route.tsx:

1g error-boundary --routePath=apps/demo/app/routes/my-route.tsx 2

Options

path

Required
string

The path to route file relative to the project root.

nameAndDirectoryFormat

string
Accepted values: as-provided, derived

Whether to generate the error boundary in the path as provided, relative to the current working directory and ignoring the project (as-provided) or generate it using the project and directory relative to the workspace root (derived).

skipFormat

Internal
boolean
Default: false

Skip formatting files after generation.

project

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

The name of the project.

Provide the path option instead and use the as-provided format. The project will be determined from the path provided. It will be removed in Nx v18.