refactor(@schematics/angular): use Tree's newly introduced readText and readJSON functionality

clydin · clydin · commit 3a3af1fca29c · 2022-04-19T12:03:47.000-04:00
Code related to decoding buffers into strings and parsing content into JSON can now be removed by using the
support provided directly from the Tree instance for the executing schematic.
diff --git a/packages/angular_devkit/schematics_cli/blank/factory.ts b/packages/angular_devkit/schematics_cli/blank/factory.ts
@@ -28,13 +28,12 @@ function addSchematicToCollectionJson(
   description: JsonObject,
 ): Rule {
   return (tree: Tree) => {
-    const collectionJsonContent = tree.read(collectionPath);
-    if (!collectionJsonContent) {
+    const collectionJson = tree.readJSON(collectionPath);
+    if (!collectionJson) {
       throw new Error('Invalid collection path: ' + collectionPath);
     }
 
-    const collectionJson = JSON.parse(collectionJsonContent.toString());
-    if (!isJsonObject(collectionJson.schematics)) {
+    if (!isJsonObject(collectionJson) || !isJsonObject(collectionJson.schematics)) {
       throw new Error('Invalid collection.json; schematics needs to be an object.');
     }
 
@@ -55,9 +54,9 @@ export default function (options: Schema): Rule {
 
     let collectionPath: Path | undefined;
     try {
-      const packageJsonContent = tree.read('/package.json');
+      const packageJsonContent = tree.readJSON('/package.json');
       if (packageJsonContent) {
-        const packageJson = JSON.parse(packageJsonContent.toString()) as {
+        const packageJson = packageJsonContent as {
           schematics: unknown;
         };
         if (typeof packageJson.schematics === 'string') {
diff --git a/packages/schematics/angular/app-shell/index.ts b/packages/schematics/angular/app-shell/index.ts
@@ -35,11 +35,11 @@ import { BrowserBuilderOptions, Builders, ServerBuilderOptions } from '../utilit
 import { Schema as AppShellOptions } from './schema';
 
 function getSourceFile(host: Tree, path: string): ts.SourceFile {
-  const buffer = host.read(path);
-  if (!buffer) {
+  const content = host.readText(path);
+  if (!content) {
     throw new SchematicsException(`Could not find ${path}.`);
   }
-  const content = buffer.toString();
+
   const source = ts.createSourceFile(path, content, ts.ScriptTarget.Latest, true);
 
   return source;
@@ -82,9 +82,9 @@ function getComponentTemplate(host: Tree, compPath: string, tmplInfo: TemplateIn
     const templateUrl = (tmplInfo.templateUrlProp.initializer as ts.StringLiteral).text;
     const dir = dirname(normalize(compPath));
     const templatePath = join(dir, templateUrl);
-    const buffer = host.read(templatePath);
-    if (buffer) {
-      template = buffer.toString();
+    const text = host.readText(templatePath);
+    if (text !== null) {
+      template = text;
     }
   }
 
diff --git a/packages/schematics/angular/component/index.ts b/packages/schematics/angular/component/index.ts
@@ -32,11 +32,10 @@ import { buildDefaultPath, getWorkspace } from '../utility/workspace';
 import { Schema as ComponentOptions, Style } from './schema';
 
 function readIntoSourceFile(host: Tree, modulePath: string): ts.SourceFile {
-  const text = host.read(modulePath);
-  if (text === null) {
+  const sourceText = host.readText(modulePath);
+  if (sourceText === null) {
     throw new SchematicsException(`File ${modulePath} does not exist.`);
   }
-  const sourceText = text.toString('utf-8');
 
   return ts.createSourceFile(modulePath, sourceText, ts.ScriptTarget.Latest, true);
 }
diff --git a/packages/schematics/angular/directive/index.ts b/packages/schematics/angular/directive/index.ts
@@ -36,11 +36,10 @@ function addDeclarationToNgModule(options: DirectiveOptions): Rule {
     }
 
     const modulePath = options.module;
-    const text = host.read(modulePath);
-    if (text === null) {
+    const sourceText = host.readText(modulePath);
+    if (sourceText === null) {
       throw new SchematicsException(`File ${modulePath} does not exist.`);
     }
-    const sourceText = text.toString('utf-8');
     const source = ts.createSourceFile(modulePath, sourceText, ts.ScriptTarget.Latest, true);
 
     const directivePath =
@@ -66,11 +65,10 @@ function addDeclarationToNgModule(options: DirectiveOptions): Rule {
 
     if (options.export) {
       // Need to refresh the AST because we overwrote the file in the host.
-      const text = host.read(modulePath);
-      if (text === null) {
+      const sourceText = host.readText(modulePath);
+      if (sourceText === null) {
         throw new SchematicsException(`File ${modulePath} does not exist.`);
       }
-      const sourceText = text.toString('utf-8');
       const source = ts.createSourceFile(modulePath, sourceText, ts.ScriptTarget.Latest, true);
 
       const exportRecorder = host.beginUpdate(modulePath);
diff --git a/packages/schematics/angular/module/index.ts b/packages/schematics/angular/module/index.ts
@@ -54,11 +54,10 @@ function addDeclarationToNgModule(options: ModuleOptions): Rule {
 
     const modulePath = options.module;
 
-    const text = host.read(modulePath);
-    if (text === null) {
+    const sourceText = host.readText(modulePath);
+    if (sourceText === null) {
       throw new SchematicsException(`File ${modulePath} does not exist.`);
     }
-    const sourceText = text.toString();
     const source = ts.createSourceFile(modulePath, sourceText, ts.ScriptTarget.Latest, true);
 
     const relativePath = buildRelativeModulePath(options, modulePath);
@@ -100,12 +99,11 @@ function addRouteDeclarationToNgModule(
       path = options.module;
     }
 
-    const text = host.read(path);
-    if (!text) {
+    const sourceText = host.readText(path);
+    if (sourceText === null) {
       throw new Error(`Couldn't find the module nor its routing module.`);
     }
 
-    const sourceText = text.toString();
     const addDeclaration = addRouteDeclarationToModule(
       ts.createSourceFile(path, sourceText, ts.ScriptTarget.Latest, true),
       path,
diff --git a/packages/schematics/angular/pipe/index.ts b/packages/schematics/angular/pipe/index.ts
@@ -35,11 +35,10 @@ function addDeclarationToNgModule(options: PipeOptions): Rule {
     }
 
     const modulePath = options.module;
-    const text = host.read(modulePath);
-    if (text === null) {
+    const sourceText = host.readText(modulePath);
+    if (sourceText === null) {
       throw new SchematicsException(`File ${modulePath} does not exist.`);
     }
-    const sourceText = text.toString('utf-8');
     const source = ts.createSourceFile(modulePath, sourceText, ts.ScriptTarget.Latest, true);
 
     const pipePath =
@@ -63,11 +62,10 @@ function addDeclarationToNgModule(options: PipeOptions): Rule {
     host.commitUpdate(recorder);
 
     if (options.export) {
-      const text = host.read(modulePath);
-      if (text === null) {
+      const sourceText = host.readText(modulePath);
+      if (sourceText === null) {
         throw new SchematicsException(`File ${modulePath} does not exist.`);
       }
-      const sourceText = text.toString('utf-8');
       const source = ts.createSourceFile(modulePath, sourceText, ts.ScriptTarget.Latest, true);
 
       const exportRecorder = host.beginUpdate(modulePath);
diff --git a/packages/schematics/angular/service-worker/index.ts b/packages/schematics/angular/service-worker/index.ts
@@ -122,11 +122,10 @@ function updateAppModule(mainPath: string): Rule {
 }
 
 function getTsSourceFile(host: Tree, path: string): ts.SourceFile {
-  const buffer = host.read(path);
-  if (!buffer) {
+  const content = host.readText(path);
+  if (content === null) {
     throw new SchematicsException(`Could not read file (${path}).`);
   }
-  const content = buffer.toString();
   const source = ts.createSourceFile(path, content, ts.ScriptTarget.Latest, true);
 
   return source;
diff --git a/packages/schematics/angular/universal/index.ts b/packages/schematics/angular/universal/index.ts
@@ -98,11 +98,10 @@ function updateConfigFile(options: UniversalOptions, tsConfigDirectory: Path): R
 }
 
 function findBrowserModuleImport(host: Tree, modulePath: string): ts.Node {
-  const moduleBuffer = host.read(modulePath);
-  if (!moduleBuffer) {
+  const moduleFileText = host.readText(modulePath);
+  if (moduleFileText === null) {
     throw new SchematicsException(`Module file (${modulePath}) not found`);
   }
-  const moduleFileText = moduleBuffer.toString('utf-8');
 
   const source = ts.createSourceFile(modulePath, moduleFileText, ts.ScriptTarget.Latest, true);
 
diff --git a/packages/schematics/angular/utility/json-file.ts b/packages/schematics/angular/utility/json-file.ts
@@ -27,9 +27,9 @@ export class JSONFile {
   content: string;
 
   constructor(private readonly host: Tree, private readonly path: string) {
-    const buffer = this.host.read(this.path);
-    if (buffer) {
-      this.content = buffer.toString();
+    const content = this.host.readText(this.path);
+    if (content !== null) {
+      this.content = content;
     } else {
       throw new Error(`Could not read '${path}'.`);
     }
diff --git a/packages/schematics/angular/utility/ng-ast-utils.ts b/packages/schematics/angular/utility/ng-ast-utils.ts
@@ -13,11 +13,10 @@ import * as ts from '../third_party/github.com/Microsoft/TypeScript/lib/typescri
 import { findNode, getSourceNodes } from '../utility/ast-utils';
 
 export function findBootstrapModuleCall(host: Tree, mainPath: string): ts.CallExpression | null {
-  const mainBuffer = host.read(mainPath);
-  if (!mainBuffer) {
+  const mainText = host.readText(mainPath);
+  if (mainText === null) {
     throw new SchematicsException(`Main file (${mainPath}) not found`);
   }
-  const mainText = mainBuffer.toString('utf-8');
   const source = ts.createSourceFile(mainPath, mainText, ts.ScriptTarget.Latest, true);
 
   const allNodes = getSourceNodes(source);
@@ -58,11 +57,10 @@ export function findBootstrapModulePath(host: Tree, mainPath: string): string {
 
   const bootstrapModule = bootstrapCall.arguments[0];
 
-  const mainBuffer = host.read(mainPath);
-  if (!mainBuffer) {
+  const mainText = host.readText(mainPath);
+  if (mainText === null) {
     throw new SchematicsException(`Client application main file (${mainPath}) not found`);
   }
-  const mainText = mainBuffer.toString('utf-8');
   const source = ts.createSourceFile(mainPath, mainText, ts.ScriptTarget.Latest, true);
   const allNodes = getSourceNodes(source);
   const bootstrapModuleRelativePath = allNodes
diff --git a/packages/schematics/angular/utility/workspace.ts b/packages/schematics/angular/utility/workspace.ts
@@ -6,19 +6,19 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import { json, virtualFs, workspaces } from '@angular-devkit/core';
+import { json, workspaces } from '@angular-devkit/core';
 import { Rule, Tree, noop } from '@angular-devkit/schematics';
 import { ProjectType } from './workspace-models';
 
 function createHost(tree: Tree): workspaces.WorkspaceHost {
   return {
     async readFile(path: string): Promise<string> {
-      const data = tree.read(path);
+      const data = tree.readText(path);
       if (!data) {
         throw new Error('File not found.');
       }
 
-      return virtualFs.fileBufferToString(data);
+      return data;
     },
     async writeFile(path: string, data: string): Promise<void> {
       return tree.overwrite(path, data);
diff --git a/packages/schematics/angular/web-worker/index.ts b/packages/schematics/angular/web-worker/index.ts
@@ -64,7 +64,7 @@ function addSnippet(options: WebWorkerOptions): Rule {
     `;
 
     // Append the worker creation snippet.
-    const originalContent = host.read(siblingModulePath);
+    const originalContent = host.readText(siblingModulePath);
     host.overwrite(siblingModulePath, originalContent + '\n' + workerCreationSnippet);
 
     return host;

Original file line number	Diff line number	Diff line change
`@@ -32,11 +32,10 @@ import { buildDefaultPath, getWorkspace } from '../utility/workspace';`
`32`	`32`	`import { Schema as ComponentOptions, Style } from './schema';`
`33`	`33`
`34`	`34`	`function readIntoSourceFile(host: Tree, modulePath: string): ts.SourceFile {`
`35`		`- const text = host.read(modulePath);`
`36`		`- if (text === null) {`
	`35`	`+ const sourceText = host.readText(modulePath);`
	`36`	`+ if (sourceText === null) {`
`37`	`37`	throw new SchematicsException(`File ${modulePath} does not exist.`);
`38`	`38`	`}`
`39`		`- const sourceText = text.toString('utf-8');`
`40`	`39`
`41`	`40`	`return ts.createSourceFile(modulePath, sourceText, ts.ScriptTarget.Latest, true);`
`42`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -122,11 +122,10 @@ function updateAppModule(mainPath: string): Rule {`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`function getTsSourceFile(host: Tree, path: string): ts.SourceFile {`
`125`		`- const buffer = host.read(path);`
`126`		`- if (!buffer) {`
	`125`	`+ const content = host.readText(path);`
	`126`	`+ if (content === null) {`
`127`	`127`	throw new SchematicsException(`Could not read file (${path}).`);
`128`	`128`	`}`
`129`		`- const content = buffer.toString();`
`130`	`129`	`const source = ts.createSourceFile(path, content, ts.ScriptTarget.Latest, true);`
`131`	`130`
`132`	`131`	`return source;`
Original file line number	Diff line number	Diff line change
`@@ -98,11 +98,10 @@ function updateConfigFile(options: UniversalOptions, tsConfigDirectory: Path): R`
`98`	`98`	`}`
`99`	`99`
`100`	`100`	`function findBrowserModuleImport(host: Tree, modulePath: string): ts.Node {`
`101`		`- const moduleBuffer = host.read(modulePath);`
`102`		`- if (!moduleBuffer) {`
	`101`	`+ const moduleFileText = host.readText(modulePath);`
	`102`	`+ if (moduleFileText === null) {`
`103`	`103`	throw new SchematicsException(`Module file (${modulePath}) not found`);
`104`	`104`	`}`
`105`		`- const moduleFileText = moduleBuffer.toString('utf-8');`
`106`	`105`
`107`	`106`	`const source = ts.createSourceFile(modulePath, moduleFileText, ts.ScriptTarget.Latest, true);`
`108`	`107`