serialReport API

Author: kristoferbaxter

package.json

@@ -65,7 +65,7 @@
       "gzip": "3.8 kB",
       "none": "20 kB"
     },
-    "./dist/index.js": {
+    "./dist/api.js": {
       "brotli": "5 kB",
       "gzip": "6.5 kB"
     },

src/api.ts

@@ -16,13 +16,10 @@
 
 import Project from './validation/Project';
 import Config from './validation/Config';
-import { Context, SizeMap } from './validation/Condition';
+import { Context, SizeMap, FileModifier } from './validation/Condition';
 import compress from './compress';
 
-export async function* report(
-  projectPath: string,
-  fileModifier: ((contents: string) => string) | null,
-): AsyncGenerator<[SizeMap, SizeMap]> {
+export async function* report(projectPath: string, fileModifier: FileModifier): AsyncGenerator<[SizeMap, SizeMap]> {
   const conditions = [Project, Config];
   let context: Context = {
     projectPath,
@@ -53,3 +50,44 @@ export async function* report(
   }
   return [context.compressed, context.comparison];
 }
+
+export async function* serialReport(
+  projectPath: string,
+  fileModifier: FileModifier,
+): AsyncGenerator<[string, number, number, number]> {
+  const conditions = [Project, Config];
+  let context: Context = {
+    projectPath,
+    packagePath: '',
+    packageContent: '',
+    silent: true,
+    originalPaths: new Map(),
+    // Stores the result of compression <path, [...results]>
+    compressed: new Map(),
+    // Stores the basis of comparison.
+    comparison: new Map(),
+    fileModifier,
+    fileContents: new Map(),
+  };
+
+  for (const condition of conditions) {
+    const message = await condition(context)();
+    if (message !== null) {
+      throw message;
+    }
+  }
+
+  const compressResults = compress(context, false);
+  const paths: Set<string> = new Set(Array.from(context.compressed.keys()));
+  let next = await compressResults.next();
+  while (!next.done) {
+    for (const filePath of paths) {
+      const sizes = context.compressed.get(filePath);
+      if (sizes !== undefined && sizes?.[0][0] && sizes?.[1][0] && sizes?.[2][0]) {
+        yield [filePath, sizes?.[0][0], sizes?.[1][0], sizes?.[2][0]];
+      }
+    }
+    next = await compressResults.next();
+  }
+  return;
+}

src/validation/Condition.ts

@@ -48,6 +48,7 @@ export const SizeMapValueIndex = {
 export type SizeMap = Map<path, SizeMapValue>;
 
 export type FileContentsMap = Map<path, string>;
+export type FileModifier = ((contents: string) => string) | null;
 
 export interface Context {
   projectPath: string;
@@ -60,7 +61,7 @@ export interface Context {
   // Stores the basis of comparison.
   comparison: SizeMap;
   // Allows the API to specify a method that alters content before analysis.
-  fileModifier: ((contents: string) => string) | null;
+  fileModifier: FileModifier;
   // Stores the contents of files, to avoid reading from disk per compression type.
   fileContents: FileContentsMap;
 }