fix: removed yieldContents feature

It's not optimal to hold the whole file in memory like that. The file contents will need to be streamed when needed.

[ci skip]

Author: tegefaulkes

src/vaults/types.ts

@@ -135,7 +135,7 @@ type VaultName = string;
 type VaultActions = Partial<Record<VaultAction, null>>;
 
 type FileTree = Array<TreeNode>;
-type TreeNode = DirectoryNode | FileNode | ContentNode;
+type TreeNode = DirectoryNode | FileNode;
 type FilePath = string;
 type INode = number;
 type CNode = number;
@@ -177,15 +177,6 @@ type FileNode = {
   stat?: StatEncoded;
 };
 
-// Keeping this separate from `FileNode` so we can optionally not include it.
-type ContentNode = {
-  type: 'content';
-  path: undefined;
-  fileName: string;
-  cNode: CNode;
-  contents: string;
-};
-
 export { vaultActions };
 
 export type {
@@ -208,7 +199,6 @@ export type {
   StatEncoded,
   DirectoryNode,
   FileNode,
-  ContentNode,
 };
 
 export { tagLast, refs };

src/vaults/utils.ts

@@ -159,7 +159,6 @@ function genStat(stat: Stat): StatEncoded {
  * @param yieldParents - Toggles yielding details about parents of pattern matched paths. Defaults to false.
  * @param yieldDirectories - Toggles yielding directories that match the pattern. Defaults to true.
  * @param yieldFiles - Toggles yielding files that match the pattern. Defaults to true.
- * @param yieldContents - Toggles yielding file contents after all other details are yielded. Defaults to false.
  * @param yieldStats - Toggles including stats in file and directory details. Defaults to false.
  */
 async function* globWalk({
@@ -170,7 +169,6 @@ async function* globWalk({
   yieldParents = false,
   yieldDirectories = true,
   yieldFiles = true,
-  yieldContents = false,
   yieldStats = false,
 }: {
   fs: FileSystem | FileSystemReadable;
@@ -180,7 +178,6 @@ async function* globWalk({
   yieldParents?: boolean;
   yieldDirectories?: boolean;
   yieldFiles?: boolean;
-  yieldContents?: boolean;
   yieldStats?: boolean;
 }): AsyncGenerator<TreeNode, void, void> {
   const files: Array<string> = [];
@@ -285,19 +282,6 @@ async function* globWalk({
     }
     current = queue.shift();
   }
-  if (!yieldContents) return;
-  // Iterate over file contents
-  for (let i = 0; i < files.length; i++) {
-    const filePath = files[i];
-    yield {
-      type: 'content',
-      path: undefined,
-      fileName: path.basename(filePath),
-      cNode: i,
-      // @ts-ignore: While the types don't fully match, it matches enough for our usage.
-      contents: (await fs.promises.readFile(filePath)).toString(),
-    };
-  }
 }
 
 export {

tests/vaults/VaultOps.test.ts

@@ -559,7 +559,6 @@ describe('VaultOps', () => {
           yieldFiles: true,
           yieldParents: true,
           yieldRoot: true,
-          yieldContents: false,
         })) {
           tree.push(treeNode);
         }

tests/vaults/utils.test.ts

@@ -138,7 +138,6 @@ describe('Vaults utils', () => {
         yieldFiles: true,
         yieldParents: true,
         yieldRoot: true,
-        yieldContents: false,
       })) {
         tree.push(treeNode);
       }
@@ -172,7 +171,6 @@ describe('Vaults utils', () => {
         yieldFiles: true,
         yieldParents: true,
         yieldRoot: true,
-        yieldContents: false,
       })) {
         tree.push(treeNode);
       }
@@ -206,7 +204,6 @@ describe('Vaults utils', () => {
         yieldFiles: true,
         yieldParents: true,
         yieldRoot: true,
-        yieldContents: false,
       })) {
         tree.push(treeNode);
       }
@@ -230,7 +227,6 @@ describe('Vaults utils', () => {
         yieldFiles: true,
         yieldParents: true,
         yieldRoot: true,
-        yieldContents: false,
       })) {
         tree.push(treeNode);
       }
@@ -319,31 +315,6 @@ describe('Vaults utils', () => {
         ),
       );
     });
-    test('Yields file contents directories with `yieldContents`', async () => {
-      const tree: FileTree = [];
-      for await (const treeNode of vaultsUtils.globWalk({
-        fs: fs,
-        basePath: relativeBase,
-        yieldFiles: false,
-        yieldDirectories: false,
-        yieldContents: true,
-      })) {
-        tree.push(treeNode);
-      }
-      const files = tree.map((v) => (v.type === 'content' ? v.contents : ''));
-      expect(files).toContainAllValues([
-        'content-file0',
-        'content-file9',
-        'content-file1',
-        'content-file2',
-        'content-file3',
-        'content-file4',
-        'content-file5',
-        'content-file6',
-        'content-file7',
-        'content-file8',
-      ]);
-    });
     test('Yields stats with `yieldStats`', async () => {
       const tree: FileTree = [];
       for await (const treeNode of vaultsUtils.globWalk({
@@ -352,7 +323,6 @@ describe('Vaults utils', () => {
         yieldStats: true,
         yieldFiles: true,
         yieldDirectories: true,
-        yieldContents: false,
       })) {
         tree.push(treeNode);
       }