Skip to content

Commit d22ed20

Browse files
committed
fixup! docs: add generation schematics option docs
1 parent 93f3460 commit d22ed20

File tree

3 files changed

+26
-25
lines changed

3 files changed

+26
-25
lines changed

packages/schematics/angular/application/schema.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
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.",
6+
"description": "Generates a new basic app definition in the \"projects\" subfolder of the workspace.",
77
"properties": {
88
"projectRoot": {
99
"description": "The root folder of the new app.",
@@ -25,13 +25,13 @@
2525
"default": false
2626
},
2727
"inlineStyle": {
28-
"description": "When true, includes styles in the TypeScript source file.",
28+
"description": "When true, includes styles inline in the root component TS file. Only CSS styles can be included inline. Default is false, meaning that an external styles file is created and referenced in the root component TS file.",
2929
"type": "boolean",
3030
"default": false,
3131
"alias": "s"
3232
},
3333
"inlineTemplate": {
34-
"description": "When true, includes the template in the TypeScript source file.",
34+
"description": "When true, includes template inline in the root component TS file. Default is false, meaning that an external template file is created and referenced in the root component TS file. ",
3535
"type": "boolean",
3636
"default": false,
3737
"alias": "t"
@@ -43,7 +43,7 @@
4343
},
4444
"routing": {
4545
"type": "boolean",
46-
"description": "When true, generates a routing module.",
46+
"description": "When true, creates a routing NgModule.",
4747
"default": false
4848
},
4949
"prefix": {
@@ -59,15 +59,15 @@
5959
"default": "css"
6060
},
6161
"skipTests": {
62-
"description": "When true, does not create spec test files for the app.",
62+
"description": "When true, does not create \"spec.ts\" test files for the app.",
6363
"type": "boolean",
6464
"default": false,
6565
"alias": "S"
6666
},
6767
"skipPackageJson": {
6868
"type": "boolean",
6969
"default": false,
70-
"description": "When true, does not add dependencies to package.json."
70+
"description": "When true, does not add dependencies to the \"package.json\" file."
7171
},
7272
"minimal": {
7373
"description": "When true, creates a bare-bones project without any testing frameworks.",

packages/schematics/angular/class/schema.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"id": "SchematicsAngularClass",
44
"title": "Angular Class Options Schema",
55
"type": "object",
6-
"description": "Creates a new class in the given or default project.",
6+
"description": "Creates a new generic class definition in the given or default project.",
77
"properties": {
88
"name": {
99
"type": "string",
@@ -17,7 +17,7 @@
1717
"path": {
1818
"type": "string",
1919
"format": "path",
20-
"description": "The path at which to create the class.",
20+
"description": "The path at which to create the class, relative to the current workspace. Default is the top level of the current working directory.",
2121
"visible": false
2222
},
2323
"project": {
@@ -29,12 +29,12 @@
2929
},
3030
"spec": {
3131
"type": "boolean",
32-
"description": "When true, generates a \"spec\" test file for the new class.",
32+
"description": "When true, generates a \"spec.ts\" test file for the new class.",
3333
"default": false
3434
},
3535
"type": {
3636
"type": "string",
37-
"description": "The type of class.",
37+
"description": "Adds a developer-defined type to the filename, in the format \"name.type.ts\".",
3838
"default": ""
3939
}
4040
},

packages/schematics/angular/component/schema.json

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
"id": "SchematicsAngularComponent",
44
"title": "Angular Component Options Schema",
55
"type": "object",
6+
"description": "Creates a new generic component definition in the given or default project.",
67
"properties": {
78
"path": {
89
"type": "string",
910
"format": "path",
10-
"description": "The path to create the component.",
11+
"description": "The path at which to create the component file, relative to the current workspace. Default is a folder with the same name as the component in the project root.",
1112
"visible": false
1213
},
1314
"project": {
@@ -27,33 +28,33 @@
2728
"x-prompt": "What name would you like to use for the component?"
2829
},
2930
"inlineStyle": {
30-
"description": "Specifies if the style will be in the ts file.",
31+
"description": "When true, include styles inline in the component TS file. Only CSS styles can be included inline. By default, an external styles file is created and referenced in the component TS file.",
3132
"type": "boolean",
3233
"default": false,
3334
"alias": "s"
3435
},
3536
"inlineTemplate": {
36-
"description": "Specifies if the template will be in the ts file.",
37+
"description": "When true, include template inline in the component TS file. By default, an external template file is created and referenced in the component TS file.",
3738
"type": "boolean",
3839
"default": false,
3940
"alias": "t"
4041
},
4142
"viewEncapsulation": {
42-
"description": "Specifies the view encapsulation strategy.",
43+
"description": "The view encapsulation strategy to use in the new component.",
4344
"enum": ["Emulated", "Native", "None", "ShadowDom"],
4445
"type": "string",
4546
"alias": "v"
4647
},
4748
"changeDetection": {
48-
"description": "Specifies the change detection strategy.",
49+
"description": "The change detection strategy to use in the new component.",
4950
"enum": ["Default", "OnPush"],
5051
"type": "string",
5152
"default": "Default",
5253
"alias": "c"
5354
},
5455
"prefix": {
5556
"type": "string",
56-
"description": "The prefix to apply to generated selectors.",
57+
"description": "The prefix to apply to the generated component selector.",
5758
"alias": "p",
5859
"oneOf": [
5960
{
@@ -66,49 +67,49 @@
6667
]
6768
},
6869
"styleext": {
69-
"description": "The file extension to be used for style files.",
70+
"description": "The file extension to use for style files.",
7071
"type": "string",
7172
"default": "css"
7273
},
7374
"spec": {
7475
"type": "boolean",
75-
"description": "Specifies if a spec file is generated.",
76+
"description": "When true (the default), generates a \"spec.ts\" test file for the new component.",
7677
"default": true
7778
},
7879
"flat": {
7980
"type": "boolean",
80-
"description": "Flag to indicate if a directory is created.",
81+
"description": "When true, creates the new files at the top level of the current project.",
8182
"default": false
8283
},
8384
"skipImport": {
8485
"type": "boolean",
85-
"description": "Flag to skip the module import.",
86+
"description": "When true, does not import this directive into the owning NgModule.",
8687
"default": false
8788
},
8889
"selector": {
8990
"type": "string",
9091
"format": "html-selector",
91-
"description": "The selector to use for the component."
92+
"description": "The HTML selector to use for this component."
9293
},
9394
"module": {
9495
"type": "string",
95-
"description": "Allows specification of the declaring module.",
96+
"description": "The declaring NgModule.",
9697
"alias": "m"
9798
},
9899
"export": {
99100
"type": "boolean",
100101
"default": false,
101-
"description": "Specifies if declaring module exports the component."
102+
"description": "When true, the declaring NgModule exports this component."
102103
},
103104
"entryComponent": {
104105
"type": "boolean",
105106
"default": false,
106-
"description": "Specifies if the component is an entry component of declaring module."
107+
"description": "When true, the new component is the entry component of the declaring NgModule."
107108
},
108109
"lintFix": {
109110
"type": "boolean",
110111
"default": false,
111-
"description": "Specifies whether to apply lint fixes after generating the component."
112+
"description": "When true, applies lint fixes after generating the component."
112113
}
113114
},
114115
"required": [

0 commit comments

Comments
 (0)