crawlfs.ts

import { promisify } from 'util';
import { glob as _glob, IOptions } from 'glob';

import fs from './wrapped-fs';
import { Stats } from 'fs';

const glob = promisify(_glob);

export type CrawledFileType = {
  type: 'file' | 'directory' | 'link';
  stat: Stats;
  transformed?: {
    path: string;
    stat: Stats;
  };
};

export async function determineFileType(filename: string): Promise<CrawledFileType | null> {
  const stat = await fs.lstat(filename);
  if (stat.isFile()) {
    return { type: 'file', stat };
  } else if (stat.isDirectory()) {
    return { type: 'directory', stat };
  } else if (stat.isSymbolicLink()) {
    return { type: 'link', stat };
  }
  return null;
}

export async function crawl(dir: string, options: IOptions) {
  const metadata: Record<string, CrawledFileType> = {};
  const crawled = await glob(dir, options);
  const results = await Promise.all(
    crawled.map(async (filename) => <const>[filename, await determineFileType(filename)]),
  );
  const links: string[] = [];
  const filenames = results
    .map(([filename, type]) => {
      if (type) {
        metadata[filename] = type;
        if (type.type === 'link') links.push(filename);
      }
      return filename;
    })
    .filter((filename) => {
      // Newer glob can return files inside symlinked directories, to avoid
      // those appearing in archives we need to manually exclude theme here
      const exactLinkIndex = links.findIndex((link) => filename === link);
      return links.every((link, index) => {
        if (index === exactLinkIndex) return true;
        return !filename.startsWith(link);
      });
    });
  return <const>[filenames, metadata];
}