microsoft/vscode-react-native
Publicmirrored fromhttps://github.com/microsoft/vscode-react-nativeAvailable
src/common/node/fileSystem.ts
226lines · modecode
| 1 | // Copyright (c) Microsoft Corporation. All rights reserved. |
| 2 | // Licensed under the MIT license. See LICENSE file in the project root for details. |
| 3 | |
| 4 | import * as nodeFs from "fs"; |
| 5 | import * as path from "path"; |
| 6 | import * as Q from "q"; |
| 7 | |
| 8 | export class FileSystem { |
| 9 | private fs: typeof nodeFs; |
| 10 | |
| 11 | constructor({ fs = nodeFs } = {}) { |
| 12 | this.fs = fs; |
| 13 | } |
| 14 | |
| 15 | public ensureDirectory(dir: string): Q.Promise<void> { |
| 16 | return Q.nfcall(this.fs.stat, dir).then((stat: nodeFs.Stats): void => { |
| 17 | if (stat.isDirectory()) { |
| 18 | return; |
| 19 | } |
| 20 | throw new Error(`Expected ${dir} to be a directory`); |
| 21 | }, (err: Error & { code?: string }): Q.Promise<any> => { |
| 22 | if (err && err.code === "ENOENT") { |
| 23 | return Q.nfcall(this.fs.mkdir, dir); |
| 24 | } |
| 25 | throw err; |
| 26 | }); |
| 27 | } |
| 28 | |
| 29 | public ensureFileWithContents(file: string, contents: string): Q.Promise<void> { |
| 30 | return Q.nfcall(this.fs.stat, file).then((stat: nodeFs.Stats) => { |
| 31 | if (!stat.isFile()) { |
| 32 | throw new Error(`Expected ${file} to be a file`); |
| 33 | } |
| 34 | |
| 35 | return this.readFile(file).then(existingContents => { |
| 36 | if (contents !== existingContents) { |
| 37 | return this.writeFile(file, contents); |
| 38 | } |
| 39 | }); |
| 40 | }, (err: Error & { code?: string }): Q.Promise<any> => { |
| 41 | if (err && err.code === "ENOENT") { |
| 42 | return Q.nfcall(this.fs.writeFile, file, contents); |
| 43 | } |
| 44 | throw err; |
| 45 | }); |
| 46 | } |
| 47 | |
| 48 | /** |
| 49 | * Helper function to check if a file or directory exists |
| 50 | */ |
| 51 | public existsSync(filename: string) { |
| 52 | try { |
| 53 | this.fs.statSync(filename); |
| 54 | return true; |
| 55 | } catch (error) { |
| 56 | return false; |
| 57 | } |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Helper (asynchronous) function to check if a file or directory exists |
| 62 | */ |
| 63 | public exists(filename: string): Q.Promise<boolean> { |
| 64 | return Q.nfcall(this.fs.stat, filename) |
| 65 | .then(function() { |
| 66 | return Q.resolve(true); |
| 67 | }) |
| 68 | .catch(function(err) { |
| 69 | return Q.resolve(false); |
| 70 | }); |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Helper async function to read the contents of a directory |
| 75 | */ |
| 76 | public readDir(directory: string): Q.Promise<string[]> { |
| 77 | return Q.nfcall<string[]>(this.fs.readdir, directory); |
| 78 | } |
| 79 | |
| 80 | /** |
| 81 | * Helper (synchronous) function to create a directory recursively |
| 82 | */ |
| 83 | public makeDirectoryRecursiveSync(dirPath: string): void { |
| 84 | let parentPath = path.dirname(dirPath); |
| 85 | if (!this.existsSync(parentPath)) { |
| 86 | this.makeDirectoryRecursiveSync(parentPath); |
| 87 | } |
| 88 | |
| 89 | this.fs.mkdirSync(dirPath); |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Helper function to asynchronously copy a file |
| 94 | */ |
| 95 | public copyFile(from: string, to: string, encoding?: string): Q.Promise<void> { |
| 96 | let deferred: Q.Deferred<void> = Q.defer<void>(); |
| 97 | let destFile: nodeFs.WriteStream = this.fs.createWriteStream(to, { encoding: encoding }); |
| 98 | let srcFile: nodeFs.ReadStream = this.fs.createReadStream(from, { encoding: encoding }); |
| 99 | destFile.on("finish", function(): void { |
| 100 | deferred.resolve(void 0); |
| 101 | }); |
| 102 | |
| 103 | destFile.on("error", function(e: Error): void { |
| 104 | deferred.reject(e); |
| 105 | }); |
| 106 | |
| 107 | srcFile.on("error", function(e: Error): void { |
| 108 | deferred.reject(e); |
| 109 | }); |
| 110 | |
| 111 | srcFile.pipe(destFile); |
| 112 | return deferred.promise; |
| 113 | } |
| 114 | |
| 115 | public deleteFileIfExistsSync(filename: string) { |
| 116 | if (this.existsSync(filename)) { |
| 117 | this.fs.unlinkSync(filename); |
| 118 | } |
| 119 | } |
| 120 | |
| 121 | public readFile(filename: string, encoding: string = "utf8"): Q.Promise<string> { |
| 122 | return Q.nfcall<string>(this.fs.readFile, filename, encoding); |
| 123 | } |
| 124 | |
| 125 | public writeFile(filename: string, data: any): Q.Promise<void> { |
| 126 | return Q.nfcall<void>(this.fs.writeFile, filename, data); |
| 127 | } |
| 128 | |
| 129 | public unlink(filename: string): Q.Promise<void> { |
| 130 | return Q.nfcall<void>(this.fs.unlink, filename); |
| 131 | } |
| 132 | |
| 133 | public mkDir(p: string): Q.Promise<void> { |
| 134 | return Q.nfcall<void>(this.fs.mkdir, p); |
| 135 | } |
| 136 | |
| 137 | public stat(path: string): Q.Promise<nodeFs.Stats> { |
| 138 | return Q.nfcall<nodeFs.Stats>(this.fs.stat, path); |
| 139 | } |
| 140 | |
| 141 | public directoryExists(directoryPath: string): Q.Promise<boolean> { |
| 142 | return this.stat(directoryPath).then(stats => { |
| 143 | return stats.isDirectory(); |
| 144 | }).catch(reason => { |
| 145 | return reason.code === "ENOENT" |
| 146 | ? false |
| 147 | : Q.reject<boolean>(reason); |
| 148 | }); |
| 149 | } |
| 150 | |
| 151 | |
| 152 | /** |
| 153 | * Delete 'dirPath' if it's an empty folder. If not fail. |
| 154 | * |
| 155 | * @param {dirPath} path to the folder |
| 156 | * @returns {void} Nothing |
| 157 | */ |
| 158 | public rmdir(dirPath: string): Q.Promise<void> { |
| 159 | return Q.nfcall<void>(this.fs.rmdir, dirPath); |
| 160 | } |
| 161 | |
| 162 | /** |
| 163 | * Recursively copy 'source' to 'target' asynchronously |
| 164 | * |
| 165 | * @param {string} source Location to copy from |
| 166 | * @param {string} target Location to copy to |
| 167 | * @returns {Q.Promise} A promise which is fulfilled when the copy completes, and is rejected on error |
| 168 | */ |
| 169 | public copyRecursive(source: string, target: string): Q.Promise<void> { |
| 170 | return Q.nfcall<nodeFs.Stats>(this.fs.stat, source).then(stats => { |
| 171 | if (stats.isDirectory()) { |
| 172 | return this.exists(target).then(exists => { |
| 173 | if (!exists) { |
| 174 | return Q.nfcall<void>(this.fs.mkdir, target); |
| 175 | } |
| 176 | }) |
| 177 | .then(() => { |
| 178 | return Q.nfcall<string[]>(this.fs.readdir, source); |
| 179 | }) |
| 180 | .then(contents => { |
| 181 | Q.all(contents.map((childPath: string): Q.Promise<void> => { |
| 182 | return this.copyRecursive(path.join(source, childPath), path.join(target, childPath)); |
| 183 | })); |
| 184 | }); |
| 185 | } else { |
| 186 | return this.copyFile(source, target); |
| 187 | } |
| 188 | }); |
| 189 | } |
| 190 | |
| 191 | public removePathRecursivelyAsync(p: string): Q.Promise<void> { |
| 192 | return this.exists(p).then(exists => { |
| 193 | if (exists) { |
| 194 | return Q.nfcall<nodeFs.Stats>(this.fs.stat, p).then((stats: nodeFs.Stats) => { |
| 195 | if (stats.isDirectory()) { |
| 196 | return Q.nfcall<string[]>(this.fs.readdir, p).then((childPaths: string[]) => { |
| 197 | let result = Q<void>(void 0); |
| 198 | childPaths.forEach(childPath => |
| 199 | result = result.then<void>(() => this.removePathRecursivelyAsync(path.join(p, childPath)))); |
| 200 | return result; |
| 201 | }).then(() => |
| 202 | Q.nfcall<void>(this.fs.rmdir, p)); |
| 203 | } else { |
| 204 | /* file */ |
| 205 | return Q.nfcall<void>(this.fs.unlink, p); |
| 206 | } |
| 207 | }); |
| 208 | } |
| 209 | }); |
| 210 | } |
| 211 | |
| 212 | public removePathRecursivelySync(p: string): void { |
| 213 | if (this.fs.existsSync(p)) { |
| 214 | let stats = this.fs.statSync(p); |
| 215 | if (stats.isDirectory()) { |
| 216 | let contents = this.fs.readdirSync(p); |
| 217 | contents.forEach(childPath => |
| 218 | this.removePathRecursivelySync(path.join(p, childPath))); |
| 219 | this.fs.rmdirSync(p); |
| 220 | } else { |
| 221 | /* file */ |
| 222 | this.fs.unlinkSync(p); |
| 223 | } |
| 224 | } |
| 225 | } |
| 226 | } |
| 227 | |