@nx/angular:scam-pipe

Creates a new, generic Angular pipe definition in the given or default project.

Usage

1nx generate scam-pipe ... 2

By default, Nx will search for scam-pipe in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

1nx g @nx/angular:scam-pipe ... 2

Show what will be generated without writing to disk:

1nx g scam-pipe ... --dry-run 2

Examples

Generates a MyTransformationPipe in a my-transformation folder in the my-lib project:

1nx g @nx/angular:scam-pipe --project=my-lib --flat=false my-transformation 2

Options

name

Required
string

The name of the pipe.

directory

string

The directory at which to create the component file. When --nameAndDirectoryFormat=as-provided, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.

export

boolean
Default: true

Specifies if the SCAM should be exported from the project's entry point (normally index.ts). It only applies to libraries.

inlineScam

boolean
Default: true

Create the NgModule in the same file as the Pipe.

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

skipTests

boolean
Default: false

Do not create spec.ts test files for the new pipe.

skipFormat

Internal
boolean
Default: false

Skip formatting files.

flat

Deprecated
boolean
Default: true

Create the new files at the top level of the current project.

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

project

Deprecated
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 v19.