Skip to content

Commit 09d1daf

Browse files
committed
fixup! docs: add generation schematics option docs
1 parent d22ed20 commit 09d1daf

File tree

5 files changed

+29
-20
lines changed

5 files changed

+29
-20
lines changed

packages/schematics/angular/directive/schema.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"properties": {
77
"name": {
88
"type": "string",
9-
"description": "The name of the directive.",
9+
"description": "The name of the new directive.",
1010
"$default": {
1111
"$source": "argv",
1212
"index": 0
@@ -16,7 +16,7 @@
1616
"path": {
1717
"type": "string",
1818
"format": "path",
19-
"description": "The path to create the interface.",
19+
"description": "The path at which to create the interface that defines the directive, relative to the current workspace.",
2020
"visible": false
2121
},
2222
"project": {
@@ -28,7 +28,7 @@
2828
},
2929
"prefix": {
3030
"type": "string",
31-
"description": "The prefix to apply to generated selectors.",
31+
"description": "A prefix to apply to generated selectors.",
3232
"alias": "p",
3333
"oneOf": [
3434
{
@@ -42,38 +42,38 @@
4242
},
4343
"spec": {
4444
"type": "boolean",
45-
"description": "Specifies if a spec file is generated.",
45+
"description": "When true (the default), generates a \"spec.ts\" test file for the new directive.",
4646
"default": true
4747
},
4848
"skipImport": {
4949
"type": "boolean",
50-
"description": "Flag to skip the module import.",
50+
"description": "When true, does not import this directive into the owning NgModule.",
5151
"default": false
5252
},
5353
"selector": {
5454
"type": "string",
5555
"format": "html-selector",
56-
"description": "The selector to use for the directive."
56+
"description": "The HTML selector to use for this directive."
5757
},
5858
"flat": {
5959
"type": "boolean",
60-
"description": "Flag to indicate if a directory is created.",
60+
"description": "When true (the default), creates the new files at the top level of the current project.",
6161
"default": true
6262
},
6363
"module": {
6464
"type": "string",
65-
"description": "Allows specification of the declaring module.",
65+
"description": "The declaring NgModule.",
6666
"alias": "m"
6767
},
6868
"export": {
6969
"type": "boolean",
7070
"default": false,
71-
"description": "Specifies if declaring module exports the directive."
71+
"description": "When true, the declaring NgModule exports this directive."
7272
},
7373
"lintFix": {
7474
"type": "boolean",
7575
"default": false,
76-
"description": "Specifies whether to apply lint fixes after generating the directive."
76+
"description": "When true, applies lint fixes after generating the directive."
7777
}
7878
},
7979
"required": [
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
The e2e tests are created in a separate app, next to the project being tested in the `projects` folder of the workspace.

packages/schematics/angular/e2e/schema.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,16 @@
33
"id": "SchematicsAngularE2eApp",
44
"title": "Angular e2e Application Options Schema",
55
"type": "object",
6+
"description": "Generates a new, generic end-to-end test definition for the given or default project.",
7+
"long-description": "e2e-long.md",
68
"properties": {
79
"projectRoot": {
8-
"description": "The root directory of the new application.",
10+
"description": "The root folder for the new test app.",
911
"type": "string",
1012
"visible": false
1113
},
1214
"name": {
13-
"description": "The name of the e2e application.",
15+
"description": "The name of the new e2e app.",
1416
"type": "string",
1517
"format": "html-selector",
1618
"$default": {
@@ -19,7 +21,7 @@
1921
}
2022
},
2123
"rootSelector": {
22-
"description": "HTML selector for the root component.",
24+
"description": "The HTML selector for the root component of the test app.",
2325
"type": "string",
2426
"default": "app-root"
2527
},

packages/schematics/angular/enum/schema.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"id": "SchematicsAngularEnum",
44
"title": "Angular Enum Options Schema",
55
"type": "object",
6+
"description": "Generates a new, generic enum definition for the given or default project.",
67
"properties": {
78
"name": {
89
"type": "string",
@@ -16,20 +17,20 @@
1617
"path": {
1718
"type": "string",
1819
"format": "path",
19-
"description": "The path to create the enum.",
20+
"description": "The path at which to create the enum definition, relative to the current workspace.",
2021
"visible": false
2122
},
2223
"project": {
2324
"type": "string",
24-
"description": "The name of the project.",
25+
"description": "The name of the project in which to create the enum. Default is the configured default project for the workspace.",
2526
"$default": {
2627
"$source": "projectName"
2728
}
2829
},
2930
"lintFix": {
3031
"type": "boolean",
3132
"default": false,
32-
"description": "Specifies whether to apply lint fixes after generating the enum."
33+
"description": "When true, applies lint fixes after generating the enum."
3334
}
3435
},
3536
"required": [

packages/schematics/angular/guard/schema.json

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
"id": "SchematicsAngularGuard",
44
"title": "Angular Guard Options Schema",
55
"type": "object",
6+
"description": "Generates a new, generic route guard definition in the given or default project.",
67
"properties": {
78
"name": {
89
"type": "string",
9-
"description": "The name of the guard.",
10+
"description": "The name of the new route guard.",
1011
"$default": {
1112
"$source": "argv",
1213
"index": 0
@@ -15,18 +16,22 @@
1516
},
1617
"spec": {
1718
"type": "boolean",
18-
"description": "Specifies if a spec file is generated.",
19+
"description": "When true (the default), generates a \"spec.ts\" test file for the new guard.",
1920
"default": true
2021
},
2122
"flat": {
2223
"type": "boolean",
24+
<<<<<<< HEAD
2325
"description": "Flag to indicate if a directory is created.",
26+
=======
27+
"description": "When true (the default), creates the new files at the top level of the current project.",
28+
>>>>>>> fixup! docs: add generation schematics option docs
2429
"default": true
2530
},
2631
"path": {
2732
"type": "string",
2833
"format": "path",
29-
"description": "The path to create the interface.",
34+
"description": "The path at which to create the interface that defines the guard, relative to the current workspace.",
3035
"visible": false
3136
},
3237
"project": {
@@ -39,7 +44,7 @@
3944
"lintFix": {
4045
"type": "boolean",
4146
"default": false,
42-
"description": "Specifies whether to apply lint fixes after generating the guard."
47+
"description": "When true, applies lint fixes after generating the guard."
4348
}
4449
},
4550
"required": [

0 commit comments

Comments
 (0)