87 lines
3.3 KiB
JSON
87 lines
3.3 KiB
JSON
{
|
|
"name": "ngrx",
|
|
"factory": "./src/generators/ngrx/ngrx",
|
|
"schema": {
|
|
"$schema": "http://json-schema.org/schema",
|
|
"$id": "NxNgrxGenerator",
|
|
"title": "Add NgRx support to an application or library.",
|
|
"description": "Adds NgRx support to an application or library.",
|
|
"cli": "nx",
|
|
"type": "object",
|
|
"examples": [
|
|
{
|
|
"command": "nx g @nrwl/angular:ngrx --root --module=apps/my-app/src/app/app.module.ts --facade=false placeholder",
|
|
"description": "Add root ngrx configration to the `my-app` application"
|
|
},
|
|
{
|
|
"command": "nx g @nrwl/angular:ngrx --module=libs/my-lib/src/lib/my-lib.module.ts --facade=true --root=false users",
|
|
"description": "Add a `users` state with a facade to the `my-lib` library. It will be tracked under the default `+state` folder in the lib"
|
|
}
|
|
],
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Name of the NgRx feature state, such as `products` or `users`. Recommended to use the plural form of the name.",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-prompt": "What name would you like to use for the NgRx feature state? An example would be `users`."
|
|
},
|
|
"module": {
|
|
"type": "string",
|
|
"description": "The path to the `NgModule` where the feature state will be registered. The host directory will create/use the new state directory.",
|
|
"x-prompt": "What is the path to the module where this NgRx state should be registered?"
|
|
},
|
|
"directory": {
|
|
"type": "string",
|
|
"default": "+state",
|
|
"description": "The name of the folder used to contain/group the generated NgRx files."
|
|
},
|
|
"root": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Setup root or feature state management with NgRx.",
|
|
"x-prompt": "Is this the root state of the application?"
|
|
},
|
|
"facade": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Create a Facade class for the the feature.",
|
|
"x-prompt": "Would you like to use a Facade with your NgRx state?"
|
|
},
|
|
"skipImport": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Generate NgRx feature files without registering the feature in the NgModule."
|
|
},
|
|
"minimal": {
|
|
"type": "boolean",
|
|
"default": true,
|
|
"description": "Only register the root state management setup or feature state."
|
|
},
|
|
"skipFormat": {
|
|
"description": "Skip formatting files.",
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"skipPackageJson": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Do not update the `package.json` with NgRx dependencies."
|
|
},
|
|
"barrels": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Use barrels to re-export actions, state and selectors."
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": ["module", "name"],
|
|
"presets": []
|
|
},
|
|
"description": "Adds NgRx support to an application or library.",
|
|
"implementation": "/packages/angular/src/generators/ngrx/ngrx.ts",
|
|
"aliases": [],
|
|
"hidden": false,
|
|
"path": "/packages/angular/src/generators/ngrx/schema.json",
|
|
"type": "generator"
|
|
}
|