@nx/angular:scam-directive

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

Usage

1nx generate scam-directive ... 2

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

You can specify the collection explicitly as follows:

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

Show what will be generated without writing to disk:

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

Examples

Generate a MySampleDirective directive in a my-sample folder in the my-lib library:

1nx g @nx/angular:scam-directive my-sample --directory=my-lib/src/lib/my-sample 2

Options

path

Required
string

The path at which to create the SCAM Directive files, relative to the workspace root.

directory

string

The directory at which to create the SCAM Directive files. 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 Directive.

name

string

The name of the directive.

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

prefix

p
oneOf [string, string]

The prefix to apply to the generated directive selector.

skipTests

boolean
Default: false

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

selector

string
Format: html-selector

The HTML selector to use for this directive.

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

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