thecodrr/fdir

View on GitHub
src/api/functions/walk-directory.ts

Summary

Maintainability
A
0 mins
Test Coverage
import { WalkerState } from "../../types";
import fs from "fs";

export type WalkDirectoryFunction = (
  state: WalkerState,
  crawlPath: string,
  directoryPath: string,
  depth: number,
  callback: (entries: fs.Dirent[], directoryPath: string, depth: number) => void
) => void;

const readdirOpts = { withFileTypes: true } as const;

const walkAsync: WalkDirectoryFunction = (
  state,
  crawlPath,
  directoryPath,
  currentDepth,
  callback
) => {
  if (currentDepth < 0) return state.queue.dequeue(null, state);

  state.visited.push(crawlPath);
  state.counts.directories++;
  state.queue.enqueue();

  // Perf: Node >= 10 introduced withFileTypes that helps us
  // skip an extra fs.stat call.
  fs.readdir(crawlPath || ".", readdirOpts, (error, entries = []) => {
    callback(entries, directoryPath, currentDepth);

    state.queue.dequeue(state.options.suppressErrors ? null : error, state);
  });
};

const walkSync: WalkDirectoryFunction = (
  state,
  crawlPath,
  directoryPath,
  currentDepth,
  callback
) => {
  if (currentDepth < 0) return;
  state.visited.push(crawlPath);
  state.counts.directories++;

  let entries: fs.Dirent[] = [];
  try {
    entries = fs.readdirSync(crawlPath || ".", readdirOpts);
  } catch (e) {
    if (!state.options.suppressErrors) throw e;
  }
  callback(entries, directoryPath, currentDepth);
};

export function build(isSynchronous: boolean): WalkDirectoryFunction {
  return isSynchronous ? walkSync : walkAsync;
}