Skip to content

Commit 93f3460

Browse files
committed
docs: add generation schematics option docs
1 parent 69840cd commit 93f3460

File tree

4 files changed

+25
-21
lines changed

4 files changed

+25
-21
lines changed

packages/schematics/angular/app-shell/app-shell-long.md

Whitespace-only changes.

packages/schematics/angular/app-shell/schema.json

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,16 @@
33
"id": "SchematicsAngularAppShell",
44
"title": "Angular AppShell Options Schema",
55
"type": "object",
6+
"description": "Generates an app shell for running a server-side version of an app.",
7+
"long-description": "",
68
"properties": {
79
"clientProject": {
810
"type": "string",
9-
"description": "Name of related client app."
11+
"description": "The name of the related client app."
1012
},
1113
"universalProject": {
1214
"type": "string",
13-
"description": "Name of related universal app."
15+
"description": "The name of related Universal app."
1416
},
1517
"route": {
1618
"type": "string",
@@ -20,12 +22,12 @@
2022
"name": {
2123
"type": "string",
2224
"format": "html-selector",
23-
"description": "Name of the universal app"
25+
"description": "The HTML selector of the Universal app"
2426
},
2527
"appId": {
2628
"type": "string",
2729
"format": "html-selector",
28-
"description": "The appId to use withServerTransition.",
30+
"description": "The app ID to use in withServerTransition().",
2931
"default": "serverApp"
3032
},
3133
"outDir": {
@@ -43,7 +45,7 @@
4345
"index": {
4446
"type": "string",
4547
"format": "path",
46-
"description": "Name of the index file",
48+
"description": "The name of the index file",
4749
"default": "index.html"
4850
},
4951
"main": {

packages/schematics/angular/application/schema.json

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@
33
"id": "SchematicsAngularApp",
44
"title": "Angular Application Options Schema",
55
"type": "object",
6+
"description": "Generates a new app skeleton in the \"projects\" subfolder of the workspace.",
67
"properties": {
78
"projectRoot": {
8-
"description": "The root directory of the new application.",
9+
"description": "The root folder of the new app.",
910
"type": "string",
1011
"visible": false
1112
},
1213
"name": {
13-
"description": "The name of the application.",
14+
"description": "The name of the new app.",
1415
"type": "string",
1516
"$default": {
1617
"$source": "argv",
@@ -19,57 +20,57 @@
1920
"x-prompt": "What name would you like to use for the application?"
2021
},
2122
"experimentalIvy": {
22-
"description": "EXPERIMENTAL: Specifies whether to create a new application which uses the Ivy rendering engine.",
23+
"description": "EXPERIMENTAL: True to create a new app that uses the Ivy rendering engine.",
2324
"type": "boolean",
2425
"default": false
2526
},
2627
"inlineStyle": {
27-
"description": "Specifies if the style will be in the ts file.",
28+
"description": "When true, includes styles in the TypeScript source file.",
2829
"type": "boolean",
2930
"default": false,
3031
"alias": "s"
3132
},
3233
"inlineTemplate": {
33-
"description": "Specifies if the template will be in the ts file.",
34+
"description": "When true, includes the template in the TypeScript source file.",
3435
"type": "boolean",
3536
"default": false,
3637
"alias": "t"
3738
},
3839
"viewEncapsulation": {
39-
"description": "Specifies the view encapsulation strategy.",
40+
"description": "The view encapsulation strategy to use in the new app.",
4041
"enum": ["Emulated", "Native", "None", "ShadowDom"],
4142
"type": "string"
4243
},
4344
"routing": {
4445
"type": "boolean",
45-
"description": "Generates a routing module.",
46+
"description": "When true, generates a routing module.",
4647
"default": false
4748
},
4849
"prefix": {
4950
"type": "string",
5051
"format": "html-selector",
51-
"description": "The prefix to apply to generated selectors.",
52+
"description": "A prefix to apply to generated selectors.",
5253
"default": "app",
5354
"alias": "p"
5455
},
5556
"style": {
56-
"description": "The file extension to be used for style files.",
57+
"description": "The file extension to use for style files.",
5758
"type": "string",
5859
"default": "css"
5960
},
6061
"skipTests": {
61-
"description": "Skip creating spec files.",
62+
"description": "When true, does not create spec test files for the app.",
6263
"type": "boolean",
6364
"default": false,
6465
"alias": "S"
6566
},
6667
"skipPackageJson": {
6768
"type": "boolean",
6869
"default": false,
69-
"description": "Do not add dependencies to package.json."
70+
"description": "When true, does not add dependencies to package.json."
7071
},
7172
"minimal": {
72-
"description": "Create a barebones project without any testing frameworks",
73+
"description": "When true, creates a bare-bones project without any testing frameworks.",
7374
"type": "boolean",
7475
"default": false
7576
}

packages/schematics/angular/class/schema.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
"id": "SchematicsAngularClass",
44
"title": "Angular Class Options Schema",
55
"type": "object",
6+
"description": "Creates a new class in the given or default project.",
67
"properties": {
78
"name": {
89
"type": "string",
9-
"description": "The name of the class.",
10+
"description": "The name of the new class.",
1011
"$default": {
1112
"$source": "argv",
1213
"index": 0
@@ -16,7 +17,7 @@
1617
"path": {
1718
"type": "string",
1819
"format": "path",
19-
"description": "The path to create the class.",
20+
"description": "The path at which to create the class.",
2021
"visible": false
2122
},
2223
"project": {
@@ -28,12 +29,12 @@
2829
},
2930
"spec": {
3031
"type": "boolean",
31-
"description": "Specifies if a spec file is generated.",
32+
"description": "When true, generates a \"spec\" test file for the new class.",
3233
"default": false
3334
},
3435
"type": {
3536
"type": "string",
36-
"description": "Specifies the type of class.",
37+
"description": "The type of class.",
3738
"default": ""
3839
}
3940
},

0 commit comments

Comments
 (0)