@nx/nest:module

Nest Module Options Schema.

Usage

1nx generate module ... 2

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

You can specify the collection explicitly as follows:

1nx g @nx/nest:module ... 2

Show what will be generated without writing to disk:

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

Options

name

Required
string

The name of the module.

directory

string

Directory where the generated files are placed. when --nameAndDirectoryFormat=as-provided, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.

language

string
Accepted values: js, ts

Nest module language.

module

string
Format: path

The path to import the module.

nameAndDirectoryFormat

string
Accepted values: as-provided, derived

Whether 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).

skipImport

boolean
Default: false

Flag to skip the module import.

skipFormat

Internal
boolean
Default: false

Skip formatting files.

flat

Deprecated
boolean
Default: false

Flag to indicate if a directory is created.

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

project

pDeprecated
string

The Nest project to target.

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.