path-class 0.10.13 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib/path-class/Path.d.ts +7 -1
- package/dist/lib/path-class/chunks/{chunk-PF7ITQCP.js → chunk-HPGQLKA5.js} +17 -1
- package/dist/lib/path-class/chunks/chunk-HPGQLKA5.js.map +7 -0
- package/dist/lib/path-class/index.js +1 -1
- package/dist/lib/path-class/sync/PathSync.d.ts +46 -0
- package/dist/lib/path-class/sync/index.d.ts +1 -32
- package/dist/lib/path-class/sync/index.js +180 -116
- package/dist/lib/path-class/sync/index.js.map +3 -3
- package/dist/lib/path-class/sync/modifiedNodeTypes.d.ts +7 -1
- package/package.json +6 -7
- package/src/Path.test.ts +39 -0
- package/src/Path.ts +23 -1
- package/src/sync/{sync.test.ts → PathSync.test.ts} +68 -28
- package/src/sync/PathSync.ts +271 -0
- package/src/sync/index.ts +1 -253
- package/src/sync/modifiedNodeTypes.ts +11 -0
- package/dist/lib/path-class/chunks/chunk-PF7ITQCP.js.map +0 -7
- package/dist/lib/path-class/sync/static.d.ts +0 -6
- package/src/sync/static.ts +0 -14
|
@@ -0,0 +1,271 @@
|
|
|
1
|
+
import {
|
|
2
|
+
appendFileSync,
|
|
3
|
+
chmodSync,
|
|
4
|
+
cpSync,
|
|
5
|
+
lstatSync,
|
|
6
|
+
mkdirSync,
|
|
7
|
+
mkdtempSync,
|
|
8
|
+
readdirSync,
|
|
9
|
+
readFileSync,
|
|
10
|
+
realpathSync,
|
|
11
|
+
renameSync,
|
|
12
|
+
rmdirSync,
|
|
13
|
+
rmSync,
|
|
14
|
+
statSync,
|
|
15
|
+
symlinkSync,
|
|
16
|
+
writeFileSync,
|
|
17
|
+
} from "node:fs";
|
|
18
|
+
import { constants } from "node:fs/promises";
|
|
19
|
+
import { tmpdir } from "node:os";
|
|
20
|
+
import { mustNotHaveTrailingSlash, Path } from "../Path";
|
|
21
|
+
import type {
|
|
22
|
+
lstatSyncType,
|
|
23
|
+
readDirSyncType,
|
|
24
|
+
readFileSyncType,
|
|
25
|
+
statSyncType,
|
|
26
|
+
} from "./modifiedNodeTypes";
|
|
27
|
+
|
|
28
|
+
export class PathSync extends Path {
|
|
29
|
+
static override fromString(s: string): PathSync {
|
|
30
|
+
return new PathSync(s);
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
static override resolve(...args: Parameters<typeof Path.resolve>): PathSync {
|
|
34
|
+
return new PathSync(Path.resolve(...args));
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
override toggleTrailingSlash(
|
|
38
|
+
...args: Parameters<Path["toggleTrailingSlash"]>
|
|
39
|
+
): PathSync {
|
|
40
|
+
return new PathSync(super.toggleTrailingSlash(...args));
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
override join(...args: Parameters<Path["join"]>): PathSync {
|
|
44
|
+
return new PathSync(super.join(...args));
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
override asRelative(...args: Parameters<Path["asRelative"]>): PathSync {
|
|
48
|
+
return new PathSync(super.asRelative(...args));
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
override asAbsolute(...args: Parameters<Path["asAbsolute"]>): PathSync {
|
|
52
|
+
return new PathSync(super.asAbsolute(...args));
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
override asBare(...args: Parameters<Path["asBare"]>): PathSync {
|
|
56
|
+
return new PathSync(super.asBare(...args));
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
override extendBasename(
|
|
60
|
+
...args: Parameters<Path["extendBasename"]>
|
|
61
|
+
): PathSync {
|
|
62
|
+
return new PathSync(super.extendBasename(...args));
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
override get parent(): PathSync {
|
|
66
|
+
return new PathSync(super.parent);
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
override get dirname(): PathSync {
|
|
70
|
+
return new PathSync(super.dirname);
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
override get basename(): PathSync {
|
|
74
|
+
return new PathSync(super.basename);
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
static override get homedir(): PathSync {
|
|
78
|
+
return new PathSync(Path.homedir);
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
static override get cwd(): PathSync {
|
|
82
|
+
return new PathSync(Path.cwd);
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
override debugPrint(...args: Parameters<Path["debugPrint"]>): PathSync {
|
|
86
|
+
return new PathSync(super.debugPrint(...args));
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
// TODO: find a neat way to dedup with the async version? // lint-sync-code-expect-error
|
|
90
|
+
existsSync(constraints?: { mustBe: "file" | "directory" }): boolean {
|
|
91
|
+
if (constraints?.mustBe === "file") {
|
|
92
|
+
mustNotHaveTrailingSlash(this);
|
|
93
|
+
}
|
|
94
|
+
let stats: ReturnType<typeof statSync>;
|
|
95
|
+
try {
|
|
96
|
+
stats = statSync(this.path);
|
|
97
|
+
// biome-ignore lint/suspicious/noExplicitAny: TypeScript limitation
|
|
98
|
+
} catch (e: any) {
|
|
99
|
+
if (e.code === "ENOENT") {
|
|
100
|
+
return false;
|
|
101
|
+
}
|
|
102
|
+
throw e;
|
|
103
|
+
}
|
|
104
|
+
if (!constraints?.mustBe) {
|
|
105
|
+
return true;
|
|
106
|
+
}
|
|
107
|
+
switch (constraints?.mustBe) {
|
|
108
|
+
case "file": {
|
|
109
|
+
if (stats.isFile()) {
|
|
110
|
+
return true;
|
|
111
|
+
}
|
|
112
|
+
throw new Error(`PathSync exists but is not a file: ${this.path}`);
|
|
113
|
+
}
|
|
114
|
+
case "directory": {
|
|
115
|
+
if (stats.isDirectory()) {
|
|
116
|
+
return true;
|
|
117
|
+
}
|
|
118
|
+
throw new Error(`PathSync exists but is not a directory: ${this.path}`);
|
|
119
|
+
}
|
|
120
|
+
default: {
|
|
121
|
+
throw new Error("Invalid path type constraint");
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
existsAsFileSync(): boolean {
|
|
127
|
+
return this.existsSync({ mustBe: "file" });
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
existsAsDirSync(): boolean {
|
|
131
|
+
return this.existsSync({ mustBe: "directory" });
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
mkdirSync(options?: Parameters<typeof mkdirSync>[1]): PathSync {
|
|
135
|
+
const optionsObject = (() => {
|
|
136
|
+
if (typeof options === "string" || typeof options === "number") {
|
|
137
|
+
return { mode: options };
|
|
138
|
+
}
|
|
139
|
+
return options ?? {};
|
|
140
|
+
})();
|
|
141
|
+
mkdirSync(this.path, { recursive: true, ...optionsObject });
|
|
142
|
+
return this;
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
cpSync(
|
|
146
|
+
destination: string | URL | Path,
|
|
147
|
+
options?: Parameters<typeof cpSync>[2],
|
|
148
|
+
): PathSync {
|
|
149
|
+
cpSync(this.path, new Path(destination).path, options);
|
|
150
|
+
return new PathSync(destination);
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
renameSync(destination: string | URL | Path): void {
|
|
154
|
+
renameSync(this.path, new Path(destination).path);
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
static makeTempDirSync(prefix?: string): PathSync {
|
|
158
|
+
return new PathSync(
|
|
159
|
+
mkdtempSync(new Path(tmpdir()).join(prefix ?? "js-temp-").toString()),
|
|
160
|
+
);
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
rmSync(options?: Parameters<typeof rmSync>[1]): void {
|
|
164
|
+
rmSync(this.path, options);
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
rmDirSync(): void {
|
|
168
|
+
rmdirSync(this.path);
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
rm_rfSync(options?: Parameters<typeof rmSync>[1]): void {
|
|
172
|
+
this.rmSync({ recursive: true, force: true, ...(options ?? {}) });
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
readSync: typeof readFileSyncType = (options) =>
|
|
176
|
+
// biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.
|
|
177
|
+
readFileSync(this.path, options) as any;
|
|
178
|
+
|
|
179
|
+
readTextSync(): string {
|
|
180
|
+
return readFileSync(this.path, "utf-8");
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
readJSONSync<T>(options?: { fallback?: T }): T {
|
|
184
|
+
try {
|
|
185
|
+
return JSON.parse(this.readTextSync());
|
|
186
|
+
} catch (e) {
|
|
187
|
+
if (
|
|
188
|
+
(e as { code?: string }).code === "ENOENT" &&
|
|
189
|
+
options &&
|
|
190
|
+
"fallback" in options
|
|
191
|
+
) {
|
|
192
|
+
return options.fallback as T;
|
|
193
|
+
}
|
|
194
|
+
throw e;
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
appendFileSync(
|
|
199
|
+
data: Parameters<typeof appendFileSync>[1],
|
|
200
|
+
options?: Parameters<typeof appendFileSync>[2],
|
|
201
|
+
): PathSync {
|
|
202
|
+
appendFileSync(this.path, data, options);
|
|
203
|
+
return this;
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
writeSync(
|
|
207
|
+
data: Parameters<typeof writeFileSync>[1],
|
|
208
|
+
options?: Parameters<typeof writeFileSync>[2],
|
|
209
|
+
): PathSync {
|
|
210
|
+
this.parent.mkdirSync();
|
|
211
|
+
writeFileSync(this.path, data, options);
|
|
212
|
+
return this;
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
writeJSONSync<T>(
|
|
216
|
+
data: T,
|
|
217
|
+
replacer: Parameters<typeof JSON.stringify>[1] = null,
|
|
218
|
+
space: Parameters<typeof JSON.stringify>[2] = " ",
|
|
219
|
+
): PathSync {
|
|
220
|
+
this.parent.mkdirSync();
|
|
221
|
+
this.writeSync(JSON.stringify(data, replacer, space));
|
|
222
|
+
return this;
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
// biome-ignore lint/suspicious/noExplicitAny: Type wrangling.
|
|
226
|
+
readDirSync: typeof readDirSyncType = (options: any) =>
|
|
227
|
+
// biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.
|
|
228
|
+
readdirSync(this.path, options) as any;
|
|
229
|
+
|
|
230
|
+
symlinkSync(
|
|
231
|
+
target: string | URL | Path,
|
|
232
|
+
type?: Parameters<typeof symlinkSync>[2],
|
|
233
|
+
): PathSync {
|
|
234
|
+
const targetPath = new PathSync(target);
|
|
235
|
+
symlinkSync(
|
|
236
|
+
this.path,
|
|
237
|
+
targetPath.path,
|
|
238
|
+
type as Exclude<Parameters<typeof symlinkSync>[2], undefined>, // 🤷
|
|
239
|
+
);
|
|
240
|
+
return targetPath;
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
realpathSync(): PathSync {
|
|
244
|
+
return new PathSync(realpathSync(this.path));
|
|
245
|
+
}
|
|
246
|
+
|
|
247
|
+
statSync: typeof statSyncType = (options) =>
|
|
248
|
+
// biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.
|
|
249
|
+
statSync(this.path, options) as any;
|
|
250
|
+
|
|
251
|
+
lstatSync: typeof lstatSyncType = (options) =>
|
|
252
|
+
// biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.
|
|
253
|
+
lstatSync(this.path, options) as any;
|
|
254
|
+
|
|
255
|
+
chmodSync(mode: Parameters<typeof chmodSync>[1]): PathSync {
|
|
256
|
+
chmodSync(this.path, mode);
|
|
257
|
+
return this;
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
chmodXSync(): PathSync {
|
|
261
|
+
const { mode } = this.statSync();
|
|
262
|
+
this.chmodSync(
|
|
263
|
+
mode |
|
|
264
|
+
constants.S_IRWXU |
|
|
265
|
+
constants.S_IXUSR |
|
|
266
|
+
constants.S_IXGRP |
|
|
267
|
+
constants.S_IXOTH,
|
|
268
|
+
);
|
|
269
|
+
return this;
|
|
270
|
+
}
|
|
271
|
+
}
|
package/src/sync/index.ts
CHANGED
|
@@ -1,253 +1 @@
|
|
|
1
|
-
|
|
2
|
-
appendFileSync,
|
|
3
|
-
cpSync,
|
|
4
|
-
lstatSync,
|
|
5
|
-
mkdirSync,
|
|
6
|
-
readdirSync,
|
|
7
|
-
readFileSync,
|
|
8
|
-
realpathSync,
|
|
9
|
-
renameSync,
|
|
10
|
-
rmdirSync,
|
|
11
|
-
rmSync,
|
|
12
|
-
statSync,
|
|
13
|
-
symlinkSync,
|
|
14
|
-
writeFileSync,
|
|
15
|
-
} from "node:fs";
|
|
16
|
-
import { mustNotHaveTrailingSlash, Path } from "../Path";
|
|
17
|
-
import "./static";
|
|
18
|
-
import type {
|
|
19
|
-
lstatSyncType,
|
|
20
|
-
readDirSyncType,
|
|
21
|
-
readFileSyncType,
|
|
22
|
-
statSyncType,
|
|
23
|
-
} from "./modifiedNodeTypes";
|
|
24
|
-
|
|
25
|
-
// Note that (non-static) functions in this file are defined using `function(…)
|
|
26
|
-
// { … }` rather than arrow functions, specifically because we want `this` to
|
|
27
|
-
// operate on the `Path` instance.
|
|
28
|
-
|
|
29
|
-
declare module "../Path" {
|
|
30
|
-
interface Path {
|
|
31
|
-
existsSync(constraints?: { mustBe: "file" | "directory" }): boolean;
|
|
32
|
-
existsAsFileSync(): boolean;
|
|
33
|
-
existsAsDirSync(): boolean;
|
|
34
|
-
|
|
35
|
-
mkdirSync(options?: Parameters<typeof mkdirSync>[1]): Path;
|
|
36
|
-
cpSync(
|
|
37
|
-
destination: string | URL | Path,
|
|
38
|
-
options?: Parameters<typeof cpSync>[2],
|
|
39
|
-
): Path;
|
|
40
|
-
renameSync(destination: string | URL | Path): void;
|
|
41
|
-
|
|
42
|
-
rmSync(options?: Parameters<typeof rmSync>[1]): void;
|
|
43
|
-
rmDirSync(options?: Parameters<typeof rmdirSync>[1]): void;
|
|
44
|
-
rm_rfSync(options?: Parameters<typeof rmSync>[1]): void;
|
|
45
|
-
|
|
46
|
-
readSync: typeof readFileSyncType;
|
|
47
|
-
readTextSync(): string;
|
|
48
|
-
readJSONSync<T>(options?: { fallback?: T }): T;
|
|
49
|
-
|
|
50
|
-
appendFileSync(
|
|
51
|
-
data: Parameters<typeof appendFileSync>[1],
|
|
52
|
-
options?: Parameters<typeof appendFileSync>[2],
|
|
53
|
-
): Path;
|
|
54
|
-
|
|
55
|
-
writeSync(
|
|
56
|
-
data: Parameters<typeof writeFileSync>[1],
|
|
57
|
-
options?: Parameters<typeof writeFileSync>[2] | undefined,
|
|
58
|
-
): Path;
|
|
59
|
-
writeJSONSync<T>(
|
|
60
|
-
data: T,
|
|
61
|
-
replacer?: Parameters<typeof JSON.stringify>[1],
|
|
62
|
-
space?: Parameters<typeof JSON.stringify>[2],
|
|
63
|
-
): Path;
|
|
64
|
-
|
|
65
|
-
readDirSync: typeof readDirSyncType;
|
|
66
|
-
|
|
67
|
-
/** Returns the destination path. */
|
|
68
|
-
symlinkSync(
|
|
69
|
-
target: string | URL | Path,
|
|
70
|
-
type?: Parameters<typeof symlinkSync>[2],
|
|
71
|
-
): Path;
|
|
72
|
-
realpathSync(): Path;
|
|
73
|
-
|
|
74
|
-
statSync: typeof statSyncType;
|
|
75
|
-
lstatSync: typeof lstatSyncType;
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
// TODO: find a neat way to dedup with the async version? // lint-sync-code-expect-error
|
|
80
|
-
Path.prototype.existsSync = function (constraints?: {
|
|
81
|
-
mustBe: "file" | "directory";
|
|
82
|
-
}): boolean {
|
|
83
|
-
if (constraints?.mustBe === "file") {
|
|
84
|
-
mustNotHaveTrailingSlash(this);
|
|
85
|
-
}
|
|
86
|
-
let stats: ReturnType<typeof statSync>;
|
|
87
|
-
try {
|
|
88
|
-
stats = statSync(this.path);
|
|
89
|
-
// biome-ignore lint/suspicious/noExplicitAny: TypeScript limitation
|
|
90
|
-
} catch (e: any) {
|
|
91
|
-
if (e.code === "ENOENT") {
|
|
92
|
-
return false;
|
|
93
|
-
}
|
|
94
|
-
throw e;
|
|
95
|
-
}
|
|
96
|
-
if (!constraints?.mustBe) {
|
|
97
|
-
return true;
|
|
98
|
-
}
|
|
99
|
-
switch (constraints?.mustBe) {
|
|
100
|
-
case "file": {
|
|
101
|
-
if (stats.isFile()) {
|
|
102
|
-
return true;
|
|
103
|
-
}
|
|
104
|
-
throw new Error(`Path exists but is not a file: ${this.path}`);
|
|
105
|
-
}
|
|
106
|
-
case "directory": {
|
|
107
|
-
if (stats.isDirectory()) {
|
|
108
|
-
return true;
|
|
109
|
-
}
|
|
110
|
-
throw new Error(`Path exists but is not a directory: ${this.path}`);
|
|
111
|
-
}
|
|
112
|
-
default: {
|
|
113
|
-
throw new Error("Invalid path type constraint");
|
|
114
|
-
}
|
|
115
|
-
}
|
|
116
|
-
};
|
|
117
|
-
|
|
118
|
-
Path.prototype.existsAsFileSync = function (): boolean {
|
|
119
|
-
return this.existsSync({ mustBe: "file" });
|
|
120
|
-
};
|
|
121
|
-
|
|
122
|
-
Path.prototype.existsAsDirSync = function (): boolean {
|
|
123
|
-
return this.existsSync({ mustBe: "directory" });
|
|
124
|
-
};
|
|
125
|
-
|
|
126
|
-
Path.prototype.mkdirSync = function (
|
|
127
|
-
options?: Parameters<typeof mkdirSync>[1],
|
|
128
|
-
): Path {
|
|
129
|
-
const optionsObject = (() => {
|
|
130
|
-
if (typeof options === "string" || typeof options === "number") {
|
|
131
|
-
return { mode: options };
|
|
132
|
-
}
|
|
133
|
-
return options ?? {};
|
|
134
|
-
})();
|
|
135
|
-
mkdirSync(this.path, { recursive: true, ...optionsObject });
|
|
136
|
-
return this;
|
|
137
|
-
};
|
|
138
|
-
|
|
139
|
-
Path.prototype.cpSync = function (
|
|
140
|
-
destination: string | URL | Path,
|
|
141
|
-
options?: Parameters<typeof cpSync>[2],
|
|
142
|
-
): Path {
|
|
143
|
-
cpSync(this.path, new Path(destination).path, options);
|
|
144
|
-
return new Path(destination);
|
|
145
|
-
};
|
|
146
|
-
|
|
147
|
-
Path.prototype.renameSync = function (destination: string | URL | Path): void {
|
|
148
|
-
renameSync(this.path, new Path(destination).path);
|
|
149
|
-
};
|
|
150
|
-
|
|
151
|
-
Path.prototype.rmSync = function (
|
|
152
|
-
options?: Parameters<typeof rmSync>[1],
|
|
153
|
-
): void {
|
|
154
|
-
rmSync(this.path, options);
|
|
155
|
-
};
|
|
156
|
-
|
|
157
|
-
Path.prototype.rmDirSync = function (): void {
|
|
158
|
-
rmdirSync(this.path);
|
|
159
|
-
};
|
|
160
|
-
|
|
161
|
-
Path.prototype.rm_rfSync = function (
|
|
162
|
-
options?: Parameters<typeof rmSync>[1],
|
|
163
|
-
): void {
|
|
164
|
-
this.rmSync({ recursive: true, force: true, ...(options ?? {}) });
|
|
165
|
-
};
|
|
166
|
-
|
|
167
|
-
Path.prototype.readSync = function () {
|
|
168
|
-
/** @ts-expect-error ts(2683) */
|
|
169
|
-
return readFileSync(this.path);
|
|
170
|
-
} as typeof readFileSyncType;
|
|
171
|
-
|
|
172
|
-
Path.prototype.readTextSync = function (): string {
|
|
173
|
-
return readFileSync(this.path, "utf-8");
|
|
174
|
-
};
|
|
175
|
-
|
|
176
|
-
Path.prototype.readJSONSync = function <T>(options?: { fallback?: T }): T {
|
|
177
|
-
try {
|
|
178
|
-
return JSON.parse(this.readTextSync());
|
|
179
|
-
} catch (e) {
|
|
180
|
-
if (
|
|
181
|
-
(e as { code?: string }).code === "ENOENT" &&
|
|
182
|
-
options &&
|
|
183
|
-
"fallback" in options
|
|
184
|
-
) {
|
|
185
|
-
return options.fallback as T;
|
|
186
|
-
}
|
|
187
|
-
throw e;
|
|
188
|
-
}
|
|
189
|
-
};
|
|
190
|
-
|
|
191
|
-
Path.prototype.appendFileSync = function (
|
|
192
|
-
data: Parameters<typeof appendFileSync>[1],
|
|
193
|
-
options?: Parameters<typeof appendFileSync>[2],
|
|
194
|
-
): Path {
|
|
195
|
-
appendFileSync(this.path, data, options);
|
|
196
|
-
return this;
|
|
197
|
-
};
|
|
198
|
-
|
|
199
|
-
Path.prototype.writeSync = function (
|
|
200
|
-
data: Parameters<typeof writeFileSync>[1],
|
|
201
|
-
options?: Parameters<typeof writeFileSync>[2],
|
|
202
|
-
): Path {
|
|
203
|
-
this.parent.mkdirSync();
|
|
204
|
-
writeFileSync(this.path, data, options);
|
|
205
|
-
return this;
|
|
206
|
-
};
|
|
207
|
-
|
|
208
|
-
Path.prototype.writeJSONSync = function <T>(
|
|
209
|
-
data: T,
|
|
210
|
-
replacer: Parameters<typeof JSON.stringify>[1] = null,
|
|
211
|
-
space: Parameters<typeof JSON.stringify>[2] = " ",
|
|
212
|
-
): Path {
|
|
213
|
-
this.parent.mkdirSync();
|
|
214
|
-
this.writeSync(JSON.stringify(data, replacer, space));
|
|
215
|
-
return this;
|
|
216
|
-
};
|
|
217
|
-
|
|
218
|
-
/** @ts-expect-error ts(2322): Wrangle types */
|
|
219
|
-
Path.prototype.readDirSync = function (options) {
|
|
220
|
-
// biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.
|
|
221
|
-
return readdirSync(this.path, options as any);
|
|
222
|
-
};
|
|
223
|
-
|
|
224
|
-
Path.prototype.symlinkSync = function (
|
|
225
|
-
target: string | URL | Path,
|
|
226
|
-
type?: Parameters<typeof symlinkSync>[2],
|
|
227
|
-
): Path {
|
|
228
|
-
const targetPath = new Path(target);
|
|
229
|
-
symlinkSync(
|
|
230
|
-
this.path,
|
|
231
|
-
targetPath.path,
|
|
232
|
-
type as Exclude<Parameters<typeof symlinkSync>[2], undefined>, // 🤷
|
|
233
|
-
);
|
|
234
|
-
return targetPath;
|
|
235
|
-
};
|
|
236
|
-
|
|
237
|
-
Path.prototype.realpathSync = function (): Path {
|
|
238
|
-
return new Path(realpathSync(this.path));
|
|
239
|
-
};
|
|
240
|
-
|
|
241
|
-
/** @ts-expect-error ts(2322): Wrangle types */
|
|
242
|
-
Path.prototype.statSync = function (
|
|
243
|
-
options?: Parameters<typeof statSync>[1],
|
|
244
|
-
): ReturnType<typeof statSync> {
|
|
245
|
-
return statSync(this.path, options);
|
|
246
|
-
};
|
|
247
|
-
|
|
248
|
-
/** @ts-expect-error ts(2322): Wrangle types */
|
|
249
|
-
Path.prototype.lstatSync = function (
|
|
250
|
-
options?: Parameters<typeof lstatSync>[1],
|
|
251
|
-
): ReturnType<typeof lstatSync> {
|
|
252
|
-
return lstatSync(this.path, options);
|
|
253
|
-
};
|
|
1
|
+
export { PathSync } from "./PathSync";
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
// Note: this file is `.ts` rather than `.d.ts` to ensure it ends up in the `tsc` output.
|
|
2
2
|
|
|
3
|
+
import type { Abortable } from "node:events";
|
|
3
4
|
import type {
|
|
4
5
|
BigIntStats,
|
|
5
6
|
Dirent,
|
|
7
|
+
Mode,
|
|
6
8
|
ObjectEncodingOptions,
|
|
7
9
|
StatSyncOptions,
|
|
8
10
|
Stats,
|
|
@@ -30,6 +32,15 @@ export declare function readFileSyncType(
|
|
|
30
32
|
| BufferEncoding
|
|
31
33
|
| null,
|
|
32
34
|
): string | NonSharedBuffer;
|
|
35
|
+
export type WriteFileOptions =
|
|
36
|
+
| (ObjectEncodingOptions &
|
|
37
|
+
Abortable & {
|
|
38
|
+
mode?: Mode | undefined;
|
|
39
|
+
flag?: string | undefined;
|
|
40
|
+
flush?: boolean | undefined;
|
|
41
|
+
})
|
|
42
|
+
| BufferEncoding
|
|
43
|
+
| null;
|
|
33
44
|
|
|
34
45
|
export declare function readDirSyncType(
|
|
35
46
|
options?:
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 3,
|
|
3
|
-
"sources": ["../../../../src/Path.ts"],
|
|
4
|
-
"sourcesContent": ["import {\n appendFile,\n cp,\n lstat,\n mkdir,\n mkdtemp,\n readdir,\n readFile,\n realpath,\n rename,\n rm,\n rmdir,\n stat,\n symlink,\n writeFile,\n} from \"node:fs/promises\";\nimport { homedir, tmpdir } from \"node:os\";\nimport { basename, dirname, extname, join } from \"node:path\";\nimport { cwd } from \"node:process\";\nimport { Readable } from \"node:stream\";\nimport { fileURLToPath, pathToFileURL } from \"node:url\";\nimport {\n xdgCache,\n xdgConfig,\n xdgData,\n xdgRuntime,\n xdgState,\n} from \"xdg-basedir\";\nimport type {\n lstatType,\n readDirType,\n readFileType,\n statType,\n} from \"./modifiedNodeTypes\";\n\n// Note that (non-static) functions in this file are defined using `function(\u2026)\n// { \u2026 }` rather than arrow functions, specifically because we want `this` to\n// operate on the `Path` instance.\n\ntype WritableData = Parameters<typeof writeFile>[1] | ReadableStream | Response;\nasync function wrangleWritableData(\n data: WritableData | Promise<WritableData>,\n): Promise<Parameters<typeof writeFile>[1]> {\n data = await data;\n if (data instanceof Response) {\n data = data.body ? Readable.fromWeb(data.body) : new Uint8Array(0);\n }\n if (data instanceof ReadableStream) {\n data = Readable.fromWeb(data);\n }\n return data;\n}\n\nexport enum ResolutionPrefix {\n Absolute = \"absolute\",\n Relative = \"relative\",\n Bare = \"bare\",\n}\n\nfunction resolutionPrefix(pathString: string): ResolutionPrefix {\n if (pathString.startsWith(\"/\")) {\n return ResolutionPrefix.Absolute;\n } else if (pathString.startsWith(\"./\")) {\n return ResolutionPrefix.Relative;\n } else if (pathString.startsWith(\"../\")) {\n return ResolutionPrefix.Relative;\n } else if (pathString === \".\") {\n return ResolutionPrefix.Relative;\n } else if (pathString === \"..\") {\n return ResolutionPrefix.Relative;\n }\n return ResolutionPrefix.Bare;\n}\n\nexport class Path {\n // @ts-expect-error ts(2564): False positive. https://github.com/microsoft/TypeScript/issues/32194\n #path: string;\n /**\n * If `path` is a string starting with `file:///`, it will be parsed as a file URL.\n */\n constructor(path: string | URL | Path) {\n const s = Path.#pathlikeToString(path);\n this.#setNormalizedPath(s);\n }\n\n static fromString(s: string): Path {\n if (typeof s !== \"string\") {\n throw new Error(\n \"Invalid argument to `Path.fromString(\u2026)` \u2014 expected a string.\",\n );\n }\n return new Path(s);\n }\n\n get resolutionPrefix(): ResolutionPrefix {\n return resolutionPrefix(this.#path);\n }\n\n /**\n * Similar to `new URL(path, base)`, but accepting and returning `Path` objects.\n * Note that `base` must be one of:\n *\n * - a valid second argument to `new URL(\u2026)`.\n * - a `Path` representing an absolute path.\n *\n */\n static resolve(path: string | URL | Path, base: string | URL | Path): Path {\n const baseURL = (() => {\n if (!(base instanceof Path)) {\n if (typeof base === \"string\" && !base.startsWith(\"file://\")) {\n return pathToFileURL(base);\n }\n return base;\n }\n if (!base.isAbsolutePath()) {\n throw new Error(\n \"The `base` arg to `Path.resolve(\u2026)` must be an absolute path.\",\n );\n }\n return pathToFileURL(base.#path);\n })();\n return new Path(new URL(Path.#pathlikeToString(path), baseURL));\n }\n\n static #pathlikeToString(path: string | URL | Path): string {\n if (path instanceof Path) {\n return path.#path;\n }\n if (path instanceof URL) {\n return fileURLToPath(path);\n }\n if (typeof path === \"string\") {\n // TODO: allow turning off this heuristic?\n if (path.startsWith(\"file:///\")) {\n return fileURLToPath(path);\n }\n return path;\n }\n throw new Error(\"Invalid path\");\n }\n\n // Preserves the `ResolutionPrefix` status when possible.\n #setNormalizedPath(path: string): void {\n const prefix = resolutionPrefix(path);\n this.#path = join(path);\n if (prefix === ResolutionPrefix.Relative && !this.#path.startsWith(\".\")) {\n // We don't have to handle the case of `\".\"`, as it already starts with `\".\"`\n this.#path = `./${this.#path}`;\n }\n }\n\n isAbsolutePath(): boolean {\n return this.resolutionPrefix === ResolutionPrefix.Absolute;\n }\n\n toFileURL(): URL {\n if (!this.isAbsolutePath()) {\n throw new Error(\n \"Tried to convert to file URL when the path is not absolute.\",\n );\n }\n return pathToFileURL(this.#path);\n }\n\n /**\n * The `Path` can have a trailing slash, indicating that it represents a\n * directory. (If there is no trailing slash, it can represent either a file\n * or a directory.)\n *\n * Some operations will refuse to treat a directory path as a file path. This\n * function identifies such paths.\n */\n hasTrailingSlash(): boolean {\n // TODO: handle Windows semantically\n return this.#path.endsWith(\"/\");\n }\n\n /**\n * Toggles or sets a trailing slash as specified.\n * If the path is `/`, it will always be left as-is.\n */\n // Similar convention to:\n // https://developer.mozilla.org/en-US/docs/Web/API/DOMTokenList/toggle Most\n // use cases will probably use the `force` parameters, but supporting the\n // \"toggle\" use case is easy to implement and hopefully will make the name\n // and API more familiar to web devs.\n toggleTrailingSlash(force?: boolean): Path {\n if (this.#path === \"/\") {\n return this;\n }\n const wantTrailingSlash = force ?? !this.hasTrailingSlash();\n if (wantTrailingSlash) {\n return this.hasTrailingSlash() ? this : this.join(\"./\");\n } else {\n return this.hasTrailingSlash() ? new Path(this.#path.slice(0, -1)) : this;\n }\n }\n\n /**\n * Same as `.toString()`, but more concise.\n */\n get path() {\n return this.#path;\n }\n\n toString(): string {\n return this.#path;\n }\n\n /** Constructs a new path by appending the given path segments.\n * This follows `node` semantics for absolute paths: leading slashes in the given descendant segments are ignored.\n */\n join(...segments: (string | Path)[]): Path {\n const segmentStrings = segments.map((segment) => {\n const s = stringifyIfPath(segment);\n if (resolutionPrefix(s) === ResolutionPrefix.Absolute) {\n throw new Error(\n \"Arguments to `.join(\u2026)` cannot be absolute. Use `.asRelative()` to convert them first if needed.\",\n );\n }\n return s;\n });\n return new Path(join(this.#path, ...segmentStrings));\n }\n\n /**\n * Adjust the prefix to construct a relative path.\n *\n * | Example input | Output |\n * |-----------------|-----------------|\n * | `\"bare\"` | `\"./bare\"` |\n * | `\"./relative\"` | `\"./relative\"` |\n * | `\"../up-first\"` | `\"../up-first\"` |\n * | `\"/absolute\"` | `\"./absolute\"` |\n *\n */\n asRelative(): Path {\n return new Path(`./${this.#path}`);\n }\n\n /**\n * Adjust the prefix to construct an absolute path.\n *\n * | Example input | Output |\n * |-----------------|---------------|\n * | `\"bare\"` | `\"/bare\"` |\n * | `\"./relative\"` | `\"/relative\"` |\n * | `\"../up-first\"` | `\"/up-first\"` |\n * | `\"/absolute\"` | `\"/absolute\"` |\n *\n */\n asAbsolute(): Path {\n return new Path(join(\"/\", this.#path));\n }\n\n /**\n * Adjust the prefix to construct a bare path. Note that this returns `\".\"` if\n * there are no named paths left.\n *\n * | Example input | Output |\n * |-------------------|--------------|\n * | `\"bare\"` | `\"bare\"` |\n * | `\"./relative\" ` | `\"relative\"` |\n * | `\"/absolute\"` | `\"absolute\"` |\n * | `\".\"` | `\".\"` |\n * | `\"down-first/..\"` | `\".\"` |\n * | `\"../up-first\"` | (error) |\n * | `\"..\"` | (error) |\n *\n * Specify `parentTraversalPrefixHandling` in the `options` if you would like\n * to strip or keep resolution prefixes like `../` rather than erroring.\n *\n * | Example input | Output with `{ parentTraversalPrefixHandling: \"strip\" }` |\n * |----------------------|----------------------------------------------------------|\n * | `\"../up-first\"` | `\"up-first\"` |\n * | `\"..\"` | `\".\"` |\n *\n * | Example input | Output with `{ parentTraversalPrefixHandling: \"keep\" }` |\n * |----------------------|---------------------------------------------------------|\n * | `\"../up-first\"` | `\"../up-first\"` |\n * | `\"..\"` | `\"..\"` |\n *\n * If you need the output to start with a named component and return values\n * like `.`, `..`, `../`, or `../\u2026` are not okay, pass\n * `requireNamedComponentPrefix: true`. This is useful if the path represents\n * an `npm`-style package name (e.g. `\"typescript\"`, `\"@biomejs/biome\"`).\n *\n */\n asBare(options?: {\n parentTraversalPrefixHandling?: \"error\" | \"strip\" | \"keep\";\n requireNamedComponentPrefix?: boolean;\n }): Path {\n const path = new Path(join(\".\", this.#path));\n if (!path.#path.startsWith(\"../\") && path.#path !== \"..\") {\n if (\n options?.requireNamedComponentPrefix &&\n path.resolutionPrefix === ResolutionPrefix.Relative\n ) {\n throw new Error(\"Output does not start with a named component.\");\n }\n return path;\n }\n const parentTraversalHandling =\n options?.parentTraversalPrefixHandling ?? \"error\";\n switch (parentTraversalHandling) {\n case \"error\": {\n throw new Error(\n 'Converting path to a bare path resulted in a `..` traversal prefix. Pass `\"strip\"` or `\"keep\"` as the `parentTraversalHandling` option to avoid an error.',\n );\n }\n case \"strip\": {\n let newPath = path.#path.replace(/^(\\.\\.\\/)+/, \"\");\n if ([\"\", \"..\"].includes(newPath)) {\n newPath = \".\";\n }\n const output = new Path(newPath);\n if (\n options?.requireNamedComponentPrefix &&\n output.resolutionPrefix === ResolutionPrefix.Relative\n ) {\n throw new Error(\"Output does not start with a named component.\");\n }\n return new Path(newPath);\n }\n case \"keep\": {\n if (options?.requireNamedComponentPrefix) {\n throw new Error(\"Output does not start with a named component.\");\n }\n return path;\n }\n }\n }\n\n extendBasename(suffix: string): Path {\n const joinedSuffix = join(suffix);\n if (joinedSuffix !== basename(joinedSuffix)) {\n throw new Error(\"Invalid suffix to extend file name.\");\n }\n // TODO: join basename and dirname instead?\n return new Path(this.#path + joinedSuffix);\n }\n\n get parent(): Path {\n return new Path(dirname(this.#path));\n }\n\n // Normally I'd stick with `node`'s name, but I think `.dirname` is a\n // particularly poor name. So we support `.dirname` for discovery but mark it\n // as deprecated, even if it will never be removed.\n /** @deprecated Alias for `.parent`. */\n get dirname(): Path {\n return this.parent;\n }\n\n get basename(): Path {\n return new Path(basename(this.#path));\n }\n\n get extension(): string {\n mustNotHaveTrailingSlash(this);\n return extname(this.#path);\n }\n\n // Normally I'd stick with `node`'s name, but I think `.extname` is a\n // particularly poor name. So we support `.extname` for discovery but mark it\n // as deprecated, even if it will never be removed.\n /** @deprecated Alias for `.extension`. */\n get extname(): string {\n return this.extension;\n }\n\n // TODO: find a neat way to dedup with the sync version?\n async exists(constraints?: {\n mustBe: \"file\" | \"directory\";\n }): Promise<boolean> {\n if (constraints?.mustBe === \"file\") {\n mustNotHaveTrailingSlash(this);\n }\n let stats: Awaited<ReturnType<typeof stat>>;\n try {\n stats = await stat(this.#path);\n // biome-ignore lint/suspicious/noExplicitAny: TypeScript limitation\n } catch (e: any) {\n if (e.code === \"ENOENT\") {\n return false;\n }\n throw e;\n }\n if (!constraints?.mustBe) {\n return true;\n }\n switch (constraints?.mustBe) {\n case \"file\": {\n if (stats.isFile()) {\n return true;\n }\n throw new Error(`Path exists but is not a file: ${this.#path}`);\n }\n case \"directory\": {\n if (stats.isDirectory()) {\n return true;\n }\n throw new Error(`Path exists but is not a directory: ${this.#path}`);\n }\n default: {\n throw new Error(\"Invalid path type constraint\");\n }\n }\n }\n\n async existsAsFile(): Promise<boolean> {\n return this.exists({ mustBe: \"file\" });\n }\n\n async existsAsDir(): Promise<boolean> {\n return this.exists({ mustBe: \"directory\" });\n }\n\n // I don't think `mkdir` is a great name, but it does match the\n // well-established canonical commandline name. So in this case we keep the\n // awkward abbreviation.\n /** Defaults to `recursive: true`. */\n async mkdir(options?: Parameters<typeof mkdir>[1]): Promise<Path> {\n const optionsObject = (() => {\n if (typeof options === \"string\" || typeof options === \"number\") {\n return { mode: options };\n }\n return options ?? {};\n })();\n await mkdir(this.#path, { recursive: true, ...optionsObject });\n return this;\n }\n\n // TODO: check idempotency semantics when the destination exists and is a folder.\n /** Returns the destination path. */\n async cp(\n destination: string | URL | Path,\n options?: Parameters<typeof cp>[2],\n ): Promise<Path> {\n await cp(this.#path, new Path(destination).#path, options);\n return new Path(destination);\n }\n\n // TODO: check idempotency semantics when the destination exists and is a folder.\n async rename(destination: string | URL | Path): Promise<void> {\n await rename(this.#path, new Path(destination).#path);\n }\n\n /**\n * Create a temporary dir inside the global temp dir for the current user.\n *\n * This can be used with [`await\n * using`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/await_using)\n * to automatically delete the dir when it goes out of scope.\n *\n * {\n * await using tempDir = await Path.makeTempDir();\n * // Temporary dir exists while we're inside this block.\n * }\n * // Temporary dir has now been deleted.\n *\n * Note that (due to the semantics of JS runtime implementations) this does\n * not delete the temp dir if the process calls `exit(\u2026)` before the `using`\n * goes out of scope.\n *\n * */\n static async makeTempDir(prefix?: string): Promise<AsyncDisposablePath> {\n return new AsyncDisposablePath(\n await mkdtemp(new Path(tmpdir()).join(prefix ?? \"js-temp-\").toString()),\n );\n }\n\n async rm(options?: Parameters<typeof rm>[1]): Promise<void> {\n await rm(this.#path, options);\n }\n\n async rmDir(): Promise<void> {\n await rmdir(this.#path);\n }\n\n /**\n * Equivalent to:\n *\n * .rm({ recursive: true, force: true, ...(options ?? {}) })\n *\n */\n async rm_rf(options?: Parameters<typeof rm>[1]): Promise<void> {\n await this.rm({ recursive: true, force: true, ...(options ?? {}) });\n }\n\n read: typeof readFileType = (options) =>\n // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n readFile(this.#path, options as any) as any;\n\n async readText(): Promise<string> {\n return readFile(this.#path, \"utf-8\");\n }\n\n /**\n * Reads JSON from the given file and parses it. No validation is performed\n * (beyond JSON parsing).\n *\n * An optional `fallback` value can be specified. It will be used if (and only\n * if) the file does not exist.\n *\n */\n\n // biome-ignore lint/suspicious/noExplicitAny: Allow a default of `any` to match `JSON.parse(\u2026)`.\n async readJSON<T = any>(options?: { fallback?: T }): Promise<T> {\n try {\n return JSON.parse(await this.readText());\n } catch (e) {\n if (\n (e as { code?: string }).code === \"ENOENT\" &&\n options &&\n \"fallback\" in options\n ) {\n return options.fallback as T;\n }\n throw e;\n }\n }\n\n /**\n * Returns the original `Path` (for chaining).\n */\n async appendFile(\n data: Parameters<typeof appendFile>[1],\n options?: Parameters<typeof appendFile>[2],\n ): Promise<Path> {\n await appendFile(this.#path, data, options);\n return this;\n }\n\n /** Creates intermediate directories if they do not exist.\n *\n * Returns the original `Path` (for chaining).\n */\n async write(\n data: WritableData | Promise<WritableData>,\n options?: Parameters<typeof writeFile>[2],\n ): Promise<Path> {\n await this.parent.mkdir();\n await writeFile(this.#path, await wrangleWritableData(data), options);\n return this;\n }\n\n /**\n * If only `data` is provided, this is equivalent to:\n *\n * .write(JSON.stringify(data, null, \" \"));\n *\n * `replacer` and `space` can also be specified, making this equivalent to:\n *\n * .write(JSON.stringify(data, replacer, space));\n *\n * Returns the original `Path` (for chaining).\n */\n async writeJSON<T>(\n data: T,\n replacer: Parameters<typeof JSON.stringify>[1] = null,\n space: Parameters<typeof JSON.stringify>[2] = \" \",\n ): Promise<Path> {\n await this.write(JSON.stringify(data, replacer, space));\n return this;\n }\n\n // Normally we'd add a `@deprecated` alias named `.readdir`, but that would\n // differ only by capitalization of a single non-leading character. This can\n // be a bit confusing, especially when autocompleting. So for this function in\n // particular we don't include an alias.\n readDir: typeof readDirType = (options) =>\n // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n readdir(this.#path, options as any) as any;\n\n /** Returns the destination path. */\n async symlink(\n target: string | URL | Path,\n type?: Parameters<typeof symlink>[2],\n ): Promise<Path> {\n const targetPath = new Path(target);\n await symlink(\n this.path,\n targetPath.path,\n type as Exclude<Parameters<typeof symlink>[2], undefined>, // \uD83E\uDD37\n );\n return targetPath;\n }\n\n // I don't think `lstat` is a great name, but it does match the\n // well-established canonical commandline name. So in this case we keep the\n // name instead of using `realPath`.\n //\n // Note: There are no options in our API, because the only option is an\n // encoding. We set the encoding to construct the returned `Path`.\n async realpath(): Promise<Path> {\n return new Path(await realpath(this.#path, \"utf-8\"));\n }\n\n // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n stat: typeof statType = (...options) => stat(this.#path, ...options) as any;\n\n // I don't think `lstat` is a great name, but it does match the\n // well-established canonical system call. So in this case we keep the\n // awkward abbreviation.\n lstat: typeof lstatType = (...options) =>\n // biome-ignore lint/suspicious/noExplicitAny: Needed to wrangle the types.\n lstat(this.#path, ...options) as any;\n\n static get homedir(): Path {\n return new Path(homedir());\n }\n\n /**\n * Get the current working directory as a path. Always includes a trailing slash.\n * Note that this computes the `cwd` from fresh every time, in case it has changed for the current process.\n */\n static get cwd(): Path {\n return new Path(cwd()).toggleTrailingSlash(true);\n }\n\n static xdg = {\n cache: new Path(xdgCache ?? Path.homedir.join(\".cache\")),\n config: new Path(xdgConfig ?? Path.homedir.join(\".config\")),\n data: new Path(xdgData ?? Path.homedir.join(\".local/share\")),\n state: new Path(xdgState ?? Path.homedir.join(\".local/state\")),\n /**\n * {@link Path.xdg.runtime} does not have a default value. Consider\n * {@link Path.xdg.runtimeWithStateFallback} if you need a fallback but do not have a particular fallback in mind.\n */\n runtime: xdgRuntime ? new Path(xdgRuntime) : undefined,\n runtimeWithStateFallback: xdgRuntime\n ? new Path(xdgRuntime)\n : new Path(xdgState ?? Path.homedir.join(\".local/state\")),\n };\n\n /** Chainable function to print the path. Prints the same as:\n *\n * if (args.length > 0) {\n * console.log(...args);\n * }\n * console.log(this.path);\n *\n */\n // biome-ignore lint/suspicious/noExplicitAny: This is the correct type, based on `console.log(\u2026)`.\n debugPrint(...args: any[]): Path {\n if (args.length > 0) {\n console.log(...args);\n }\n console.log(this.#path);\n return this;\n }\n}\n\nexport class AsyncDisposablePath extends Path {\n async [Symbol.asyncDispose]() {\n await this.rm_rf();\n }\n}\n\n/**\n * This function is useful to serialize any `Path`s in a structure to pass on to\n * functions that do not know about the `Path` class, e.g.\n *\n * function process(args: (string | Path)[]) {\n * const argsAsStrings = args.map(stringifyIfPath);\n * }\n *\n */\nexport function stringifyIfPath<T>(value: T | Path): T | string {\n if (value instanceof Path) {\n return value.toString();\n }\n return value;\n}\n\nexport function mustNotHaveTrailingSlash(path: Path): void {\n if (path.hasTrailingSlash()) {\n throw new Error(\n \"Path ends with a slash, which cannot be treated as a file.\",\n );\n }\n}\n"],
|
|
5
|
-
"mappings": ";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,SAAS,cAAc;AAChC,SAAS,UAAU,SAAS,SAAS,YAAY;AACjD,SAAS,WAAW;AACpB,SAAS,gBAAgB;AACzB,SAAS,eAAe,qBAAqB;AAC7C;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAaP,eAAe,oBACb,MAC0C;AAC1C,SAAO,MAAM;AACb,MAAI,gBAAgB,UAAU;AAC5B,WAAO,KAAK,OAAO,SAAS,QAAQ,KAAK,IAAI,IAAI,IAAI,WAAW,CAAC;AAAA,EACnE;AACA,MAAI,gBAAgB,gBAAgB;AAClC,WAAO,SAAS,QAAQ,IAAI;AAAA,EAC9B;AACA,SAAO;AACT;AAEO,IAAK,mBAAL,kBAAKA,sBAAL;AACL,EAAAA,kBAAA,cAAW;AACX,EAAAA,kBAAA,cAAW;AACX,EAAAA,kBAAA,UAAO;AAHG,SAAAA;AAAA,GAAA;AAMZ,SAAS,iBAAiB,YAAsC;AAC9D,MAAI,WAAW,WAAW,GAAG,GAAG;AAC9B,WAAO;AAAA,EACT,WAAW,WAAW,WAAW,IAAI,GAAG;AACtC,WAAO;AAAA,EACT,WAAW,WAAW,WAAW,KAAK,GAAG;AACvC,WAAO;AAAA,EACT,WAAW,eAAe,KAAK;AAC7B,WAAO;AAAA,EACT,WAAW,eAAe,MAAM;AAC9B,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAEO,IAAM,OAAN,MAAM,MAAK;AAAA;AAAA,EAEhB;AAAA;AAAA;AAAA;AAAA,EAIA,YAAY,MAA2B;AACrC,UAAM,IAAI,MAAK,kBAAkB,IAAI;AACrC,SAAK,mBAAmB,CAAC;AAAA,EAC3B;AAAA,EAEA,OAAO,WAAW,GAAiB;AACjC,QAAI,OAAO,MAAM,UAAU;AACzB,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AACA,WAAO,IAAI,MAAK,CAAC;AAAA,EACnB;AAAA,EAEA,IAAI,mBAAqC;AACvC,WAAO,iBAAiB,KAAK,KAAK;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAO,QAAQ,MAA2B,MAAiC;AACzE,UAAM,WAAW,MAAM;AACrB,UAAI,EAAE,gBAAgB,QAAO;AAC3B,YAAI,OAAO,SAAS,YAAY,CAAC,KAAK,WAAW,SAAS,GAAG;AAC3D,iBAAO,cAAc,IAAI;AAAA,QAC3B;AACA,eAAO;AAAA,MACT;AACA,UAAI,CAAC,KAAK,eAAe,GAAG;AAC1B,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AACA,aAAO,cAAc,KAAK,KAAK;AAAA,IACjC,GAAG;AACH,WAAO,IAAI,MAAK,IAAI,IAAI,MAAK,kBAAkB,IAAI,GAAG,OAAO,CAAC;AAAA,EAChE;AAAA,EAEA,OAAO,kBAAkB,MAAmC;AAC1D,QAAI,gBAAgB,OAAM;AACxB,aAAO,KAAK;AAAA,IACd;AACA,QAAI,gBAAgB,KAAK;AACvB,aAAO,cAAc,IAAI;AAAA,IAC3B;AACA,QAAI,OAAO,SAAS,UAAU;AAE5B,UAAI,KAAK,WAAW,UAAU,GAAG;AAC/B,eAAO,cAAc,IAAI;AAAA,MAC3B;AACA,aAAO;AAAA,IACT;AACA,UAAM,IAAI,MAAM,cAAc;AAAA,EAChC;AAAA;AAAA,EAGA,mBAAmB,MAAoB;AACrC,UAAM,SAAS,iBAAiB,IAAI;AACpC,SAAK,QAAQ,KAAK,IAAI;AACtB,QAAI,WAAW,6BAA6B,CAAC,KAAK,MAAM,WAAW,GAAG,GAAG;AAEvE,WAAK,QAAQ,KAAK,KAAK,KAAK;AAAA,IAC9B;AAAA,EACF;AAAA,EAEA,iBAA0B;AACxB,WAAO,KAAK,qBAAqB;AAAA,EACnC;AAAA,EAEA,YAAiB;AACf,QAAI,CAAC,KAAK,eAAe,GAAG;AAC1B,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AACA,WAAO,cAAc,KAAK,KAAK;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,mBAA4B;AAE1B,WAAO,KAAK,MAAM,SAAS,GAAG;AAAA,EAChC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,oBAAoB,OAAuB;AACzC,QAAI,KAAK,UAAU,KAAK;AACtB,aAAO;AAAA,IACT;AACA,UAAM,oBAAoB,SAAS,CAAC,KAAK,iBAAiB;AAC1D,QAAI,mBAAmB;AACrB,aAAO,KAAK,iBAAiB,IAAI,OAAO,KAAK,KAAK,IAAI;AAAA,IACxD,OAAO;AACL,aAAO,KAAK,iBAAiB,IAAI,IAAI,MAAK,KAAK,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI;AAAA,IACvE;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,OAAO;AACT,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,WAAmB;AACjB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKA,QAAQ,UAAmC;AACzC,UAAM,iBAAiB,SAAS,IAAI,CAAC,YAAY;AAC/C,YAAM,IAAI,gBAAgB,OAAO;AACjC,UAAI,iBAAiB,CAAC,MAAM,2BAA2B;AACrD,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AACA,aAAO;AAAA,IACT,CAAC;AACD,WAAO,IAAI,MAAK,KAAK,KAAK,OAAO,GAAG,cAAc,CAAC;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,aAAmB;AACjB,WAAO,IAAI,MAAK,KAAK,KAAK,KAAK,EAAE;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,aAAmB;AACjB,WAAO,IAAI,MAAK,KAAK,KAAK,KAAK,KAAK,CAAC;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmCA,OAAO,SAGE;AACP,UAAM,OAAO,IAAI,MAAK,KAAK,KAAK,KAAK,KAAK,CAAC;AAC3C,QAAI,CAAC,KAAK,MAAM,WAAW,KAAK,KAAK,KAAK,UAAU,MAAM;AACxD,UACE,SAAS,+BACT,KAAK,qBAAqB,2BAC1B;AACA,cAAM,IAAI,MAAM,+CAA+C;AAAA,MACjE;AACA,aAAO;AAAA,IACT;AACA,UAAM,0BACJ,SAAS,iCAAiC;AAC5C,YAAQ,yBAAyB;AAAA,MAC/B,KAAK,SAAS;AACZ,cAAM,IAAI;AAAA,UACR;AAAA,QACF;AAAA,MACF;AAAA,MACA,KAAK,SAAS;AACZ,YAAI,UAAU,KAAK,MAAM,QAAQ,cAAc,EAAE;AACjD,YAAI,CAAC,IAAI,IAAI,EAAE,SAAS,OAAO,GAAG;AAChC,oBAAU;AAAA,QACZ;AACA,cAAM,SAAS,IAAI,MAAK,OAAO;AAC/B,YACE,SAAS,+BACT,OAAO,qBAAqB,2BAC5B;AACA,gBAAM,IAAI,MAAM,+CAA+C;AAAA,QACjE;AACA,eAAO,IAAI,MAAK,OAAO;AAAA,MACzB;AAAA,MACA,KAAK,QAAQ;AACX,YAAI,SAAS,6BAA6B;AACxC,gBAAM,IAAI,MAAM,+CAA+C;AAAA,QACjE;AACA,eAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AAAA,EAEA,eAAe,QAAsB;AACnC,UAAM,eAAe,KAAK,MAAM;AAChC,QAAI,iBAAiB,SAAS,YAAY,GAAG;AAC3C,YAAM,IAAI,MAAM,qCAAqC;AAAA,IACvD;AAEA,WAAO,IAAI,MAAK,KAAK,QAAQ,YAAY;AAAA,EAC3C;AAAA,EAEA,IAAI,SAAe;AACjB,WAAO,IAAI,MAAK,QAAQ,KAAK,KAAK,CAAC;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,UAAgB;AAClB,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,WAAiB;AACnB,WAAO,IAAI,MAAK,SAAS,KAAK,KAAK,CAAC;AAAA,EACtC;AAAA,EAEA,IAAI,YAAoB;AACtB,6BAAyB,IAAI;AAC7B,WAAO,QAAQ,KAAK,KAAK;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,UAAkB;AACpB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA,EAGA,MAAM,OAAO,aAEQ;AACnB,QAAI,aAAa,WAAW,QAAQ;AAClC,+BAAyB,IAAI;AAAA,IAC/B;AACA,QAAI;AACJ,QAAI;AACF,cAAQ,MAAM,KAAK,KAAK,KAAK;AAAA,IAE/B,SAAS,GAAQ;AACf,UAAI,EAAE,SAAS,UAAU;AACvB,eAAO;AAAA,MACT;AACA,YAAM;AAAA,IACR;AACA,QAAI,CAAC,aAAa,QAAQ;AACxB,aAAO;AAAA,IACT;AACA,YAAQ,aAAa,QAAQ;AAAA,MAC3B,KAAK,QAAQ;AACX,YAAI,MAAM,OAAO,GAAG;AAClB,iBAAO;AAAA,QACT;AACA,cAAM,IAAI,MAAM,kCAAkC,KAAK,KAAK,EAAE;AAAA,MAChE;AAAA,MACA,KAAK,aAAa;AAChB,YAAI,MAAM,YAAY,GAAG;AACvB,iBAAO;AAAA,QACT;AACA,cAAM,IAAI,MAAM,uCAAuC,KAAK,KAAK,EAAE;AAAA,MACrE;AAAA,MACA,SAAS;AACP,cAAM,IAAI,MAAM,8BAA8B;AAAA,MAChD;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,eAAiC;AACrC,WAAO,KAAK,OAAO,EAAE,QAAQ,OAAO,CAAC;AAAA,EACvC;AAAA,EAEA,MAAM,cAAgC;AACpC,WAAO,KAAK,OAAO,EAAE,QAAQ,YAAY,CAAC;AAAA,EAC5C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,MAAM,SAAsD;AAChE,UAAM,iBAAiB,MAAM;AAC3B,UAAI,OAAO,YAAY,YAAY,OAAO,YAAY,UAAU;AAC9D,eAAO,EAAE,MAAM,QAAQ;AAAA,MACzB;AACA,aAAO,WAAW,CAAC;AAAA,IACrB,GAAG;AACH,UAAM,MAAM,KAAK,OAAO,EAAE,WAAW,MAAM,GAAG,cAAc,CAAC;AAC7D,WAAO;AAAA,EACT;AAAA;AAAA;AAAA,EAIA,MAAM,GACJ,aACA,SACe;AACf,UAAM,GAAG,KAAK,OAAO,IAAI,MAAK,WAAW,EAAE,OAAO,OAAO;AACzD,WAAO,IAAI,MAAK,WAAW;AAAA,EAC7B;AAAA;AAAA,EAGA,MAAM,OAAO,aAAiD;AAC5D,UAAM,OAAO,KAAK,OAAO,IAAI,MAAK,WAAW,EAAE,KAAK;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBA,aAAa,YAAY,QAA+C;AACtE,WAAO,IAAI;AAAA,MACT,MAAM,QAAQ,IAAI,MAAK,OAAO,CAAC,EAAE,KAAK,UAAU,UAAU,EAAE,SAAS,CAAC;AAAA,IACxE;AAAA,EACF;AAAA,EAEA,MAAM,GAAG,SAAmD;AAC1D,UAAM,GAAG,KAAK,OAAO,OAAO;AAAA,EAC9B;AAAA,EAEA,MAAM,QAAuB;AAC3B,UAAM,MAAM,KAAK,KAAK;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,MAAM,SAAmD;AAC7D,UAAM,KAAK,GAAG,EAAE,WAAW,MAAM,OAAO,MAAM,GAAI,WAAW,CAAC,EAAG,CAAC;AAAA,EACpE;AAAA,EAEA,OAA4B,CAAC;AAAA;AAAA,IAE3B,SAAS,KAAK,OAAO,OAAc;AAAA;AAAA,EAErC,MAAM,WAA4B;AAChC,WAAO,SAAS,KAAK,OAAO,OAAO;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAM,SAAkB,SAAwC;AAC9D,QAAI;AACF,aAAO,KAAK,MAAM,MAAM,KAAK,SAAS,CAAC;AAAA,IACzC,SAAS,GAAG;AACV,UACG,EAAwB,SAAS,YAClC,WACA,cAAc,SACd;AACA,eAAO,QAAQ;AAAA,MACjB;AACA,YAAM;AAAA,IACR;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,WACJ,MACA,SACe;AACf,UAAM,WAAW,KAAK,OAAO,MAAM,OAAO;AAC1C,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,MACJ,MACA,SACe;AACf,UAAM,KAAK,OAAO,MAAM;AACxB,UAAM,UAAU,KAAK,OAAO,MAAM,oBAAoB,IAAI,GAAG,OAAO;AACpE,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,UACJ,MACA,WAAiD,MACjD,QAA8C,MAC/B;AACf,UAAM,KAAK,MAAM,KAAK,UAAU,MAAM,UAAU,KAAK,CAAC;AACtD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,UAA8B,CAAC;AAAA;AAAA,IAE7B,QAAQ,KAAK,OAAO,OAAc;AAAA;AAAA;AAAA,EAGpC,MAAM,QACJ,QACA,MACe;AACf,UAAM,aAAa,IAAI,MAAK,MAAM;AAClC,UAAM;AAAA,MACJ,KAAK;AAAA,MACL,WAAW;AAAA,MACX;AAAA;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,WAA0B;AAC9B,WAAO,IAAI,MAAK,MAAM,SAAS,KAAK,OAAO,OAAO,CAAC;AAAA,EACrD;AAAA;AAAA,EAGA,OAAwB,IAAI,YAAY,KAAK,KAAK,OAAO,GAAG,OAAO;AAAA;AAAA;AAAA;AAAA,EAKnE,QAA0B,IAAI;AAAA;AAAA,IAE5B,MAAM,KAAK,OAAO,GAAG,OAAO;AAAA;AAAA,EAE9B,WAAW,UAAgB;AACzB,WAAO,IAAI,MAAK,QAAQ,CAAC;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,WAAW,MAAY;AACrB,WAAO,IAAI,MAAK,IAAI,CAAC,EAAE,oBAAoB,IAAI;AAAA,EACjD;AAAA,EAEA,OAAO,MAAM;AAAA,IACX,OAAO,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,QAAQ,CAAC;AAAA,IACvD,QAAQ,IAAI,MAAK,aAAa,MAAK,QAAQ,KAAK,SAAS,CAAC;AAAA,IAC1D,MAAM,IAAI,MAAK,WAAW,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA,IAC3D,OAAO,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7D,SAAS,aAAa,IAAI,MAAK,UAAU,IAAI;AAAA,IAC7C,0BAA0B,aACtB,IAAI,MAAK,UAAU,IACnB,IAAI,MAAK,YAAY,MAAK,QAAQ,KAAK,cAAc,CAAC;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,cAAc,MAAmB;AAC/B,QAAI,KAAK,SAAS,GAAG;AACnB,cAAQ,IAAI,GAAG,IAAI;AAAA,IACrB;AACA,YAAQ,IAAI,KAAK,KAAK;AACtB,WAAO;AAAA,EACT;AACF;AAEO,IAAM,sBAAN,cAAkC,KAAK;AAAA,EAC5C,OAAO,OAAO,YAAY,IAAI;AAC5B,UAAM,KAAK,MAAM;AAAA,EACnB;AACF;AAWO,SAAS,gBAAmB,OAA6B;AAC9D,MAAI,iBAAiB,MAAM;AACzB,WAAO,MAAM,SAAS;AAAA,EACxB;AACA,SAAO;AACT;AAEO,SAAS,yBAAyB,MAAkB;AACzD,MAAI,KAAK,iBAAiB,GAAG;AAC3B,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACF;",
|
|
6
|
-
"names": ["ResolutionPrefix"]
|
|
7
|
-
}
|
package/src/sync/static.ts
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { mkdtempSync } from "node:fs";
|
|
2
|
-
import { tmpdir } from "node:os";
|
|
3
|
-
import { Path } from "../Path";
|
|
4
|
-
|
|
5
|
-
declare module "../Path" {
|
|
6
|
-
namespace Path {
|
|
7
|
-
export function makeTempDirSync(prefix?: string): Path;
|
|
8
|
-
}
|
|
9
|
-
}
|
|
10
|
-
|
|
11
|
-
Path.makeTempDirSync = (prefix?: string): Path =>
|
|
12
|
-
new Path(
|
|
13
|
-
mkdtempSync(new Path(tmpdir()).join(prefix ?? "js-temp-").toString()),
|
|
14
|
-
);
|