@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

Generate a pipe with the exported symbol matching the file name. It results in the pipe FooPipe at mylib/src/lib/foo.pipe.ts:

1nx g @nx/angular:scam-pipe mylib/src/lib/foo.pipe.ts 2

Generate a pipe without providing the file extension. It results in the pipe FooPipe at mylib/src/lib/foo.pipe.ts:

1nx g @nx/angular:scam-pipe mylib/src/lib/foo 2

Generate a pipe with the exported symbol different from the file name. It results in the pipe CustomPipe at mylib/src/lib/foo.pipe.ts:

1nx g @nx/angular:scam-pipe mylib/src/lib/foo --name=custom 2

Options

path

Required
string

The file path to the SCAM pipe. Relative to the current working directory.

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.

name

string

The pipe symbol name. Defaults to the last segment of the file path.

skipTests

boolean
Default: false

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

typeSeparator

string
Accepted values: -, .

The separator character to use before the type within the generated file's name. For example, if you set the option to ., the file will be named example.pipe.ts. It defaults to '-' for Angular v20+. For versions below v20, it defaults to '.'.

skipFormat

Internal
boolean
Default: false

Skip formatting files.