test(@angular-devkit/schematics): add an example and test for custom tslint rules

hansl · hansl · commit 7883af4aa1b5 · 2018-06-05T17:55:17.000-07:00
Material and RxJS were asking for those. This Spec is used as an example until
we get proper documentation.
diff --git a/packages/angular_devkit/schematics/tasks/tslint-fix/executor_spec.ts b/packages/angular_devkit/schematics/tasks/tslint-fix/executor_spec.ts
@@ -70,4 +70,65 @@ describe('TsLintTaskExecutor', () => {
     ).subscribe(undefined, done.fail, done);
   });
 
+  it('supports custom rules in the project (pass)', done => {
+    const testRunner = new SchematicTestRunner(
+      '@_/test',
+      path.join(__dirname, 'test/collection.json'),
+    );
+
+    const host = new TempScopedNodeJsSyncHost();
+    host.write(normalize('/file.ts'), virtualFs.stringToFileBuffer(`
+      console.log('hello world');
+    `)).subscribe();
+    const tree = new UnitTestTree(new HostTree(host));
+
+    const messages: string[] = [];
+
+    concat(
+      testRunner.runSchematicAsync('custom-rule', { shouldPass: true }, tree),
+      new Observable<void>(obs => {
+        process.chdir(getSystemPath(host.root));
+        testRunner.logger.subscribe(x => messages.push(x.message));
+        testRunner.engine.executePostTasks().subscribe(obs);
+      }),
+    ).subscribe(undefined, done.fail, done);
+  });
+
+  it('supports custom rules in the project (fail)', done => {
+    const testRunner = new SchematicTestRunner(
+      '@_/test',
+      path.join(__dirname, 'test/collection.json'),
+    );
+
+    const host = new TempScopedNodeJsSyncHost();
+    host.write(normalize('/file.ts'), virtualFs.stringToFileBuffer(`
+      console.log('hello world');
+    `)).subscribe();
+    const tree = new UnitTestTree(new HostTree(host));
+
+    const messages: string[] = [];
+    let error = false;
+
+    concat(
+      testRunner.runSchematicAsync('custom-rule', { shouldPass: false }, tree),
+      new Observable<void>(obs => {
+        process.chdir(getSystemPath(host.root));
+        testRunner.logger.subscribe(x => messages.push(x.message));
+        testRunner.engine.executePostTasks().subscribe(obs);
+      }).pipe(
+        catchError(() => {
+          error = true;
+
+          return [];
+        }),
+      ),
+      new Observable<void>(obs => {
+        expect(messages.find(msg => /\bcustom-rule fail\b/.test(msg))).not.toBeUndefined();
+        expect(error).toBe(true);
+
+        obs.complete();
+      }),
+    ).subscribe(undefined, done.fail, done);
+  });
+
 });
diff --git a/packages/angular_devkit/schematics/tasks/tslint-fix/test/collection.json b/packages/angular_devkit/schematics/tasks/tslint-fix/test/collection.json
@@ -1,5 +1,9 @@
 {
   "schematics": {
+    "custom-rule": {
+      "description": ".",
+      "factory": "./custom-rule"
+    },
     "run-task": {
       "description": ".",
       "factory": "./run-task"
diff --git a/packages/angular_devkit/schematics/tasks/tslint-fix/test/custom-rule.ts b/packages/angular_devkit/schematics/tasks/tslint-fix/test/custom-rule.ts
@@ -0,0 +1,30 @@
+/**
+ * @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 {
+  Rule,
+  SchematicContext,
+  Tree,
+} from '@angular-devkit/schematics';  // tslint:disable-line:no-implicit-dependencies
+import {
+  TslintFixTask,
+} from '@angular-devkit/schematics/tasks';  // tslint:disable-line:no-implicit-dependencies
+import * as path from 'path';
+
+export default function(options: { shouldPass: boolean }): Rule {
+  return (_: Tree, context: SchematicContext) => {
+    context.addTask(new TslintFixTask({
+      rulesDirectory: path.join(__dirname, 'rules'),
+      rules: {
+        'custom-rule': [true, options.shouldPass],
+      },
+    }, {
+      includes: '*.ts',
+      silent: false,
+    }));
+  };
+}
diff --git a/packages/angular_devkit/schematics/tasks/tslint-fix/test/rules/customRuleRule.js b/packages/angular_devkit/schematics/tasks/tslint-fix/test/rules/customRuleRule.js
@@ -0,0 +1,34 @@
+"use strict";
+/**
+ * @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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const Lint = require('tslint');
+
+
+class Rule extends Lint.Rules.AbstractRule {
+  apply(sourceFile) {
+    const shouldPass = this.getOptions().ruleArguments[0];
+    if (!shouldPass) {
+      return [ new Lint.RuleFailure(sourceFile, 0, 0, 'custom-rule fail', this.ruleName) ];
+    } else {
+      return [];
+    }
+  }
+}
+
+Rule.metadata = {
+  ruleName: 'custom-rule',
+  description: 'Test.',
+  rationale: 'Do not use this.',
+  options: [{ type: 'boolean' }],
+  optionsDescription: '.',
+  type: 'functionality',
+  typescriptOnly: false,
+};
+
+exports.Rule = Rule;
