forked from DonJayamanne/pythonVSCode
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfilesystem.ts
More file actions
143 lines (130 loc) · 3.84 KB
/
filesystem.ts
File metadata and controls
143 lines (130 loc) · 3.84 KB
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
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
import * as fs from 'fs';
import * as vscode from 'vscode';
import { traceError } from '../../logging';
export import FileType = vscode.FileType;
export type DirEntry = {
filename: string;
filetype: FileType;
};
interface IKnowsFileType {
isFile(): boolean;
isDirectory(): boolean;
isSymbolicLink(): boolean;
}
// This helper function determines the file type of the given stats
// object. The type follows the convention of node's fs module, where
// a file has exactly one type. Symlinks are not resolved.
export function convertFileType(info: IKnowsFileType): FileType {
if (info.isFile()) {
return FileType.File;
}
if (info.isDirectory()) {
return FileType.Directory;
}
if (info.isSymbolicLink()) {
// The caller is responsible for combining this ("logical or")
// with File or Directory as necessary.
return FileType.SymbolicLink;
}
return FileType.Unknown;
}
/**
* Identify the file type for the given file.
*/
export async function getFileType(
filename: string,
opts: {
ignoreErrors: boolean;
} = { ignoreErrors: true },
): Promise<FileType | undefined> {
let stat: fs.Stats;
try {
stat = await fs.promises.lstat(filename);
} catch (err) {
const error = err as NodeJS.ErrnoException;
if (error.code === 'ENOENT') {
return undefined;
}
if (opts.ignoreErrors) {
traceError(`lstat() failed for "${filename}" (${err})`);
return FileType.Unknown;
}
throw err; // re-throw
}
return convertFileType(stat);
}
function normalizeFileTypes(filetypes: FileType | FileType[] | undefined): FileType[] | undefined {
if (filetypes === undefined) {
return undefined;
}
if (Array.isArray(filetypes)) {
if (filetypes.length === 0) {
return undefined;
}
return filetypes;
}
return [filetypes];
}
async function resolveFile(
file: string | DirEntry,
opts: {
ensure?: boolean;
onMissing?: FileType;
} = {},
): Promise<DirEntry | undefined> {
let filename: string;
if (typeof file !== 'string') {
if (!opts.ensure) {
if (opts.onMissing === undefined) {
return file;
}
// At least make sure it exists.
if ((await getFileType(file.filename)) !== undefined) {
return file;
}
}
filename = file.filename;
} else {
filename = file;
}
const filetype = (await getFileType(filename)) || opts.onMissing;
if (filetype === undefined) {
return undefined;
}
return { filename, filetype };
}
type FileFilterFunc = (file: string | DirEntry) => Promise<boolean>;
export function getFileFilter(
opts: {
ignoreMissing?: boolean;
ignoreFileType?: FileType | FileType[];
ensureEntry?: boolean;
} = {
ignoreMissing: true,
},
): FileFilterFunc | undefined {
const ignoreFileType = normalizeFileTypes(opts.ignoreFileType);
if (!opts.ignoreMissing && !ignoreFileType) {
// Do not filter.
return undefined;
}
async function filterFile(file: string | DirEntry): Promise<boolean> {
let entry = await resolveFile(file, { ensure: opts.ensureEntry });
if (!entry) {
if (opts.ignoreMissing) {
return false;
}
const filename = typeof file === 'string' ? file : file.filename;
entry = { filename, filetype: FileType.Unknown };
}
if (ignoreFileType) {
if (ignoreFileType.includes(entry!.filetype)) {
return false;
}
}
return true;
}
return filterFile;
}