feat(@schematics/angular): reallow --lint-fix for Angular schematics

Author: hansl

packages/schematics/angular/component/index.ts

@@ -29,6 +29,7 @@ import {
 import { InsertChange } from '../utility/change';
 import { getWorkspace } from '../utility/config';
 import { buildRelativePath, findModuleFromOptions } from '../utility/find-module';
+import { applyLintFix } from '../utility/lint-fix';
 import { parseName } from '../utility/parse-name';
 import { buildDefaultPath } from '../utility/project';
 import { validateHtmlSelector, validateName } from '../utility/validation';
@@ -164,6 +165,7 @@ export default function(options: ComponentOptions): Rule {
         addDeclarationToNgModule(options),
         mergeWith(templateSource),
       ])),
+      options.lintFix ? applyLintFix(options.path) : noop(),
     ]);
   };
 }

packages/schematics/angular/component/schema.d.ts

@@ -71,4 +71,8 @@ export interface Schema {
    * Specifies if the component is an entry component of declaring module.
    */
     entryComponent?: boolean;
+    /**
+     * Specifies whether to apply lint fixes after generating the component.
+     */
+    lintFix?: boolean;
 }

packages/schematics/angular/component/schema.json

@@ -103,6 +103,11 @@
       "type": "boolean",
       "default": false,
       "description": "Specifies if the component is an entry component of declaring module."
+    },
+    "lintFix": {
+      "type": "boolean",
+      "default": false,
+      "description": "Specifies whether to apply lint fixes after generating the component."
     }
   },
   "required": [],

packages/schematics/angular/directive/index.ts

@@ -29,6 +29,7 @@ import { parseName } from '../utility/parse-name';
 import { buildDefaultPath } from '../utility/project';
 import { validateHtmlSelector } from '../utility/validation';
 import { Schema as DirectiveOptions } from './schema';
+import {applyLintFix} from "../utility/lint-fix";
 
 
 function addDeclarationToNgModule(options: DirectiveOptions): Rule {
@@ -137,6 +138,7 @@ export default function (options: DirectiveOptions): Rule {
         addDeclarationToNgModule(options),
         mergeWith(templateSource),
       ])),
+      options.lintFix ? applyLintFix(options.path) : noop(),
     ]);
   };
 }

packages/schematics/angular/directive/schema.d.ts

@@ -47,4 +47,8 @@ export interface Schema {
      * Specifies if declaring module exports the directive.
      */
     export?: boolean;
+    /**
+     * Specifies whether to apply lint fixes after generating the component.
+     */
+    lintFix?: boolean;
 }

packages/schematics/angular/directive/schema.json

@@ -68,6 +68,11 @@
       "type": "boolean",
       "default": false,
       "description": "Specifies if declaring module exports the directive."
+    },
+    "lintFix": {
+      "type": "boolean",
+      "default": false,
+      "description": "Specifies whether to apply lint fixes after generating the directive."
     }
   },
   "required": [],

packages/schematics/angular/guard/index.ts

@@ -24,6 +24,7 @@ import { getWorkspace } from '../utility/config';
 import { parseName } from '../utility/parse-name';
 import { buildDefaultPath } from '../utility/project';
 import { Schema as GuardOptions } from './schema';
+import {applyLintFix} from "../utility/lint-fix";
 
 
 export default function (options: GuardOptions): Rule {
@@ -55,6 +56,7 @@ export default function (options: GuardOptions): Rule {
       branchAndMerge(chain([
         mergeWith(templateSource),
       ])),
+      options.lintFix ? applyLintFix(options.path) : noop(),
     ]);
   };
 }

packages/schematics/angular/guard/schema.d.ts

@@ -27,4 +27,8 @@ export interface Schema {
      * The name of the project.
      */
     project?: string;
+    /**
+     * Specifies whether to apply lint fixes after generating the component.
+     */
+    lintFix?: boolean;
 }

packages/schematics/angular/guard/schema.json

@@ -34,6 +34,11 @@
       "$default": {
         "$source": "projectName"
       }
+    },
+    "lintFix": {
+      "type": "boolean",
+      "default": false,
+      "description": "Specifies whether to apply lint fixes after generating the guard."
     }
   },
   "required": [],

packages/schematics/angular/interface/index.ts

@@ -15,10 +15,12 @@ import {
   chain,
   mergeWith,
   move,
+  noop,
   template,
   url,
 } from '@angular-devkit/schematics';
 import { getWorkspace } from '../utility/config';
+import { applyLintFix } from '../utility/lint-fix';
 import { parseName } from '../utility/parse-name';
 import { buildDefaultPath } from '../utility/project';
 import { Schema as InterfaceOptions } from './schema';
@@ -55,6 +57,7 @@ export default function (options: InterfaceOptions): Rule {
       branchAndMerge(chain([
         mergeWith(templateSource),
       ])),
+      options.lintFix ? applyLintFix(options.path) : noop(),
     ]);
   };
 }

packages/schematics/angular/interface/schema.d.ts

@@ -27,4 +27,8 @@ export interface Schema {
      * Specifies the type of interface.
      */
     type?: string;
+    /**
+     * Specifies whether to apply lint fixes after generating the component.
+     */
+    lintFix?: boolean;
 }

packages/schematics/angular/interface/schema.json

@@ -37,6 +37,11 @@
         "$source": "argv",
         "index": 1
       }
+    },
+    "lintFix": {
+      "type": "boolean",
+      "default": false,
+      "description": "Specifies whether to apply lint fixes after generating the directive."
     }
   },
   "required": [],

packages/schematics/angular/pipe/index.ts

@@ -25,6 +25,7 @@ import { addDeclarationToModule, addExportToModule } from '../utility/ast-utils'
 import { InsertChange } from '../utility/change';
 import { getWorkspace } from '../utility/config';
 import { buildRelativePath, findModuleFromOptions } from '../utility/find-module';
+import { applyLintFix } from '../utility/lint-fix';
 import { parseName } from '../utility/parse-name';
 import { buildDefaultPath } from '../utility/project';
 import { Schema as PipeOptions } from './schema';
@@ -117,6 +118,7 @@ export default function (options: PipeOptions): Rule {
       chain([
         addDeclarationToNgModule(options),
         mergeWith(templateSource),
+        options.lintFix ? applyLintFix(options.path) : noop(),
       ]),
     );
   };

packages/schematics/angular/pipe/schema.d.ts

@@ -39,4 +39,8 @@ export interface Schema {
      * Specifies if declaring module exports the pipe.
      */
     export?: boolean;
+    /**
+     * Specifies whether to apply lint fixes after generating the component.
+     */
+    lintFix?: boolean;
 }

packages/schematics/angular/pipe/schema.json

@@ -50,6 +50,11 @@
       "type": "boolean",
       "default": false,
       "description": "Specifies if declaring module exports the pipe."
+    },
+    "lintFix": {
+      "type": "boolean",
+      "default": false,
+      "description": "Specifies whether to apply lint fixes after generating the pipe."
     }
   },
   "required": [],

packages/schematics/angular/service/index.ts

@@ -11,6 +11,7 @@ import {
   SchematicsException,
   Tree,
   apply,
+  chain,
   filter,
   mergeWith,
   move,
@@ -19,6 +20,7 @@ import {
   url,
 } from '@angular-devkit/schematics';
 import { getWorkspace } from '../utility/config';
+import { applyLintFix } from '../utility/lint-fix';
 import { parseName } from '../utility/parse-name';
 import { buildDefaultPath } from '../utility/project';
 import { Schema as ServiceOptions } from './schema';
@@ -49,6 +51,9 @@ export default function (options: ServiceOptions): Rule {
       move(parsedPath.path),
     ]);
 
-    return mergeWith(templateSource);
+    return chain([
+      mergeWith(templateSource),
+      options.lintFix ? applyLintFix(options.path) : noop(),
+    ]);
   };
 }

packages/schematics/angular/service/schema.d.ts

@@ -27,4 +27,8 @@ export interface Schema {
      * Specifies if a spec file is generated.
      */
     spec?: boolean;
+    /**
+     * Specifies whether to apply lint fixes after generating the component.
+     */
+    lintFix?: boolean;
 }

packages/schematics/angular/service/schema.json

@@ -34,6 +34,11 @@
       "type": "boolean",
       "default": true,
       "description": "Specifies if a spec file is generated."
+    },
+    "lintFix": {
+      "type": "boolean",
+      "default": false,
+      "description": "Specifies whether to apply lint fixes after generating the pipe."
     }
   },
   "required": [],

packages/schematics/angular/utility/lint-fix.ts

@@ -0,0 +1,44 @@
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+import { DirEntry, Rule, SchematicContext, SchematicsException, Tree } from '@angular-devkit/schematics';
+import { TslintFixTask } from '@angular-devkit/schematics/tasks';
+
+export function applyLintFix(path = '/'): Rule {
+  return (tree: Tree, context: SchematicContext) => {
+    // Find the closest tsling.json
+    let dir: DirEntry | null = tree.getDir(path.substr(0, path.lastIndexOf('/')));
+
+    do {
+      if ((dir.subfiles as string[]).includes('tslint.json')) {
+        break;
+      }
+
+      dir = dir.parent;
+    } while (dir !== null);
+
+    if (dir === null) {
+      throw new SchematicsException('Asked to run lint fixes, but could not find a tslint.json.');
+    }
+
+    // Only include files that have been touched.
+    const files = tree.actions.reduce((acc: Set<string>, action) => {
+      const path = action.path.substr(1);  // Remove the starting '/'.
+      if (path.endsWith('.ts') && dir && action.path.startsWith(dir.path)) {
+        acc.add(path);
+      }
+
+      return acc;
+    }, new Set<string>());
+
+    context.addTask(new TslintFixTask('tslint.json', {
+      ignoreErrors: true,
+      tsConfigPath: 'tsconfig.json',
+      files: [...files],
+    }));
+  };
+}

tests/legacy-cli/e2e/tests/generate/lint-fix.ts

@@ -14,13 +14,10 @@ export default function () {
     }
   }`;
 
-  // TODO(architect): reenable after figuring out what happens to --lint-fix.
-  return;
-
   return Promise.resolve()
 
     // setup a double-quote tslint config
-    .then(() => writeFile('src/app/tslint.json', nestedConfigContent))
+    .then(() => writeFile('tslint.json', nestedConfigContent))
 
     // Generate a fixed new component but don't fix rest of app
     .then(() => ng('generate', 'component', 'test-component1', '--lint-fix'))
@@ -32,10 +29,13 @@ export default function () {
     .then(() => ng('lint'))
 
     // Enable default option and generate all other module related blueprints
-    .then(() => ng('config', 'defaults.lintFix', 'true'))
+    .then(() => ng('config', 'schematics.@schematics/angular.directive.lintFix', 'true'))
+    .then(() => ng('config', 'schematics.@schematics/angular.service.lintFix', 'true'))
+    .then(() => ng('config', 'schematics.@schematics/angular.pipe.lintFix', 'true'))
+    .then(() => ng('config', 'schematics.@schematics/angular.guard.lintFix', 'true'))
     .then(() => ng('generate', 'directive', 'test-directive'))
     .then(() => ng('generate', 'service', 'test-service'))
     .then(() => ng('generate', 'pipe', 'test-pipe'))
-    .then(() => ng('generate', 'guard', 'test-guard', '--module', 'app.module.ts'))
+    .then(() => ng('generate', 'guard', 'test-guard'))
     .then(() => ng('lint'));
 }