@nx/nextSee schema

@nx/next:page

Create a Page for Next.

Examples

❯

nx g page apps/my-app/pages/my-page

Usage

1nx generate page ... 2

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

You can specify the collection explicitly as follows:

1nx g @nx/next:page ... 2

Show what will be generated without writing to disk:

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

Options

path

Required
string

The path to the directory where the page will be generated. Relative to the current working directory.

style

s
string
Default: css

The file extension to be used for style files.

export

e
boolean
Default: false

When true, the component is exported from the project index.ts (if it exists).

js

boolean
Default: false

Generate JavaScript files rather than TypeScript files.

name

string

The page symbol name. If not provided, it defaults to the page directory name.

withTests

boolean
Default: false

When true, creates a spec.ts test file for the new page.

skipFormat

Internal
boolean
Default: false

Skip formatting files.

flat

Deprecated
boolean
Default: false

Create component at the source root rather than its own directory.

Provide the directory option instead and use the as-provided format. It will be removed in Nx v20.