Suite workspace generators¶
The Suite Framework includes
workspace generators to be
used with the nx CLI. These generators are known as
Info
The commands described here should be run into the /angular folder.
AddTestsFiles¶
Adds Jest test configuration files to an existing Nx library/module
Usage¶
| Bash | |
|---|---|
Options¶
groupingFolderName¶
The name of the folder that groups the library within the module (optional, e.g., form, admin). Use when you have multiple libraries grouped under subfolders
Type: string.
Default argument index: 2.
libraryName¶
The name of the library (optional, e.g., feature, domain, shared, ui). If not provided, tests will be added at module level
Type: string.
Default argument index: 1.
moduleName¶
The name of the module
Required: True.
Type: string.
Default argument index: 0.
global-search-provider¶
Usage¶
| Bash | |
|---|---|
Options¶
module¶
Modulo location
Required: True.
Type: string.
name¶
Component name
Required: True.
Type: string.
Default argument index: 0.
SuiteApp¶
Usage¶
| Bash | |
|---|---|
Options¶
name¶
Required: True.
Type: string.
Default argument index: 0.
tags¶
Add tags to the project (used for linting)
Type: string.
Default: scope:app.
NewSuiteModule¶
Usage¶
| Bash | |
|---|---|
Options¶
directory¶
A directory where the project is placed
Type: string.
name¶
Required: True.
Type: string.
Default argument index: 0.
SuiteApp¶
Usage¶
| Bash | |
|---|---|
Options¶
name¶
Required: True.
Type: string.
Default argument index: 0.
tags¶
Add tags to the project (used for linting)
Type: string.
Default: scope:app.
ListFormPage¶
Usage¶
| Bash | |
|---|---|
Options¶
cud¶
Cud selection
Required: True.
Type: string.
module¶
Module location
Required: True.
Type: string.
name¶
Name of the feature
Required: True.
Type: string.
tags¶
Add tags to the project (used for linting)
Type: string.
SuiteDomainLibrary¶
Generates a domain library with NgRx state management (actions, effects, reducer, selectors)
Usage¶
| Bash | |
|---|---|
Options¶
directory¶
Optional directory path relative to modules/ (e.g., 'admin-center' creates modules/admin-center/[name]/domain)
Type: string.
name¶
The name of the domain entity (e.g., 'users', 'products', 'orders')
Required: True.
Type: string.
Default argument index: 0.
tags¶
Additional tags for the project (default: 'type:domain' for linting enforcement)
Type: string.
Default: type:domain.
SuiteFeatureLibrary¶
Usage¶
| Bash | |
|---|---|
Options¶
directory¶
A directory where the project is placed
Type: string.
name¶
Required: True.
Type: string.
Default argument index: 0.
routing¶
Create a routing module fot the Feature Module
Type: boolean.
FormPage¶
Usage¶
| Bash | |
|---|---|
Options¶
module¶
Modulo location
Type: string.
name¶
Required: True.
Type: string.
Default argument index: 0.
preset¶
Preset configuration to load customizations
Required: True.
Type: string.
tags¶
Add tags to the project (used for linting)
Type: string.
SuiteNodeLibrary¶
Usage¶
| Bash | |
|---|---|
Options¶
directory¶
A directory where the project is placed
Type: string.
name¶
Required: True.
Type: string.
Default argument index: 0.
SuiteRoot¶
Usage¶
| Bash | |
|---|---|
Options¶
directory¶
A directory where the project is placed
Type: string.
name¶
Required: True.
Type: string.
Default argument index: 0.
SuiteSharedLibrary¶
Usage¶
| Bash | |
|---|---|
Options¶
directory¶
A directory where the project is placed
Type: string.
name¶
Required: True.
Type: string.
Default argument index: 0.
SuiteUiLibrary¶
Usage¶
| Bash | |
|---|---|
Options¶
directory¶
A directory where the project is placed
Type: string.
name¶
Required: True.
Type: string.
Default argument index: 0.
SuiteWidget¶
Usage¶
| Bash | |
|---|---|
Options¶
directory¶
A directory where the project is placed
Type: string.
name¶
Required: True.
Type: string.
Default argument index: 0.