UNPKG

docxml

Version:

TypeScript (component) library for building and parsing a DOCX file

176 lines (175 loc) 5.63 kB
// Documentation and interface for walk were adapted from Go // https://golang.org/pkg/path/filepath/#Walk // Copyright 2009 The Go Authors. All rights reserved. BSD license. import * as dntShim from "../../../../_dnt.shims.js"; import { assert } from "../_util/assert.js"; import { basename, join, normalize } from "../path/mod.js"; /** Create WalkEntry for the `path` synchronously */ export function _createWalkEntrySync(path) { path = normalize(path); const name = basename(path); const info = dntShim.Deno.statSync(path); return { path, name, isFile: info.isFile, isDirectory: info.isDirectory, isSymlink: info.isSymlink, }; } /** Create WalkEntry for the `path` asynchronously */ export async function _createWalkEntry(path) { path = normalize(path); const name = basename(path); const info = await dntShim.Deno.stat(path); return { path, name, isFile: info.isFile, isDirectory: info.isDirectory, isSymlink: info.isSymlink, }; } function include(path, exts, match, skip) { if (exts && !exts.some((ext) => path.endsWith(ext))) { return false; } if (match && !match.some((pattern) => !!path.match(pattern))) { return false; } if (skip && skip.some((pattern) => !!path.match(pattern))) { return false; } return true; } function wrapErrorWithRootPath(err, root) { if (err instanceof Error && "root" in err) return err; const e = new Error(); e.root = root; e.message = err instanceof Error ? `${err.message} for path "${root}"` : `[non-error thrown] for path "${root}"`; e.stack = err instanceof Error ? err.stack : undefined; e.cause = err instanceof Error ? err.cause : undefined; return e; } /** Walks the file tree rooted at root, yielding each file or directory in the * tree filtered according to the given options. The files are walked in lexical * order, which makes the output deterministic but means that for very large * directories walk() can be inefficient. * * Options: * - maxDepth?: number = Infinity; * - includeFiles?: boolean = true; * - includeDirs?: boolean = true; * - followSymlinks?: boolean = false; * - exts?: string[]; * - match?: RegExp[]; * - skip?: RegExp[]; * * ```ts * import { walk } from "./walk.ts"; * import { assert } from "../testing/asserts.ts"; * * for await (const entry of walk(".")) { * console.log(entry.path); * assert(entry.isFile); * } * ``` */ export async function* walk(root, { maxDepth = Infinity, includeFiles = true, includeDirs = true, followSymlinks = false, exts = undefined, match = undefined, skip = undefined, } = {}) { if (maxDepth < 0) { return; } if (includeDirs && include(root, exts, match, skip)) { yield await _createWalkEntry(root); } if (maxDepth < 1 || !include(root, undefined, undefined, skip)) { return; } try { for await (const entry of dntShim.Deno.readDir(root)) { assert(entry.name != null); let path = join(root, entry.name); let isFile = entry.isFile; if (entry.isSymlink) { if (followSymlinks) { path = await dntShim.Deno.realPath(path); isFile = await dntShim.Deno.lstat(path).then((s) => s.isFile); } else { continue; } } if (isFile) { if (includeFiles && include(path, exts, match, skip)) { yield { path, ...entry }; } } else { yield* walk(path, { maxDepth: maxDepth - 1, includeFiles, includeDirs, followSymlinks, exts, match, skip, }); } } } catch (err) { throw wrapErrorWithRootPath(err, normalize(root)); } } /** Same as walk() but uses synchronous ops */ export function* walkSync(root, { maxDepth = Infinity, includeFiles = true, includeDirs = true, followSymlinks = false, exts = undefined, match = undefined, skip = undefined, } = {}) { if (maxDepth < 0) { return; } if (includeDirs && include(root, exts, match, skip)) { yield _createWalkEntrySync(root); } if (maxDepth < 1 || !include(root, undefined, undefined, skip)) { return; } let entries; try { entries = dntShim.Deno.readDirSync(root); } catch (err) { throw wrapErrorWithRootPath(err, normalize(root)); } for (const entry of entries) { assert(entry.name != null); let path = join(root, entry.name); let isFile = entry.isFile; if (entry.isSymlink) { if (followSymlinks) { path = dntShim.Deno.realPathSync(path); isFile = dntShim.Deno.lstatSync(path).isFile; } else { continue; } } if (isFile) { if (includeFiles && include(path, exts, match, skip)) { yield { path, ...entry }; } } else { yield* walkSync(path, { maxDepth: maxDepth - 1, includeFiles, includeDirs, followSymlinks, exts, match, skip, }); } } }