feat(@schematics/angular): consistent naming of options and arguments…

… that do the same thing This aligns options that do the same thing: 1) `skipSpecs` and `spec` has been deprecated in favor of `skipTests`. 2) `styleext` has been deprecated in favor of `style` since the latest is two words. Fixes #12784
angular · Dec 11, 2018 · a12a4e0 · a12a4e0
1 parent 1cdeccf
commit a12a4e0
Show file tree

Hide file tree

Showing 23 changed files with 158 additions and 53 deletions.
diff --git a/packages/angular/cli/lib/config/schema.json b/packages/angular/cli/lib/config/schema.json
@@ -139,6 +139,11 @@
               "type": "string",
               "default": "css"
             },
+            "style": {
+              "description": "The file extension to use for style files.",
+              "type": "string",
+              "default": "css"
+            },
             "viewEncapsulation": {
               "description": "Specifies the view encapsulation strategy.",
               "enum": ["Emulated", "Native", "None", "ShadowDom"],
@@ -186,6 +191,11 @@
               "type": "boolean",
               "description": "Specifies if a spec file is generated.",
               "default": true
+            },
+            "skipTests": {
+              "type": "boolean",
+              "description": "When true, does not create test files.",
+              "default": false
             }
           }
         },
@@ -203,11 +213,6 @@
               "description": "The scope for the generated routing.",
               "default": "Child"
             },
-            "spec": {
-              "type": "boolean",
-              "description": "Specifies if a spec file is generated.",
-              "default": true
-            },
             "flat": {
               "type": "boolean",
               "description": "Flag to indicate if a directory is created.",
@@ -236,8 +241,13 @@
             },
             "spec": {
               "type": "boolean",
-              "default": true,
-              "description": "Specifies if a spec file is generated."
+              "description": "Specifies if a spec file is generated.",
+              "default": true
+            },
+            "skipTests": {
+              "type": "boolean",
+              "description": "When true, does not create test files.",
+              "default": false
             }
           }
         },
@@ -251,8 +261,13 @@
             },
             "spec": {
               "type": "boolean",
-              "default": true,
-              "description": "Specifies if a spec file is generated."
+              "description": "Specifies if a spec file is generated.",
+              "default": true
+            },
+            "skipTests": {
+              "type": "boolean",
+              "description": "When true, does not create test files.",
+              "default": false
             },
             "skipImport": {
               "type": "boolean",
@@ -277,8 +292,13 @@
           "properties": {
             "spec": {
               "type": "boolean",
-              "default": true,
-              "description": "Specifies if a spec file is generated."
+              "description": "Specifies if a spec file is generated.",
+              "default": true
+            },
+            "skipTests": {
+              "type": "boolean",
+              "description": "When true, does not create test files.",
+              "default": false
             }
           }
         }

diff --git a/packages/schematics/angular/application/index.ts b/packages/schematics/angular/application/index.ts
@@ -136,7 +136,7 @@ function addAppToWorkspaceFile(options: ApplicationOptions, workspace: Workspace
       if (!(`@schematics/angular:${type}` in schematics)) {
         schematics[`@schematics/angular:${type}`] = {};
       }
-      (schematics[`@schematics/angular:${type}`] as JsonObject).spec = false;
+      (schematics[`@schematics/angular:${type}`] as JsonObject).skipTests = true;
     });
   }
 
@@ -264,15 +264,15 @@ export default function (options: ApplicationOptions): Rule {
       {
         inlineStyle: options.inlineStyle,
         inlineTemplate: options.inlineTemplate,
-        spec: !options.skipTests,
-        styleext: options.style,
+        skipTests: options.skipTests,
+        style: options.style,
         viewEncapsulation: options.viewEncapsulation,
       } :
       {
         inlineStyle: true,
         inlineTemplate: true,
-        spec: false,
-        styleext: options.style,
+        skipTests: true,
+        style: options.style,
       };
 
     const workspace = getWorkspace(host);
@@ -361,7 +361,7 @@ export default function (options: ApplicationOptions): Rule {
       mergeWith(
         apply(url('./other-files'), [
           componentOptions.inlineTemplate ? filter(path => !path.endsWith('.html')) : noop(),
-          !componentOptions.spec ? filter(path => !path.endsWith('.spec.ts')) : noop(),
+          componentOptions.skipTests ? filter(path => !/[.|-]spec.ts$/.test(path)) : noop(),
           template({
             utils: strings,
             ...options as any,  // tslint:disable-line:no-any

diff --git a/packages/schematics/angular/application/index_spec.ts b/packages/schematics/angular/application/index_spec.ts
@@ -29,8 +29,6 @@ describe('Application Schematic', () => {
     inlineStyle: false,
     inlineTemplate: false,
     routing: false,
-    style: 'css',
-    skipTests: false,
     skipPackageJson: false,
   };
 

diff --git a/packages/schematics/angular/application/other-files/app.component.ts b/packages/schematics/angular/application/other-files/app.component.ts
@@ -28,7 +28,7 @@ import { Component } from '@angular/core';
   `,<% } else { %>
   templateUrl: './app.component.html',<% } if(inlineStyle) { %>
   styles: []<% } else { %>
-  styleUrls: ['./app.component.<%= styleext %>']<% } %>
+  styleUrls: ['./app.component.<%= style %>']<% } %>
 })
 export class AppComponent {
   title = '<%= name %>';

diff --git a/packages/schematics/angular/class/index.ts b/packages/schematics/angular/class/index.ts
@@ -42,8 +42,11 @@ export default function (options: ClassOptions): Rule {
     options.name = parsedPath.name;
     options.path = parsedPath.path;
 
+    // todo remove these when we remove the deprecations
+    options.skipTests = options.skipTests || !options.spec;
+
     const templateSource = apply(url('./files'), [
-      options.spec ? noop() : filter(path => !path.endsWith('.spec.ts')),
+      options.skipTests ? filter(path => !path.endsWith('.spec.ts')) : noop(),
       template({
         ...strings,
         ...options,

diff --git a/packages/schematics/angular/class/schema.json b/packages/schematics/angular/class/schema.json
@@ -29,7 +29,13 @@
     },
     "spec": {
       "type": "boolean",
-      "description": "When true, generates a \"spec.ts\" test file for the new class.",
+      "description": "When true (the default), generates a  \"spec.ts\" test file for the new class.",
+      "default": true,
+      "x-deprecated": "Use \"skipTests\" instead."
+    },
+    "skipTests": {
+      "type": "boolean",
+      "description": "When true, does not create \"spec.ts\" test files for the new class.",
       "default": false
     },
     "type": {

diff --git a/...__name@dasherize__.component.__styleext__ → ...__/__name@dasherize__.component.__style__ b/...__name@dasherize__.component.__styleext__ → ...__/__name@dasherize__.component.__style__
diff --git a/...matics/angular/component/files/__name@dasherize@if-flat__/__name@dasherize__.component.ts b/...matics/angular/component/files/__name@dasherize@if-flat__/__name@dasherize__.component.ts
@@ -9,7 +9,7 @@ import { Component, OnInit<% if(!!viewEncapsulation) { %>, ViewEncapsulation<% }
   `,<% } else { %>
   templateUrl: './<%= dasherize(name) %>.component.html',<% } if(inlineStyle) { %>
   styles: []<% } else { %>
-  styleUrls: ['./<%= dasherize(name) %>.component.<%= styleext %>']<% } %><% if(!!viewEncapsulation) { %>,
+  styleUrls: ['./<%= dasherize(name) %>.component.<%= style %>']<% } %><% if(!!viewEncapsulation) { %>,
   encapsulation: ViewEncapsulation.<%= viewEncapsulation %><% } if (changeDetection !== 'Default') { %>,
   changeDetection: ChangeDetectionStrategy.<%= changeDetection %><% } %>
 })

diff --git a/packages/schematics/angular/component/index.ts b/packages/schematics/angular/component/index.ts
@@ -125,7 +125,7 @@ function buildSelector(options: ComponentOptions, projectPrefix: string) {
 }
 
 
-export default function(options: ComponentOptions): Rule {
+export default function (options: ComponentOptions): Rule {
   return (host: Tree) => {
     if (!options.project) {
       throw new SchematicsException('Option (project) is required.');
@@ -143,12 +143,19 @@ export default function(options: ComponentOptions): Rule {
     options.path = parsedPath.path;
     options.selector = options.selector || buildSelector(options, project.prefix);
 
+    // todo remove these when we remove the deprecations
+    options.style = (
+      options.style && options.style !== 'css'
+        ? options.style : options.styleext
+    ) || 'css';
+    options.skipTests = options.skipTests || !options.spec;
+
     validateName(options.name);
     validateHtmlSelector(options.selector);
 
     const templateSource = apply(url('./files'), [
-      options.spec ? noop() : filter(path => !path.endsWith('.spec.ts')),
-      options.inlineStyle ? filter(path => !path.endsWith('.__styleext__')) : noop(),
+      options.skipTests ? filter(path => !path.endsWith('.spec.ts')) : noop(),
+      options.inlineStyle ? filter(path => !path.endsWith('.__style__')) : noop(),
       options.inlineTemplate ? filter(path => !path.endsWith('.html')) : noop(),
       template({
         ...strings,

diff --git a/packages/schematics/angular/component/index_spec.ts b/packages/schematics/angular/component/index_spec.ts
@@ -24,8 +24,8 @@ describe('Component Schematic', () => {
     inlineStyle: false,
     inlineTemplate: false,
     changeDetection: ChangeDetection.Default,
-    styleext: 'css',
-    spec: true,
+    style: 'css',
+    skipTests: false,
     module: undefined,
     export: false,
     project: 'bar',
@@ -249,8 +249,8 @@ describe('Component Schematic', () => {
     expect(tree.files).not.toContain('/projects/bar/src/app/foo/foo.component.css');
   });
 
-  it('should respect the styleext option', () => {
-    const options = { ...defaultOptions, styleext: 'scss' };
+  it('should respect the style option', () => {
+    const options = { ...defaultOptions, style: 'scss' };
     const tree = schematicRunner.runSchematic('component', options, appTree);
     const content = tree.readContent('/projects/bar/src/app/foo/foo.component.ts');
     expect(content).toMatch(/styleUrls: \['.\/foo.component.scss/);
@@ -310,4 +310,34 @@ describe('Component Schematic', () => {
     appTree = schematicRunner.runSchematic('component', defaultOptions, appTree);
     expect(appTree.files).toContain('/projects/bar/custom/app/foo/foo.component.ts');
   });
+
+  // testing deprecating options don't cause conflicts
+  it('should respect the deprecated styleext (scss) option', () => {
+    const options = { ...defaultOptions, style: undefined, styleext: 'scss' };
+    const tree = schematicRunner.runSchematic('component', options, appTree);
+    const files = tree.files;
+    expect(files).toContain('/projects/bar/src/app/foo/foo.component.scss');
+  });
+
+  it('should respect the deprecated styleext (css) option', () => {
+    const options = { ...defaultOptions, style: undefined, styleext: 'css' };
+    const tree = schematicRunner.runSchematic('component', options, appTree);
+    const files = tree.files;
+    expect(files).toContain('/projects/bar/src/app/foo/foo.component.css');
+  });
+
+  it('should respect the deprecated spec option when false', () => {
+    const options = { ...defaultOptions, skipTests: undefined, spec: false };
+    const tree = schematicRunner.runSchematic('component', options, appTree);
+    const files = tree.files;
+    expect(files).not.toContain('/projects/bar/src/app/foo/foo.component.spec.ts');
+  });
+
+  it('should respect the deprecated spec option when true', () => {
+    const options = { ...defaultOptions, skipTests: false, spec: true };
+    const tree = schematicRunner.runSchematic('component', options, appTree);
+    const files = tree.files;
+    expect(files).toContain('/projects/bar/src/app/foo/foo.component.spec.ts');
+  });
+
 });
diff --git a/packages/schematics/angular/component/schema.json b/packages/schematics/angular/component/schema.json
@@ -67,14 +67,26 @@
       ]
     },
     "styleext": {
+      "description": "The file extension to use for style files.",
+      "type": "string",
+      "default": "css",
+      "x-deprecated": "Use \"style\" instead."
+    },
+    "style": {
       "description": "The file extension to use for style files.",
       "type": "string",
       "default": "css"
     },
     "spec": {
       "type": "boolean",
       "description": "When true (the default), generates a  \"spec.ts\" test file for the new component.",
-      "default": true
+      "default": true,
+      "x-deprecated": "Use \"skipTests\" instead."
+    },
+    "skipTests": {
+      "type": "boolean",
+      "description": "When true, does not create \"spec.ts\" test files for the new component.",
+      "default": false
     },
     "flat": {
       "type": "boolean",

diff --git a/packages/schematics/angular/directive/index.ts b/packages/schematics/angular/directive/index.ts
@@ -121,8 +121,11 @@ export default function (options: DirectiveOptions): Rule {
 
     validateHtmlSelector(options.selector);
 
+    // todo remove these when we remove the deprecations
+    options.skipTests = options.skipTests || !options.spec;
+
     const templateSource = apply(url('./files'), [
-      options.spec ? noop() : filter(path => !path.endsWith('.spec.ts')),
+      options.skipTests ? filter(path => !path.endsWith('.spec.ts')) : noop(),
       template({
         ...strings,
         'if-flat': (s: string) => options.flat ? '' : s,

diff --git a/packages/schematics/angular/directive/index_spec.ts b/packages/schematics/angular/directive/index_spec.ts
@@ -18,7 +18,6 @@ describe('Directive Schematic', () => {
   );
   const defaultOptions: DirectiveOptions = {
     name: 'foo',
-    spec: true,
     module: undefined,
     export: false,
     prefix: 'app',
@@ -37,7 +36,6 @@ describe('Directive Schematic', () => {
     inlineStyle: false,
     inlineTemplate: false,
     routing: false,
-    style: 'css',
     skipTests: false,
     skipPackageJson: false,
   };

diff --git a/packages/schematics/angular/directive/schema.json b/packages/schematics/angular/directive/schema.json
@@ -44,7 +44,13 @@
     "spec": {
       "type": "boolean",
       "description": "When true (the default), generates a  \"spec.ts\" test file for the new directive.",
-      "default": true
+      "default": true,
+      "x-deprecated": "Use \"skipTests\" instead."
+    },
+    "skipTests": {
+      "type": "boolean",
+      "description": "When true, does not create \"spec.ts\" test files for the new class.",
+      "default": false
     },
     "skipImport": {
       "type": "boolean",
@@ -61,7 +67,7 @@
       "description": "When true (the default), creates the new files at the top level of the current project.",
       "default": true
     },
-    "module":  {
+    "module": {
       "type": "string",
       "description": "The declaring NgModule.",
       "alias": "m"
@@ -80,4 +86,4 @@
   "required": [
     "name"
   ]
-}
+}
diff --git a/packages/schematics/angular/guard/index.ts b/packages/schematics/angular/guard/index.ts
@@ -41,8 +41,11 @@ export default function (options: GuardOptions): Rule {
     options.name = parsedPath.name;
     options.path = parsedPath.path;
 
+    // todo remove these when we remove the deprecations
+    options.skipTests = options.skipTests || !options.spec;
+
     const templateSource = apply(url('./files'), [
-      options.spec ? noop() : filter(path => !path.endsWith('.spec.ts')),
+      options.skipTests ? filter(path => !path.endsWith('.spec.ts')) : noop(),
       template({
         ...strings,
         ...options,

diff --git a/packages/schematics/angular/guard/index_spec.ts b/packages/schematics/angular/guard/index_spec.ts
@@ -18,7 +18,6 @@ describe('Guard Schematic', () => {
   );
   const defaultOptions: GuardOptions = {
     name: 'foo',
-    spec: true,
     flat: true,
     project: 'bar',
   };
@@ -33,7 +32,6 @@ describe('Guard Schematic', () => {
     inlineStyle: false,
     inlineTemplate: false,
     routing: false,
-    style: 'css',
     skipTests: false,
     skipPackageJson: false,
   };
@@ -50,8 +48,8 @@ describe('Guard Schematic', () => {
     expect(files).toContain('/projects/bar/src/app/foo.guard.ts');
   });
 
-  it('should respect the spec flag', () => {
-    const options = { ...defaultOptions, spec: false };
+  it('should respect the skipTests flag', () => {
+    const options = { ...defaultOptions, skipTests: true };
 
     const tree = schematicRunner.runSchematic('guard', options, appTree);
     const files = tree.files;