@nx/remix:resource-route

Generate a resource route.

Usage

1nx generate resource-route ... 2

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

You can specify the collection explicitly as follows:

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

Show what will be generated without writing to disk:

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

Examples

Generate resource route at /path/to/page:

1g resource-route 'path/to/page' 2

Options

path

Required
string

The route path or path to the filename of the route.

action

boolean
Default: false

Generate an action function

loader

boolean
Default: true

Generate a loader function

nameAndDirectoryFormat

string
Accepted values: as-provided, derived

Whether to generate the styles 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).

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.