-
Notifications
You must be signed in to change notification settings - Fork 577
/
walk.ts
196 lines (183 loc) · 5.04 KB
/
walk.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
// 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 { assert } from "../assert/assert.ts";
import { join, normalize } from "../path/mod.ts";
import {
createWalkEntry,
createWalkEntrySync,
toPathString,
WalkEntry,
} from "./_util.ts";
export class WalkError extends Error {
override cause: unknown;
override name = "WalkError";
path: string;
constructor(cause: unknown, path: string) {
super(
`${cause instanceof Error ? cause.message : cause} for path "${path}"`,
);
this.path = path;
this.cause = cause;
}
}
function include(
path: string,
exts?: string[],
match?: RegExp[],
skip?: RegExp[],
): boolean {
if (exts && !exts.some((ext): boolean => path.endsWith(ext))) {
return false;
}
if (match && !match.some((pattern): boolean => !!path.match(pattern))) {
return false;
}
if (skip && skip.some((pattern): boolean => !!path.match(pattern))) {
return false;
}
return true;
}
function wrapErrorWithPath(err: unknown, root: string) {
if (err instanceof WalkError) return err;
return new WalkError(err, root);
}
export interface WalkOptions {
/** @default {Infinity} */
maxDepth?: number;
/** @default {true} */
includeFiles?: boolean;
/** @default {true} */
includeDirs?: boolean;
/** @default {false} */
followSymlinks?: boolean;
exts?: string[];
match?: RegExp[];
skip?: RegExp[];
}
export type { WalkEntry };
/**
* Walks the file tree rooted at root, yielding each file or directory in the
* tree filtered according to the given options.
*
* @example
* ```ts
* import { walk } from "https://deno.land/std@$STD_VERSION/fs/walk.ts";
* import { assert } from "https://deno.land/std@$STD_VERSION/assert/assert.ts";
*
* for await (const entry of walk(".")) {
* console.log(entry.path);
* assert(entry.isFile);
* }
* ```
*/
export async function* walk(
root: string | URL,
{
maxDepth = Infinity,
includeFiles = true,
includeDirs = true,
followSymlinks = false,
exts = undefined,
match = undefined,
skip = undefined,
}: WalkOptions = {},
): AsyncIterableIterator<WalkEntry> {
if (maxDepth < 0) {
return;
}
root = toPathString(root);
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 Deno.readDir(root)) {
assert(entry.name != null);
let path = join(root, entry.name);
let { isSymlink, isDirectory } = entry;
if (isSymlink) {
if (!followSymlinks) continue;
path = await Deno.realPath(path);
// Caveat emptor: don't assume |path| is not a symlink. realpath()
// resolves symlinks but another process can replace the file system
// entity with a different type of entity before we call lstat().
({ isSymlink, isDirectory } = await Deno.lstat(path));
}
if (isSymlink || isDirectory) {
yield* walk(path, {
maxDepth: maxDepth - 1,
includeFiles,
includeDirs,
followSymlinks,
exts,
match,
skip,
});
} else if (includeFiles && include(path, exts, match, skip)) {
yield { path, ...entry };
}
}
} catch (err) {
throw wrapErrorWithPath(err, normalize(root));
}
}
/** Same as walk() but uses synchronous ops */
export function* walkSync(
root: string | URL,
{
maxDepth = Infinity,
includeFiles = true,
includeDirs = true,
followSymlinks = false,
exts = undefined,
match = undefined,
skip = undefined,
}: WalkOptions = {},
): IterableIterator<WalkEntry> {
root = toPathString(root);
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 = Deno.readDirSync(root);
} catch (err) {
throw wrapErrorWithPath(err, normalize(root));
}
for (const entry of entries) {
assert(entry.name != null);
let path = join(root, entry.name);
let { isSymlink, isDirectory } = entry;
if (isSymlink) {
if (!followSymlinks) continue;
path = Deno.realPathSync(path);
// Caveat emptor: don't assume |path| is not a symlink. realpath()
// resolves symlinks but another process can replace the file system
// entity with a different type of entity before we call lstat().
({ isSymlink, isDirectory } = Deno.lstatSync(path));
}
if (isSymlink || isDirectory) {
yield* walkSync(path, {
maxDepth: maxDepth - 1,
includeFiles,
includeDirs,
followSymlinks,
exts,
match,
skip,
});
} else if (includeFiles && include(path, exts, match, skip)) {
yield { path, ...entry };
}
}
}