|
3 | 3 | "id": "SchematicsAngularComponent", |
4 | 4 | "title": "Angular Component Options Schema", |
5 | 5 | "type": "object", |
| 6 | + "description": "Creates a new generic component definition in the given or default project.", |
6 | 7 | "properties": { |
7 | 8 | "path": { |
8 | 9 | "type": "string", |
9 | 10 | "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.", |
11 | 12 | "visible": false |
12 | 13 | }, |
13 | 14 | "project": { |
|
27 | 28 | "x-prompt": "What name would you like to use for the component?" |
28 | 29 | }, |
29 | 30 | "inlineStyle": { |
30 | | - "description": "Specifies if the style will be in the ts file.", |
| 31 | + "description": "When true, includes 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.", |
31 | 32 | "type": "boolean", |
32 | 33 | "default": false, |
33 | 34 | "alias": "s" |
34 | 35 | }, |
35 | 36 | "inlineTemplate": { |
36 | | - "description": "Specifies if the template will be in the ts file.", |
| 37 | + "description": "When true, includes template inline in the component TS file. By default, an external template file is created and referenced in the component TS file.", |
37 | 38 | "type": "boolean", |
38 | 39 | "default": false, |
39 | 40 | "alias": "t" |
40 | 41 | }, |
41 | 42 | "viewEncapsulation": { |
42 | | - "description": "Specifies the view encapsulation strategy.", |
| 43 | + "description": "The view encapsulation strategy to use in the new component.", |
43 | 44 | "enum": ["Emulated", "Native", "None", "ShadowDom"], |
44 | 45 | "type": "string", |
45 | 46 | "alias": "v" |
46 | 47 | }, |
47 | 48 | "changeDetection": { |
48 | | - "description": "Specifies the change detection strategy.", |
| 49 | + "description": "The change detection strategy to use in the new component.", |
49 | 50 | "enum": ["Default", "OnPush"], |
50 | 51 | "type": "string", |
51 | 52 | "default": "Default", |
52 | 53 | "alias": "c" |
53 | 54 | }, |
54 | 55 | "prefix": { |
55 | 56 | "type": "string", |
56 | | - "description": "The prefix to apply to generated selectors.", |
| 57 | + "description": "The prefix to apply to the generated component selector.", |
57 | 58 | "alias": "p", |
58 | 59 | "oneOf": [ |
59 | 60 | { |
|
66 | 67 | ] |
67 | 68 | }, |
68 | 69 | "styleext": { |
69 | | - "description": "The file extension to be used for style files.", |
| 70 | + "description": "The file extension to use for style files.", |
70 | 71 | "type": "string", |
71 | 72 | "default": "css" |
72 | 73 | }, |
73 | 74 | "spec": { |
74 | 75 | "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.", |
76 | 77 | "default": true |
77 | 78 | }, |
78 | 79 | "flat": { |
79 | 80 | "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.", |
81 | 82 | "default": false |
82 | 83 | }, |
83 | 84 | "skipImport": { |
84 | 85 | "type": "boolean", |
85 | | - "description": "Flag to skip the module import.", |
| 86 | + "description": "When true, does not import this component into the owning NgModule.", |
86 | 87 | "default": false |
87 | 88 | }, |
88 | 89 | "selector": { |
89 | 90 | "type": "string", |
90 | 91 | "format": "html-selector", |
91 | | - "description": "The selector to use for the component." |
| 92 | + "description": "The HTML selector to use for this component." |
92 | 93 | }, |
93 | 94 | "module": { |
94 | 95 | "type": "string", |
95 | | - "description": "Allows specification of the declaring module.", |
| 96 | + "description": "The declaring NgModule.", |
96 | 97 | "alias": "m" |
97 | 98 | }, |
98 | 99 | "export": { |
99 | 100 | "type": "boolean", |
100 | 101 | "default": false, |
101 | | - "description": "Specifies if declaring module exports the component." |
| 102 | + "description": "When true, the declaring NgModule exports this component." |
102 | 103 | }, |
103 | 104 | "entryComponent": { |
104 | 105 | "type": "boolean", |
105 | 106 | "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." |
107 | 108 | }, |
108 | 109 | "lintFix": { |
109 | 110 | "type": "boolean", |
110 | 111 | "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." |
112 | 113 | } |
113 | 114 | }, |
114 | 115 | "required": [ |
|
0 commit comments