fixup! docs: add generation schematics option docs

Author: jbogarthyde

packages/schematics/angular/class/schema.json

@@ -17,7 +17,7 @@
     "path": {
       "type": "string",
       "format": "path",
-      "description": "The path at which to create the class, relative to the current workspace. Default is the top level of the current working directory.",
+      "description": "The path at which to create the class, relative to the workspace root.",
       "visible": false
     },
     "project": {

packages/schematics/angular/component/schema.json

@@ -28,13 +28,13 @@
       "x-prompt": "What name would you like to use for the component?"
     },
     "inlineStyle": {
-      "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.",
+      "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": "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.",
+      "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"
@@ -83,7 +83,7 @@
     },
     "skipImport": {
       "type": "boolean",
-      "description": "When true, does not import this directive into the owning NgModule.",
+      "description": "When true, does not import this component into the owning NgModule.",
       "default": false
     },
     "selector": {

packages/schematics/angular/directive/schema.json

@@ -3,6 +3,7 @@
   "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",
@@ -16,7 +17,7 @@
     "path": {
       "type": "string",
       "format": "path",
-      "description": "The path at which to create the interface that defines the directive, relative to the current workspace.",
+      "description": "The path at which to create the interface that defines the directive, relative to the workspace root.",
       "visible": false
     },
     "project": {

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": [

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.

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": []

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"
     }
   },

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
     }

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": [

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",