deno.land / std@0.224.0 / fs / ensure_symlink.ts

ensure_symlink.ts
View Documentation
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
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.import { dirname } from "../path/dirname.ts";import { resolve } from "../path/resolve.ts";import { ensureDir, ensureDirSync } from "./ensure_dir.ts";import { getFileInfoType } from "./_get_file_info_type.ts";import { toPathString } from "./_to_path_string.ts";
const isWindows = Deno.build.os === "windows";
function resolveSymlinkTarget(target: string | URL, linkName: string | URL) { if (typeof target !== "string") return target; // URL is always absolute path if (typeof linkName === "string") { return resolve(dirname(linkName), target); } else { return new URL(target, linkName); }}
/** * Asynchronously ensures that the link exists, and points to a valid file. If * the directory structure does not exist, it is created. If the link already * exists, it is not modified but error is thrown if it is not point to the * given target. * * Requires the `--allow-read` and `--allow-write` flag. * * @param target The source file path as a string or URL. * @param linkName The destination link path as a string or URL. * @returns A void promise that resolves once the link exists. * * @example * ```ts * import { ensureSymlink } from "https://deno.land/std@$STD_VERSION/fs/ensure_symlink.ts"; * * await ensureSymlink("./folder/targetFile.dat", "./folder/targetFile.link.dat"); * ``` */export async function ensureSymlink( target: string | URL, linkName: string | URL,) { const targetRealPath = resolveSymlinkTarget(target, linkName); const srcStatInfo = await Deno.lstat(targetRealPath); const srcFilePathType = getFileInfoType(srcStatInfo);
await ensureDir(dirname(toPathString(linkName)));
const options: Deno.SymlinkOptions | undefined = isWindows ? { type: srcFilePathType === "dir" ? "dir" : "file", } : undefined;
try { await Deno.symlink(target, linkName, options); } catch (error) { if (!(error instanceof Deno.errors.AlreadyExists)) { throw error; } const linkStatInfo = await Deno.lstat(linkName); if (!linkStatInfo.isSymlink) { const type = getFileInfoType(linkStatInfo); throw new Deno.errors.AlreadyExists( `A '${type}' already exists at the path: ${linkName}`, ); } const linkPath = await Deno.readLink(linkName); const linkRealPath = resolve(linkPath); if (linkRealPath !== targetRealPath) { throw new Deno.errors.AlreadyExists( `A symlink targeting to an undesired path already exists: ${linkName} -> ${linkRealPath}`, ); } }}
/** * Synchronously ensures that the link exists, and points to a valid file. If * the directory structure does not exist, it is created. If the link already * exists, it is not modified but error is thrown if it is not point to the * given target. * * Requires the `--allow-read` and `--allow-write` flag. * * @param target The source file path as a string or URL. * @param linkName The destination link path as a string or URL. * @returns A void value that returns once the link exists. * * @example * ```ts * import { ensureSymlinkSync } from "https://deno.land/std@$STD_VERSION/fs/ensure_symlink.ts"; * * ensureSymlinkSync("./folder/targetFile.dat", "./folder/targetFile.link.dat"); * ``` */export function ensureSymlinkSync( target: string | URL, linkName: string | URL,) { const targetRealPath = resolveSymlinkTarget(target, linkName); const srcStatInfo = Deno.lstatSync(targetRealPath); const srcFilePathType = getFileInfoType(srcStatInfo);
ensureDirSync(dirname(toPathString(linkName)));
const options: Deno.SymlinkOptions | undefined = isWindows ? { type: srcFilePathType === "dir" ? "dir" : "file", } : undefined;
try { Deno.symlinkSync(target, linkName, options); } catch (error) { if (!(error instanceof Deno.errors.AlreadyExists)) { throw error; } const linkStatInfo = Deno.lstatSync(linkName); if (!linkStatInfo.isSymlink) { const type = getFileInfoType(linkStatInfo); throw new Deno.errors.AlreadyExists( `A '${type}' already exists at the path: ${linkName}`, ); } const linkPath = Deno.readLinkSync(linkName); const linkRealPath = resolve(linkPath); if (linkRealPath !== targetRealPath) { throw new Deno.errors.AlreadyExists( `A symlink targeting to an undesired path already exists: ${linkName} -> ${linkRealPath}`, ); } }}
std

Version Info

Tagged at
6 months ago