@nx/next:page
Create a Page for Next.
Examples
❯
nx g page my-page --project=my-app
Usage
1nx generate page ...
2By 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 ...
2Show what will be generated without writing to disk:
1nx g page ... --dry-run
2Options
name
Required
string
The name of the component.
directory
dir
string
The directory at which to create the page file. When --nameAndDirectoryFormat=as-provided, it will be relative to the current working directory. Otherwise, it will be relative to the project root.
style
s
string
Default:
cssThe file extension to be used for style files.
export
e
boolean
Default:
falseWhen true, the component is exported from the project index.ts (if it exists).
js
boolean
Default:
falseGenerate JavaScript files rather than TypeScript files.
nameAndDirectoryFormat
string
Accepted values:
as-provided, derivedWhether to generate the component in the directory 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).
withTests
boolean
Default:
falseWhen true, creates a spec.ts test file for the new page.
skipFormat
Internal
boolean
Default:
falseSkip formatting files.
flat
Deprecated
boolean
Default:
falseCreate 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.
project
pDeprecated
string
The name of the project.
Provide the directory option instead and use the as-provided format. The project will be determined from the directory provided. It will be removed in Nx v20.