| 1 | {
|
|---|
| 2 | "$schema": "http://json-schema.org/draft-07/schema",
|
|---|
| 3 | "$id": "SchematicsAngularComponent",
|
|---|
| 4 | "title": "Angular Component Options Schema",
|
|---|
| 5 | "type": "object",
|
|---|
| 6 | "description": "Creates a new, generic component definition in the given or default project.",
|
|---|
| 7 | "additionalProperties": false,
|
|---|
| 8 | "properties": {
|
|---|
| 9 | "path": {
|
|---|
| 10 | "type": "string",
|
|---|
| 11 | "format": "path",
|
|---|
| 12 | "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.",
|
|---|
| 13 | "visible": false
|
|---|
| 14 | },
|
|---|
| 15 | "project": {
|
|---|
| 16 | "type": "string",
|
|---|
| 17 | "description": "The name of the project.",
|
|---|
| 18 | "$default": {
|
|---|
| 19 | "$source": "projectName"
|
|---|
| 20 | }
|
|---|
| 21 | },
|
|---|
| 22 | "name": {
|
|---|
| 23 | "type": "string",
|
|---|
| 24 | "description": "The name of the component.",
|
|---|
| 25 | "$default": {
|
|---|
| 26 | "$source": "argv",
|
|---|
| 27 | "index": 0
|
|---|
| 28 | },
|
|---|
| 29 | "x-prompt": "What name would you like to use for the component?"
|
|---|
| 30 | },
|
|---|
| 31 | "displayBlock": {
|
|---|
| 32 | "description": "Specifies if the style will contain `:host { display: block; }`.",
|
|---|
| 33 | "type": "boolean",
|
|---|
| 34 | "default": false,
|
|---|
| 35 | "alias": "b"
|
|---|
| 36 | },
|
|---|
| 37 | "inlineStyle": {
|
|---|
| 38 | "description": "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.",
|
|---|
| 39 | "type": "boolean",
|
|---|
| 40 | "default": false,
|
|---|
| 41 | "alias": "s",
|
|---|
| 42 | "x-user-analytics": 9
|
|---|
| 43 | },
|
|---|
| 44 | "inlineTemplate": {
|
|---|
| 45 | "description": "Include template inline in the component.ts file. By default, an external template file is created and referenced in the component.ts file.",
|
|---|
| 46 | "type": "boolean",
|
|---|
| 47 | "default": false,
|
|---|
| 48 | "alias": "t",
|
|---|
| 49 | "x-user-analytics": 10
|
|---|
| 50 | },
|
|---|
| 51 | "viewEncapsulation": {
|
|---|
| 52 | "description": "The view encapsulation strategy to use in the new component.",
|
|---|
| 53 | "enum": ["Emulated", "None", "ShadowDom"],
|
|---|
| 54 | "type": "string",
|
|---|
| 55 | "alias": "v",
|
|---|
| 56 | "x-user-analytics": 11
|
|---|
| 57 | },
|
|---|
| 58 | "changeDetection": {
|
|---|
| 59 | "description": "The change detection strategy to use in the new component.",
|
|---|
| 60 | "enum": ["Default", "OnPush"],
|
|---|
| 61 | "type": "string",
|
|---|
| 62 | "default": "Default",
|
|---|
| 63 | "alias": "c"
|
|---|
| 64 | },
|
|---|
| 65 | "prefix": {
|
|---|
| 66 | "type": "string",
|
|---|
| 67 | "description": "The prefix to apply to the generated component selector.",
|
|---|
| 68 | "alias": "p",
|
|---|
| 69 | "oneOf": [
|
|---|
| 70 | {
|
|---|
| 71 | "maxLength": 0
|
|---|
| 72 | },
|
|---|
| 73 | {
|
|---|
| 74 | "minLength": 1,
|
|---|
| 75 | "format": "html-selector"
|
|---|
| 76 | }
|
|---|
| 77 | ]
|
|---|
| 78 | },
|
|---|
| 79 | "style": {
|
|---|
| 80 | "description": "The file extension or preprocessor to use for style files, or 'none' to skip generating the style file.",
|
|---|
| 81 | "type": "string",
|
|---|
| 82 | "default": "css",
|
|---|
| 83 | "enum": ["css", "scss", "sass", "less", "none"],
|
|---|
| 84 | "x-user-analytics": 5
|
|---|
| 85 | },
|
|---|
| 86 | "type": {
|
|---|
| 87 | "type": "string",
|
|---|
| 88 | "description": "Adds a developer-defined type to the filename, in the format \"name.type.ts\".",
|
|---|
| 89 | "default": "Component"
|
|---|
| 90 | },
|
|---|
| 91 | "skipTests": {
|
|---|
| 92 | "type": "boolean",
|
|---|
| 93 | "description": "Do not create \"spec.ts\" test files for the new component.",
|
|---|
| 94 | "default": false,
|
|---|
| 95 | "x-user-analytics": 12
|
|---|
| 96 | },
|
|---|
| 97 | "flat": {
|
|---|
| 98 | "type": "boolean",
|
|---|
| 99 | "description": "Create the new files at the top level of the current project.",
|
|---|
| 100 | "default": false
|
|---|
| 101 | },
|
|---|
| 102 | "skipImport": {
|
|---|
| 103 | "type": "boolean",
|
|---|
| 104 | "description": "Do not import this component into the owning NgModule.",
|
|---|
| 105 | "default": false,
|
|---|
| 106 | "x-user-analytics": 18
|
|---|
| 107 | },
|
|---|
| 108 | "selector": {
|
|---|
| 109 | "type": "string",
|
|---|
| 110 | "format": "html-selector",
|
|---|
| 111 | "description": "The HTML selector to use for this component."
|
|---|
| 112 | },
|
|---|
| 113 | "skipSelector": {
|
|---|
| 114 | "type": "boolean",
|
|---|
| 115 | "default": false,
|
|---|
| 116 | "description": "Specifies if the component should have a selector or not."
|
|---|
| 117 | },
|
|---|
| 118 | "module": {
|
|---|
| 119 | "type": "string",
|
|---|
| 120 | "description": "The declaring NgModule.",
|
|---|
| 121 | "alias": "m"
|
|---|
| 122 | },
|
|---|
| 123 | "export": {
|
|---|
| 124 | "type": "boolean",
|
|---|
| 125 | "default": false,
|
|---|
| 126 | "description": "The declaring NgModule exports this component.",
|
|---|
| 127 | "x-user-analytics": 19
|
|---|
| 128 | },
|
|---|
| 129 | "lintFix": {
|
|---|
| 130 | "type": "boolean",
|
|---|
| 131 | "description": "Apply lint fixes after generating the component.",
|
|---|
| 132 | "x-user-analytics": 15,
|
|---|
| 133 | "x-deprecated": "Use \"ng lint --fix\" directly instead."
|
|---|
| 134 | }
|
|---|
| 135 | },
|
|---|
| 136 | "required": ["name"]
|
|---|
| 137 | }
|
|---|
