Skip to content

Commit

Permalink
fix(angular): update ngrx parent description to give better info abou…
Browse files Browse the repository at this point in the history
…t standalone api usage (#16755)
  • Loading branch information
Coly010 authored May 4, 2023
1 parent b526e1d commit 0a81c64
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 6 deletions.
14 changes: 11 additions & 3 deletions docs/generated/packages/angular/generators/ngrx.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,20 @@
"type": "object",
"examples": [
{
"command": "nx g @nrwl/angular:ngrx --root --module=apps/my-app/src/app/app.module.ts --facade=false placeholder",
"command": "nx g @nrwl/angular:ngrx --root --parent=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",
"command": "nx g @nrwl/angular:ngrx --parent=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"
},
{
"command": "nx g @nrwl/angular:ngrx --parent=apps/my-app/src/app/app.config.ts --root",
"description": "Add a root state configuration to `my-app` when `my-app` uses Standalone APIs"
},
{
"command": "nx g @nrwl/angular:ngrx --parent=libs/my-lib/src/lib.routes.ts users",
"description": "Add a `users` feature state to the Route definition of a library using Standalone APIs"
}
],
"properties": {
Expand All @@ -33,7 +41,7 @@
},
"parent": {
"type": "string",
"description": "The path to the `NgModule` or the `Routes` definition file (for Standalone API usage) where the feature state will be registered. The host directory will create/use the new state directory. _Note: The Standalone API usage is only supported in Angular versions >= 14.1.0_.",
"description": "The path to the file where the state will be registered. For NgModule usage, this will be your `app.module.ts` for your root state, or your Feature Module for feature state. For Standalone API usage, this will be your `app.config.ts` file for your root state, or the Routes definition file for your feature state. The host directory will create/use the new state directory. _Note: The Standalone API usage is only supported in Angular versions >= 14.1.0_.",
"x-prompt": "What is the path to the module or Routes definition where this NgRx state should be registered?",
"x-priority": "important"
},
Expand Down
14 changes: 11 additions & 3 deletions packages/angular/src/generators/ngrx/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,20 @@
"type": "object",
"examples": [
{
"command": "nx g @nrwl/angular:ngrx --root --module=apps/my-app/src/app/app.module.ts --facade=false placeholder",
"command": "nx g @nrwl/angular:ngrx --root --parent=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",
"command": "nx g @nrwl/angular:ngrx --parent=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"
},
{
"command": "nx g @nrwl/angular:ngrx --parent=apps/my-app/src/app/app.config.ts --root",
"description": "Add a root state configuration to `my-app` when `my-app` uses Standalone APIs"
},
{
"command": "nx g @nrwl/angular:ngrx --parent=libs/my-lib/src/lib.routes.ts users",
"description": "Add a `users` feature state to the Route definition of a library using Standalone APIs"
}
],
"properties": {
Expand All @@ -33,7 +41,7 @@
},
"parent": {
"type": "string",
"description": "The path to the `NgModule` or the `Routes` definition file (for Standalone API usage) where the feature state will be registered. The host directory will create/use the new state directory. _Note: The Standalone API usage is only supported in Angular versions >= 14.1.0_.",
"description": "The path to the file where the state will be registered. For NgModule usage, this will be your `app.module.ts` for your root state, or your Feature Module for feature state. For Standalone API usage, this will be your `app.config.ts` file for your root state, or the Routes definition file for your feature state. The host directory will create/use the new state directory. _Note: The Standalone API usage is only supported in Angular versions >= 14.1.0_.",
"x-prompt": "What is the path to the module or Routes definition where this NgRx state should be registered?",
"x-priority": "important"
},
Expand Down

1 comment on commit 0a81c64

@vercel
Copy link

@vercel vercel bot commented on 0a81c64 May 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-git-master-nrwl.vercel.app
nx-dev-nrwl.vercel.app
nx-five.vercel.app
nx.dev

Please sign in to comment.