Skip to content

Factor out RawFileSystem. #9499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Eric Snow (ericsnowcurrently) merged 15 commits into from
Jan 27, 2020
Merged

Factor out RawFileSystem. #9499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
6ad1cc2
Factor out RawFileSystem.
ericsnowcurrently Dec 31, 2019
55b5c20
Add IRawFileSystem.
ericsnowcurrently Jan 9, 2020
4a5f7d8
Drop the dependency on Node's fs module.
ericsnowcurrently Jan 9, 2020
38f5ece
Mark methods as async where appropriate.
ericsnowcurrently Jan 9, 2020
318f00f
Use RawFileSystem for listdir calls in FileSystem.
ericsnowcurrently Jan 9, 2020
e7ecad2
Use RawFileSystem in FileSystem.getFileHash().
ericsnowcurrently Jan 9, 2020
085dafa
Use RawFileSystem in FileSystem.fileExists() and directoryExists().
ericsnowcurrently Jan 9, 2020
ffd4952
Simplify getSubDirectories() and getFiles().
ericsnowcurrently Jan 9, 2020
f778f58
Factor out filterByFileType().
ericsnowcurrently Jan 9, 2020
31ffd02
Do not mask unrelated errors.
ericsnowcurrently Jan 15, 2020
854926f
Move vsc-dependent tests to the right file.
ericsnowcurrently Jan 22, 2020
19a3920
Add some "system" tests.
ericsnowcurrently Jan 22, 2020
3630bd8
Make getFileType() a private method.
ericsnowcurrently Jan 23, 2020
aa09387
Add unit tests.
ericsnowcurrently Jan 23, 2020
8c1d3be
Fix datascience functional tests.
ericsnowcurrently Jan 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
486 changes: 324 additions & 162 deletions src/client/common/platform/fileSystem.ts
View file
Open in desktop

Large diffs are not rendered by default.

53 changes: 51 additions & 2 deletions src/client/common/platform/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,57 @@ export interface IFileSystemPathUtils {

export import FileType = vscode.FileType;
export import FileStat = vscode.FileStat;
export type ReadStream = fs.ReadStream;
export type WriteStream = fs.WriteStream;

// The low-level filesystem operations on which the extension depends.
export interface IRawFileSystem {
// Get information about a file (resolve symlinks).
stat(filename: string): Promise<FileStat>;
// Get information about a file (do not resolve synlinks).
lstat(filename: string): Promise<FileStat>;
// Change a file's permissions.
chmod(filename: string, mode: string | number): Promise<void>;
// Move the file to a different location (and/or rename it).
move(src: string, tgt: string): Promise<void>;

//***********************
// files

// Return the raw bytes of the given file.
readData(filename: string): Promise<Buffer>;
// Return the text of the given file (decoded from UTF-8).
readText(filename: string): Promise<string>;
// Write the given text to the file (UTF-8 encoded).
writeText(filename: string, data: {}): Promise<void>;
// Write the given text to the end of the file (UTF-8 encoded).
appendText(filename: string, text: string): Promise<void>;
// Copy a file.
copyFile(src: string, dest: string): Promise<void>;
// Delete a file.
rmfile(filename: string): Promise<void>;

//***********************
// directories

// Create the directory and any missing parent directories.
mkdirp(dirname: string): Promise<void>;
// Delete the directory and everything in it.
rmtree(dirname: string): Promise<void>;
// Return the contents of the directory.
listdir(dirname: string): Promise<[string, FileType][]>;

//***********************
// not async

// Return the text of the given file (decoded from UTF-8).
readTextSync(filename: string): string;
// Create a streaming wrappr around an open file (for reading).
createReadStream(filename: string): ReadStream;
// Create a streaming wrappr around an open file (for writing).
createWriteStream(filename: string): WriteStream;
}

export const IFileSystem = Symbol('IFileSystem');
export interface IFileSystem {
// path-related
Expand All @@ -106,8 +155,8 @@ export interface IFileSystem {
listdir(dirname: string): Promise<[string, FileType][]>;
readFile(filePath: string): Promise<string>;
readData(filePath: string): Promise<Buffer>;
writeFile(filePath: string, data: {}, options?: string | fsextra.WriteFileOptions): Promise<void>;
appendFile(filename: string, data: {}): Promise<void>;
writeFile(filePath: string, text: string | Buffer, options?: string | fsextra.WriteFileOptions): Promise<void>;
appendFile(filename: string, text: string | Buffer): Promise<void>;
copyFile(src: string, dest: string): Promise<void>;
deleteFile(filename: string): Promise<void>;
chmod(path: string, mode: string | number): Promise<void>;
Expand Down
Loading