@nx/remix:route

Generate a route.

Usage

1nx generate route ... 2

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

You can specify the collection explicitly as follows:

1nx g @nx/remix:route ... 2

Show what will be generated without writing to disk:

1nx g route ... --dry-run 2

Examples

Generate route at /path/to/page:

1g route 'path/to/page' 2

Options

path

Required
string

The route path or path to the filename of the route. When --nameAndDirectoryFormat=as-provided, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.

action

boolean
Default: false

Generate an action function

loader

boolean
Default: false

Generate a loader function

meta

boolean
Default: false

Generate a meta function

nameAndDirectoryFormat

string
Accepted values: as-provided, derived

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

style

string
Default: css
Accepted values: none, css

Generate a stylesheet

skipChecks

boolean
Default: false

Skip route error detection

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 v20.