diff --git a/packages/schematics/angular/app-shell/app-shell-long.md b/packages/schematics/angular/app-shell/app-shell-long.md new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/packages/schematics/angular/app-shell/schema.json b/packages/schematics/angular/app-shell/schema.json index bccd2e25ebee..975921de5784 100644 --- a/packages/schematics/angular/app-shell/schema.json +++ b/packages/schematics/angular/app-shell/schema.json @@ -3,14 +3,16 @@ "id": "SchematicsAngularAppShell", "title": "Angular AppShell Options Schema", "type": "object", + "description": "Generates an app shell for running a server-side version of an app.", + "long-description": "", "properties": { "clientProject": { "type": "string", - "description": "Name of related client app." + "description": "The name of the related client app." }, "universalProject": { "type": "string", - "description": "Name of related universal app." + "description": "The name of related Universal app." }, "route": { "type": "string", @@ -20,12 +22,12 @@ "name": { "type": "string", "format": "html-selector", - "description": "Name of the universal app" + "description": "The HTML selector of the Universal app" }, "appId": { "type": "string", "format": "html-selector", - "description": "The appId to use withServerTransition.", + "description": "The app ID to use in withServerTransition().", "default": "serverApp" }, "outDir": { @@ -43,7 +45,7 @@ "index": { "type": "string", "format": "path", - "description": "Name of the index file", + "description": "The name of the index file", "default": "index.html" }, "main": { diff --git a/packages/schematics/angular/application/schema.json b/packages/schematics/angular/application/schema.json index 86d71341402c..30c600bf421f 100644 --- a/packages/schematics/angular/application/schema.json +++ b/packages/schematics/angular/application/schema.json @@ -3,14 +3,15 @@ "id": "SchematicsAngularApp", "title": "Angular Application Options Schema", "type": "object", + "description": "Generates a new basic app definition in the \"projects\" subfolder of the workspace.", "properties": { "projectRoot": { - "description": "The root directory of the new application.", + "description": "The root directory of the new app.", "type": "string", "visible": false }, "name": { - "description": "The name of the application.", + "description": "The name of the new app.", "type": "string", "$default": { "$source": "argv", @@ -19,46 +20,46 @@ "x-prompt": "What name would you like to use for the application?" }, "experimentalIvy": { - "description": "EXPERIMENTAL: Specifies whether to create a new application which uses the Ivy rendering engine.", + "description": "EXPERIMENTAL: True to create a new app that uses the Ivy rendering engine.", "type": "boolean", "default": false }, "inlineStyle": { - "description": "Specifies if the style will be in the ts file.", + "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.", "type": "boolean", "default": false, "alias": "s" }, "inlineTemplate": { - "description": "Specifies if the template will be in the ts file.", + "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. ", "type": "boolean", "default": false, "alias": "t" }, "viewEncapsulation": { - "description": "Specifies the view encapsulation strategy.", + "description": "The view encapsulation strategy to use in the new app.", "enum": ["Emulated", "Native", "None", "ShadowDom"], "type": "string" }, "routing": { "type": "boolean", - "description": "Generates a routing module.", + "description": "When true, creates a routing NgModule.", "default": false }, "prefix": { "type": "string", "format": "html-selector", - "description": "The prefix to apply to generated selectors.", + "description": "A prefix to apply to generated selectors.", "default": "app", "alias": "p" }, "style": { - "description": "The file extension to be used for style files.", + "description": "The file extension to use for style files.", "type": "string", "default": "css" }, "skipTests": { - "description": "Skip creating spec files.", + "description": "When true, does not create \"spec.ts\" test files for the app.", "type": "boolean", "default": false, "alias": "S" @@ -66,10 +67,10 @@ "skipPackageJson": { "type": "boolean", "default": false, - "description": "Do not add dependencies to package.json." + "description": "When true, does not add dependencies to the \"package.json\" file." }, "minimal": { - "description": "Create a barebones project without any testing frameworks", + "description": "When true, creates a bare-bones project without any testing frameworks.", "type": "boolean", "default": false } diff --git a/packages/schematics/angular/class/schema.json b/packages/schematics/angular/class/schema.json index 9995a0b4c8f9..7d1d12877afb 100644 --- a/packages/schematics/angular/class/schema.json +++ b/packages/schematics/angular/class/schema.json @@ -3,10 +3,11 @@ "id": "SchematicsAngularClass", "title": "Angular Class Options Schema", "type": "object", + "description": "Creates a new generic class definition in the given or default project.", "properties": { "name": { "type": "string", - "description": "The name of the class.", + "description": "The name of the new class.", "$default": { "$source": "argv", "index": 0 @@ -16,7 +17,7 @@ "path": { "type": "string", "format": "path", - "description": "The path to create the class.", + "description": "The path at which to create the class, relative to the workspace root.", "visible": false }, "project": { @@ -28,12 +29,12 @@ }, "spec": { "type": "boolean", - "description": "Specifies if a spec file is generated.", + "description": "When true, generates a \"spec.ts\" test file for the new class.", "default": false }, "type": { "type": "string", - "description": "Specifies the type of class.", + "description": "Adds a developer-defined type to the filename, in the format \"name.type.ts\".", "default": "" } }, diff --git a/packages/schematics/angular/component/schema.json b/packages/schematics/angular/component/schema.json index a3401bbbd320..140b4313fe14 100644 --- a/packages/schematics/angular/component/schema.json +++ b/packages/schematics/angular/component/schema.json @@ -3,11 +3,12 @@ "id": "SchematicsAngularComponent", "title": "Angular Component Options Schema", "type": "object", + "description": "Creates a new generic component definition in the given or default project.", "properties": { "path": { "type": "string", "format": "path", - "description": "The path to create the component.", + "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.", "visible": false }, "project": { @@ -27,25 +28,25 @@ "x-prompt": "What name would you like to use for the component?" }, "inlineStyle": { - "description": "Specifies if the style will be in the ts file.", + "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.", "type": "boolean", "default": false, "alias": "s" }, "inlineTemplate": { - "description": "Specifies if the template will be in the ts file.", + "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.", "type": "boolean", "default": false, "alias": "t" }, "viewEncapsulation": { - "description": "Specifies the view encapsulation strategy.", + "description": "The view encapsulation strategy to use in the new component.", "enum": ["Emulated", "Native", "None", "ShadowDom"], "type": "string", "alias": "v" }, "changeDetection": { - "description": "Specifies the change detection strategy.", + "description": "The change detection strategy to use in the new component.", "enum": ["Default", "OnPush"], "type": "string", "default": "Default", @@ -53,7 +54,7 @@ }, "prefix": { "type": "string", - "description": "The prefix to apply to generated selectors.", + "description": "The prefix to apply to the generated component selector.", "alias": "p", "oneOf": [ { @@ -66,49 +67,49 @@ ] }, "styleext": { - "description": "The file extension to be used for style files.", + "description": "The file extension to use for style files.", "type": "string", "default": "css" }, "spec": { "type": "boolean", - "description": "Specifies if a spec file is generated.", + "description": "When true (the default), generates a \"spec.ts\" test file for the new component.", "default": true }, "flat": { "type": "boolean", - "description": "Flag to indicate if a directory is created.", + "description": "When true, creates the new files at the top level of the current project.", "default": false }, "skipImport": { "type": "boolean", - "description": "Flag to skip the module import.", + "description": "When true, does not import this component into the owning NgModule.", "default": false }, "selector": { "type": "string", "format": "html-selector", - "description": "The selector to use for the component." + "description": "The HTML selector to use for this component." }, "module": { "type": "string", - "description": "Allows specification of the declaring module.", + "description": "The declaring NgModule.", "alias": "m" }, "export": { "type": "boolean", "default": false, - "description": "Specifies if declaring module exports the component." + "description": "When true, the declaring NgModule exports this component." }, "entryComponent": { "type": "boolean", "default": false, - "description": "Specifies if the component is an entry component of declaring module." + "description": "When true, the new component is the entry component of the declaring NgModule." }, "lintFix": { "type": "boolean", "default": false, - "description": "Specifies whether to apply lint fixes after generating the component." + "description": "When true, applies lint fixes after generating the component." } }, "required": [ diff --git a/packages/schematics/angular/directive/schema.json b/packages/schematics/angular/directive/schema.json index 69aab44e5214..e6ace492e30b 100644 --- a/packages/schematics/angular/directive/schema.json +++ b/packages/schematics/angular/directive/schema.json @@ -3,10 +3,11 @@ "id": "SchematicsAngularDirective", "title": "Angular Directive Options Schema", "type": "object", + "description": "Creates a new generic directive definition in the given or default project.", "properties": { "name": { "type": "string", - "description": "The name of the directive.", + "description": "The name of the new directive.", "$default": { "$source": "argv", "index": 0 @@ -16,7 +17,7 @@ "path": { "type": "string", "format": "path", - "description": "The path to create the interface.", + "description": "The path at which to create the interface that defines the directive, relative to the workspace root.", "visible": false }, "project": { @@ -28,7 +29,7 @@ }, "prefix": { "type": "string", - "description": "The prefix to apply to generated selectors.", + "description": "A prefix to apply to generated selectors.", "alias": "p", "oneOf": [ { @@ -42,38 +43,38 @@ }, "spec": { "type": "boolean", - "description": "Specifies if a spec file is generated.", + "description": "When true (the default), generates a \"spec.ts\" test file for the new directive.", "default": true }, "skipImport": { "type": "boolean", - "description": "Flag to skip the module import.", + "description": "When true, does not import this directive into the owning NgModule.", "default": false }, "selector": { "type": "string", "format": "html-selector", - "description": "The selector to use for the directive." + "description": "The HTML selector to use for this directive." }, "flat": { "type": "boolean", - "description": "Flag to indicate if a directory is created.", + "description": "When true (the default), creates the new files at the top level of the current project.", "default": true }, "module": { "type": "string", - "description": "Allows specification of the declaring module.", + "description": "The declaring NgModule.", "alias": "m" }, "export": { "type": "boolean", "default": false, - "description": "Specifies if declaring module exports the directive." + "description": "When true, the declaring NgModule exports this directive." }, "lintFix": { "type": "boolean", "default": false, - "description": "Specifies whether to apply lint fixes after generating the directive." + "description": "When true, applies lint fixes after generating the directive." } }, "required": [ diff --git a/packages/schematics/angular/e2e/e2e-long.md b/packages/schematics/angular/e2e/e2e-long.md new file mode 100644 index 000000000000..ef1ba2e0b6c2 --- /dev/null +++ b/packages/schematics/angular/e2e/e2e-long.md @@ -0,0 +1 @@ +The e2e tests are created in a separate app, next to the project being tested in the `projects` folder of the workspace. \ No newline at end of file diff --git a/packages/schematics/angular/e2e/schema.json b/packages/schematics/angular/e2e/schema.json index db0988c72bd7..89201ad387e9 100644 --- a/packages/schematics/angular/e2e/schema.json +++ b/packages/schematics/angular/e2e/schema.json @@ -3,14 +3,16 @@ "id": "SchematicsAngularE2eApp", "title": "Angular e2e Application Options Schema", "type": "object", + "description": "Generates a new, generic end-to-end test definition for the given or default project.", + "long-description": "e2e-long.md", "properties": { "projectRoot": { - "description": "The root directory of the new application.", + "description": "The root folder for the new test app.", "type": "string", "visible": false }, "name": { - "description": "The name of the e2e application.", + "description": "The name of the new e2e app.", "type": "string", "format": "html-selector", "$default": { @@ -19,7 +21,7 @@ } }, "rootSelector": { - "description": "HTML selector for the root component.", + "description": "The HTML selector for the root component of the test app.", "type": "string", "default": "app-root" }, diff --git a/packages/schematics/angular/enum/schema.json b/packages/schematics/angular/enum/schema.json index 50f165a4748c..1399eacb6a04 100644 --- a/packages/schematics/angular/enum/schema.json +++ b/packages/schematics/angular/enum/schema.json @@ -3,6 +3,7 @@ "id": "SchematicsAngularEnum", "title": "Angular Enum Options Schema", "type": "object", + "description": "Generates a new, generic enum definition for the given or default project.", "properties": { "name": { "type": "string", @@ -16,12 +17,12 @@ "path": { "type": "string", "format": "path", - "description": "The path to create the enum.", + "description": "The path at which to create the enum definition, relative to the current workspace.", "visible": false }, "project": { "type": "string", - "description": "The name of the project.", + "description": "The name of the project in which to create the enum. Default is the configured default project for the workspace.", "$default": { "$source": "projectName" } @@ -29,7 +30,7 @@ "lintFix": { "type": "boolean", "default": false, - "description": "Specifies whether to apply lint fixes after generating the enum." + "description": "When true, applies lint fixes after generating the enum." } }, "required": [ diff --git a/packages/schematics/angular/guard/schema.json b/packages/schematics/angular/guard/schema.json index 0b08eaba2b99..c2a528deaa85 100644 --- a/packages/schematics/angular/guard/schema.json +++ b/packages/schematics/angular/guard/schema.json @@ -3,10 +3,11 @@ "id": "SchematicsAngularGuard", "title": "Angular Guard Options Schema", "type": "object", + "description": "Generates a new, generic route guard definition in the given or default project.", "properties": { "name": { "type": "string", - "description": "The name of the guard.", + "description": "The name of the new route guard.", "$default": { "$source": "argv", "index": 0 @@ -15,18 +16,18 @@ }, "spec": { "type": "boolean", - "description": "Specifies if a spec file is generated.", + "description": "When true (the default), generates a \"spec.ts\" test file for the new guard.", "default": true }, "flat": { "type": "boolean", - "description": "Flag to indicate if a directory is created.", + "description": "When true (the default), creates the new files at the top level of the current project.", "default": true }, "path": { "type": "string", "format": "path", - "description": "The path to create the interface.", + "description": "The path at which to create the interface that defines the guard, relative to the current workspace.", "visible": false }, "project": { @@ -39,7 +40,7 @@ "lintFix": { "type": "boolean", "default": false, - "description": "Specifies whether to apply lint fixes after generating the guard." + "description": "When true, applies lint fixes after generating the guard." } }, "required": [ diff --git a/packages/schematics/angular/interface/schema.json b/packages/schematics/angular/interface/schema.json index 63168a32b8c3..32bd0daaa21a 100644 --- a/packages/schematics/angular/interface/schema.json +++ b/packages/schematics/angular/interface/schema.json @@ -3,6 +3,7 @@ "id": "SchematicsAngularInterface", "title": "Angular Interface Options Schema", "type": "object", + "description": "Creates a new generic interface definition in the given or default project.", "properties": { "name": { "type": "string", @@ -16,7 +17,7 @@ "path": { "type": "string", "format": "path", - "description": "The path to create the interface.", + "description": "The path at which to create the interface, relative to the workspace root.", "visible": false }, "project": { @@ -29,11 +30,11 @@ "prefix": { "type": "string", "default": "", - "description": "Specifies the prefix to use." + "description": "A prefix to apply to generated selectors." }, "type": { "type": "string", - "description": "Specifies the type of interface.", + "description": "Adds a developer-defined type to the filename, in the format \"name.type.ts\".", "$default": { "$source": "argv", "index": 1 @@ -42,7 +43,7 @@ "lintFix": { "type": "boolean", "default": false, - "description": "Specifies whether to apply lint fixes after generating the directive." + "description": "When true, applies lint fixes after generating the interface." } }, "required": [ diff --git a/packages/schematics/angular/library/library-long.md b/packages/schematics/angular/library/library-long.md new file mode 100644 index 000000000000..bac674dca23e --- /dev/null +++ b/packages/schematics/angular/library/library-long.md @@ -0,0 +1,4 @@ +A library is a type of project that does not run independently. +The library skeleton created by this command is placed by default in the `/projects` folder, and has `type` of "library". + +You can build a new library using the `ng build` command, and unit-test it and lint it using the `ng test` and `ng lint` commands. \ No newline at end of file diff --git a/packages/schematics/angular/library/schema.json b/packages/schematics/angular/library/schema.json index 0ce8e9eac44b..3db99c2d029d 100644 --- a/packages/schematics/angular/library/schema.json +++ b/packages/schematics/angular/library/schema.json @@ -3,6 +3,8 @@ "id": "SchematicsLibrary", "title": "Library Options Schema", "type": "object", + "description": "Creates a new generic library project in the current workspace.", + "long-description": "./library-long.md", "properties": { "name": { "type": "string", @@ -16,30 +18,30 @@ "entryFile": { "type": "string", "format": "path", - "description": "The path to create the library's public API file.", + "description": "The path at which to create the library's public API file, relative to the workspace root.", "default": "public_api" }, "prefix": { "type": "string", "format": "html-selector", - "description": "The prefix to apply to generated selectors.", + "description": "A prefix to apply to generated selectors.", "default": "lib", "alias": "p" }, "skipPackageJson": { "type": "boolean", "default": false, - "description": "Do not add dependencies to package.json." + "description": "When true, does not add dependencies to the \"package.json\" file. " }, "skipInstall": { - "description": "Skip installing dependency packages.", + "description": "When true, does not install dependency packages.", "type": "boolean", "default": false }, "skipTsConfig": { "type": "boolean", "default": false, - "description": "Do not update tsconfig.json for development experience." + "description": "When true, does not update \"tsconfig.json\" to add a path mapping for the new library. The path mapping is needed to use the library in an app, but can be disabled here to simplify development." } }, "required": [] diff --git a/packages/schematics/angular/module/schema.json b/packages/schematics/angular/module/schema.json index a8ba886285fe..f58e8299786d 100644 --- a/packages/schematics/angular/module/schema.json +++ b/packages/schematics/angular/module/schema.json @@ -3,20 +3,21 @@ "id": "SchematicsAngularModule", "title": "Angular Module Options Schema", "type": "object", + "description": "Creates a new generic NgModule definition in the given or default project.", "properties": { "name": { "type": "string", - "description": "The name of the module.", + "description": "The name of the NgModule.", "$default": { "$source": "argv", "index": 0 }, - "x-prompt": "What name would you like to use for the module?" + "x-prompt": "What name would you like to use for the NgModule?" }, "path": { "type": "string", "format": "path", - "description": "The path to create the module.", + "description": "The path at which to create the NgModule, relative to the workspace root.", "visible": false }, "project": { @@ -28,29 +29,29 @@ }, "routing": { "type": "boolean", - "description": "Generates a routing module.", + "description": "When true, creates a routing module.", "default": false }, "routingScope": { "enum": ["Child", "Root"], "type": "string", - "description": "The scope for the generated routing.", + "description": "The scope for the new routing module.", "default": "Child" }, "flat": { "type": "boolean", - "description": "Flag to indicate if a directory is created.", + "description": "When true, creates the new files at the top level of the current project root. ", "default": false }, "commonModule": { "type": "boolean", - "description": "Flag to control whether the CommonModule is imported.", + "description": "When true, the new NgModule imports \"CommonModule\". ", "default": true, "visible": false }, "module": { "type": "string", - "description": "Allows specification of the declaring module.", + "description": "The declaring NgModule.", "alias": "m" } }, diff --git a/packages/schematics/angular/ng-new/schema.json b/packages/schematics/angular/ng-new/schema.json index e80bc82bc3de..45bd6da58565 100644 --- a/packages/schematics/angular/ng-new/schema.json +++ b/packages/schematics/angular/ng-new/schema.json @@ -9,39 +9,39 @@ "description": "The directory name to create the workspace in." }, "name": { - "description": "The name of the workspace.", + "description": "The name of the new workspace and initial project.", "type": "string", "format": "html-selector", "$default": { "$source": "argv", "index": 0 }, - "x-prompt": "What name would you like to use for the project?" + "x-prompt": "What name would you like to use for the new workspace and initial project?" }, "experimentalIvy": { - "description": "EXPERIMENTAL: Specifies whether to create a new application which uses the Ivy rendering engine.", + "description": "EXPERIMENTAL: When true, creates a new app that uses the Ivy rendering engine.", "type": "boolean", "default": false }, "skipInstall": { - "description": "Skip installing dependency packages.", + "description": "When true, does not install dependency packages.", "type": "boolean", "default": false }, "linkCli": { - "description": "Link CLI to global version (internal development only).", + "description": "When true, links CLI to global version (internal development only).", "type": "boolean", "default": false, "visible": false }, "skipGit": { - "description": "Skip initializing a git repository.", + "description": "When true, does not initialize a git repository.", "type": "boolean", "default": false, "alias": "g" }, "commit": { - "description": "Initial repository commit information.", + "description": "Initial git repository commit information.", "oneOf": [ { "type": "boolean" }, { @@ -67,24 +67,24 @@ "default": true }, "newProjectRoot": { - "description": "The path where new projects will be created.", + "description": "The path where new projects will be created, relative to the new workspace root.", "type": "string", "default": "projects" }, "inlineStyle": { - "description": "Specifies if the style will be in the ts file.", + "description": "When true, includes styles inline in the component TS file. By default, an external styles file is created and referenced in the component TS file.", "type": "boolean", "default": false, "alias": "s" }, "inlineTemplate": { - "description": "Specifies if the template will be in the ts file.", + "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.", "type": "boolean", "default": false, "alias": "t" }, "viewEncapsulation": { - "description": "Specifies the view encapsulation strategy.", + "description": "The view encapsulation strategy to use in the initial project.", "enum": ["Emulated", "Native", "None", "ShadowDom"], "type": "string" }, @@ -98,20 +98,20 @@ }, "routing": { "type": "boolean", - "description": "Generates a routing module.", + "description": "When true, generates a routing module for the initial project.", "default": false, "x-prompt": "Would you like to add Angular routing?" }, "prefix": { "type": "string", "format": "html-selector", - "description": "The prefix to apply to generated selectors.", + "description": "The prefix to apply to generated selectors for the initial project.", "minLength": 1, "default": "app", "alias": "p" }, "style": { - "description": "The file extension to be used for style files.", + "description": "The file extension to use for style files.", "type": "string", "default": "css", "x-prompt": { @@ -127,18 +127,18 @@ } }, "skipTests": { - "description": "Skip creating spec files.", + "description": "When true, does not generate \"spec.ts\" test files for the new project. ", "type": "boolean", "default": false, "alias": "S" }, "createApplication": { - "description": "Flag to toggle creation of an application in the new workspace.", + "description": "When true (the default), creates a new initial app project in the new workspace.", "type": "boolean", "default": true }, "minimal": { - "description": "Create a barebones project without any testing frameworks", + "description": "When true, creates a barebones project without any testing frameworks.", "type": "boolean", "default": false } diff --git a/packages/schematics/angular/pipe/schema.json b/packages/schematics/angular/pipe/schema.json index f9ed5ffbb9cf..eb77636b1f10 100644 --- a/packages/schematics/angular/pipe/schema.json +++ b/packages/schematics/angular/pipe/schema.json @@ -3,6 +3,7 @@ "id": "SchematicsAngularPipe", "title": "Angular Pipe Options Schema", "type": "object", + "description": "Creates a new generic pipe definition in the given or default project.", "properties": { "name": { "type": "string", @@ -16,7 +17,7 @@ "path": { "type": "string", "format": "path", - "description": "The path to create the pipe.", + "description": "The path at which to create the pipe, relative to the workspace root.", "visible": false }, "project": { @@ -29,32 +30,32 @@ "flat": { "type": "boolean", "default": true, - "description": "Flag to indicate if a directory is created." + "description": "When true (the default) creates files at the top level of the project." }, "spec": { "type": "boolean", "default": true, - "description": "Specifies if a spec file is generated." + "description": "When true (the default), generates a \"spec.ts\" test file for the new pipe." }, "skipImport": { "type": "boolean", "default": false, - "description": "Allows for skipping the module import." + "description": "When true, does not import this pipe into the owning NgModule." }, "module": { "type": "string", - "description": "Allows specification of the declaring module.", + "description": "The declaring NgModule.", "alias": "m" }, "export": { "type": "boolean", "default": false, - "description": "Specifies if declaring module exports the pipe." + "description": "When true, the declaring NgModule exports this pipe." }, "lintFix": { "type": "boolean", "default": false, - "description": "Specifies whether to apply lint fixes after generating the pipe." + "description": "When true, applies lint fixes after generating the pipe." } }, "required": [ diff --git a/packages/schematics/angular/service-worker/schema.json b/packages/schematics/angular/service-worker/schema.json index 938d906ed973..56312e7e4c4e 100644 --- a/packages/schematics/angular/service-worker/schema.json +++ b/packages/schematics/angular/service-worker/schema.json @@ -3,6 +3,7 @@ "id": "SchematicsAngularServiceWorker", "title": "Angular Service Worker Options Schema", "type": "object", + "description": "Pass this schematic to the \"run\" command to create a service worker", "properties": { "project": { "type": "string", diff --git a/packages/schematics/angular/service/schema.json b/packages/schematics/angular/service/schema.json index eeffbfe6e578..67f6b89610fa 100644 --- a/packages/schematics/angular/service/schema.json +++ b/packages/schematics/angular/service/schema.json @@ -3,6 +3,7 @@ "id": "SchematicsAngularService", "title": "Angular Service Options Schema", "type": "object", + "description": "Creates a new, generic service definition in the given or default project.", "properties": { "name": { "type": "string", @@ -16,7 +17,7 @@ "path": { "type": "string", "format": "path", - "description": "The path to create the service.", + "description": "The path at which to create the service, relative to the workspace root.", "visible": false }, "project": { @@ -29,17 +30,17 @@ "flat": { "type": "boolean", "default": true, - "description": "Flag to indicate if a directory is created." + "description": "When true (the default) creates files at the top level of the project." }, "spec": { "type": "boolean", "default": true, - "description": "Specifies if a spec file is generated." + "description": "When true (the default), generates a \"spec.ts\" test file for the new service." }, "lintFix": { "type": "boolean", "default": false, - "description": "Specifies whether to apply lint fixes after generating the pipe." + "description": "When true, applies lint fixes after generating the pipe." } }, "required": [ diff --git a/packages/schematics/angular/universal/schema.json b/packages/schematics/angular/universal/schema.json index ee2bda67bef3..da5b760b9896 100644 --- a/packages/schematics/angular/universal/schema.json +++ b/packages/schematics/angular/universal/schema.json @@ -3,15 +3,16 @@ "id": "SchematicsAngularUniversalApp", "title": "Angular Universal App Options Schema", "type": "object", + "description": "Pass this schematic to the \"run\" command to set up server-side rendering for an app.", "properties": { "clientProject": { "type": "string", - "description": "Name of related client app." + "description": "The name of the related client app. Required in place of \"project\"." }, "appId": { "type": "string", "format": "html-selector", - "description": "The appId to use withServerTransition.", + "description": "The app identifier to use for transition.", "default": "serverApp" }, "main": { @@ -39,22 +40,22 @@ "appDir": { "type": "string", "format": "path", - "description": "The name of the application directory.", + "description": "The name of the application folder.", "default": "app" }, "rootModuleFileName": { "type": "string", "format": "path", - "description": "The name of the root module file", + "description": "The name of the root NgModule file.", "default": "app.server.module.ts" }, "rootModuleClassName": { "type": "string", - "description": "The name of the root module class.", + "description": "The name of the root NgModule class.", "default": "AppServerModule" }, "skipInstall": { - "description": "Skip installing dependency packages.", + "description": "When true, does not install packages for dependencies.", "type": "boolean", "default": false } diff --git a/packages/schematics/angular/workspace/schema.json b/packages/schematics/angular/workspace/schema.json index 9268d1b64006..fa016e97b2aa 100644 --- a/packages/schematics/angular/workspace/schema.json +++ b/packages/schematics/angular/workspace/schema.json @@ -14,7 +14,7 @@ } }, "experimentalAngularNext": { - "description": "Use the next version of Angular (@next dist-tag).", + "description": "True to use the next version of Angular (@next dist-tag).", "type": "boolean", "visible": "false" }, @@ -24,18 +24,18 @@ "visible": "false" }, "skipInstall": { - "description": "Skip installing dependency packages.", + "description": "When true, does not install packages for dependencies.", "type": "boolean", "default": false }, "linkCli": { - "description": "Link CLI to global version (internal development only).", + "description": "When true, link CLI to global version (internal development only).", "type": "boolean", "default": false, "visible": false }, "skipGit": { - "description": "Skip initializing a git repository.", + "description": "When true, do not initialize a git repository.", "type": "boolean", "default": false, "alias": "g" @@ -75,7 +75,7 @@ } }, "minimal": { - "description": "Create a barebones project without any testing frameworks", + "description": "When true, creates a bare-bones project without any testing frameworks", "type": "boolean", "default": false }