fix(@angular-devkit/schematics): deprecate synchronous testing methods

clydin · Keen Yee Liau · commit 2172db1ed0d9 · 2019-05-15T14:10:27.000-07:00
All schematics can potentially be async.  The synchronous test method variants (`runSchematic`/`runExternalSchematic`) will fail if the schematic, any of its rules, or any schematic it calls are async.
diff --git a/packages/angular_devkit/schematics/testing/schematic-test-runner.ts b/packages/angular_devkit/schematics/testing/schematic-test-runner.ts
@@ -85,6 +85,12 @@ export class SchematicTestRunner {
       .pipe(map(tree => new UnitTestTree(tree)));
   }
 
+  /**
+   * @deprecated Since v8.0.0 - Use {@link SchematicTestRunner.runSchematicAsync} instead.
+   * All schematics can potentially be async.
+   * This synchronous variant will fail if the schematic, any of its rules, or any schematics
+   * it calls are async.
+   */
   runSchematic<SchematicSchemaT>(
     schematicName: string,
     opts?: SchematicSchemaT,
@@ -126,6 +132,12 @@ export class SchematicTestRunner {
       .pipe(map(tree => new UnitTestTree(tree)));
   }
 
+  /**
+   * @deprecated Since v8.0.0 - Use {@link SchematicTestRunner.runExternalSchematicAsync} instead.
+   * All schematics can potentially be async.
+   * This synchronous variant will fail if the schematic, any of its rules, or any schematics
+   * it calls are async.
+   */
   runExternalSchematic<SchematicSchemaT>(
     collectionName: string,
     schematicName: string,
