Use the new API for writeText().

Author: ericsnowcurrently

src/client/common/platform/fileSystem.ts

@@ -49,7 +49,7 @@ interface INewAPI {
     readFile(uri: vscode.Uri): Thenable<Uint8Array>;
     //rename(source: vscode.Uri, target: vscode.Uri, options?: {overwrite: boolean}): Thenable<void>;
     stat(uri: vscode.Uri): Thenable<FileStat>;
-    //writeFile(uri: vscode.Uri, content: Uint8Array): Thenable<void>;
+    writeFile(uri: vscode.Uri, content: Uint8Array): Thenable<void>;
 }
 
 interface IRawFS {
@@ -64,8 +64,6 @@ interface IRawFS {
 
 interface IRawFSExtra {
     chmod(filePath: string, mode: string | number): Promise<void>;
-    //tslint:disable-next-line:no-any
-    writeFile(path: string, data: any, options: any): Promise<void>;
     lstat(filename: string): Promise<fsextra.Stats>;
     mkdirp(dirname: string): Promise<void>;
 
@@ -96,6 +94,12 @@ export class RawFileSystem implements IRawFileSystem {
         return data.toString(ENCODING);
     }
 
+    public async writeText(filename: string, text: string): Promise<void> {
+        const uri = vscode.Uri.file(filename);
+        const data = Buffer.from(text);
+        await this.newapi.writeFile(uri, data);
+    }
+
     public async rmtree(dirname: string): Promise<void> {
         const uri = vscode.Uri.file(dirname);
         return this.newapi.delete(uri, {
@@ -125,13 +129,6 @@ export class RawFileSystem implements IRawFileSystem {
     //****************************
     // fs-extra
 
-    public async writeText(filename: string, data: {}): Promise<void> {
-        const options: fsextra.WriteFileOptions = {
-            encoding: ENCODING
-        };
-        await this.fsExtra.writeFile(filename, data, options);
-    }
-
     public async mkdirp(dirname: string): Promise<void> {
         return this.fsExtra.mkdirp(dirname);
     }

src/test/common/platform/filesystem.functional.test.ts

@@ -107,42 +107,6 @@ suite('Raw FileSystem', () => {
         await fix.cleanUp();
     });
 
-    suite('writeText', () => {
-        test('creates the file if missing', async () => {
-            const filename = await fix.resolve('x/y/z/spam.py');
-            await ensureDoesNotExist(filename);
-            const data = 'line1\nline2\n';
-
-            await filesystem.writeText(filename, data);
-
-            const actual = await fsextra.readFile(filename)
-                .then(buffer => buffer.toString());
-            expect(actual).to.equal(data);
-        });
-
-        test('always UTF-8', async () => {
-            const filename = await fix.resolve('x/y/z/spam.py');
-            const data = '... 😁 ...';
-
-            await filesystem.writeText(filename, data);
-
-            const actual = await fsextra.readFile(filename)
-                .then(buffer => buffer.toString());
-            expect(actual).to.equal(data);
-        });
-
-        test('overwrites existing file', async () => {
-            const filename = await fix.createFile('x/y/z/spam.py', '...');
-            const data = 'line1\nline2\n';
-
-            await filesystem.writeText(filename, data);
-
-            const actual = await fsextra.readFile(filename)
-                .then(buffer => buffer.toString());
-            expect(actual).to.equal(data);
-        });
-    });
-
     suite('mkdirp', () => {
         test('creates the directory and all missing parents', async () => {
             await fix.createDirectory('x');

src/test/common/platform/filesystem.test.ts

@@ -57,6 +57,42 @@ suite('Raw FileSystem', () => {
         });
     });
 
+    suite('writeText', () => {
+        test('creates the file if missing', async () => {
+            const filename = await fix.resolve('x/y/z/spam.py');
+            await ensureDoesNotExist(filename);
+            const data = 'line1\nline2\n';
+
+            await filesystem.writeText(filename, data);
+
+            const actual = await fsextra.readFile(filename)
+                .then(buffer => buffer.toString());
+            expect(actual).to.equal(data);
+        });
+
+        test('always UTF-8', async () => {
+            const filename = await fix.resolve('x/y/z/spam.py');
+            const data = '... 😁 ...';
+
+            await filesystem.writeText(filename, data);
+
+            const actual = await fsextra.readFile(filename)
+                .then(buffer => buffer.toString());
+            expect(actual).to.equal(data);
+        });
+
+        test('overwrites existing file', async () => {
+            const filename = await fix.createFile('x/y/z/spam.py', '...');
+            const data = 'line1\nline2\n';
+
+            await filesystem.writeText(filename, data);
+
+            const actual = await fsextra.readFile(filename)
+                .then(buffer => buffer.toString());
+            expect(actual).to.equal(data);
+        });
+    });
+
     suite('rmtree', () => {
         test('deletes the directory and everything in it', async () => {
             const dirname = await fix.createDirectory('x');

src/test/common/platform/filesystem.unit.test.ts

@@ -23,6 +23,7 @@ interface IRawFS {
     readDirectory(uri: vscode.Uri): Thenable<[string, FileType][]>;
     readFile(uri: vscode.Uri): Thenable<Uint8Array>;
     stat(uri: vscode.Uri): Thenable<FileStat>;
+    writeFile(uri: vscode.Uri, content: Uint8Array): Thenable<void>;
 
     // node "fs"
     //tslint:disable-next-line:no-any
@@ -32,8 +33,6 @@ interface IRawFS {
 
     // "fs-extra"
     chmod(filePath: string, mode: string): Promise<void>;
-    //tslint:disable-next-line:no-any
-    writeFile(path: string, data: any, options: any): Promise<void>;
     lstat(filename: string): Promise<fsextra.Stats>;
     mkdirp(dirname: string): Promise<void>;
     statSync(filename: string): fsextra.Stats;
@@ -150,11 +149,24 @@ suite('Raw FileSystem', () => {
     suite('writeText', () => {
         test('wraps the low-level function', async () => {
             const filename = 'x/y/z/spam.py';
-            const data = '<data>';
-            raw.setup(r => r.writeFile(filename, data, { encoding: 'utf8' }))
+            const text = '<data>';
+            const data = Buffer.from(text);
+            raw.setup(r => r.writeFile(vscode.Uri.file(filename), data))
+                .returns(() => Promise.resolve());
+
+            await filesystem.writeText(filename, text);
+
+            verifyAll();
+        });
+
+        test('always UTF-8', async () => {
+            const filename = 'x/y/z/spam.py';
+            const text = '... 😁 ...';
+            const data = Buffer.from(text);
+            raw.setup(r => r.writeFile(vscode.Uri.file(filename), data))
                 .returns(() => Promise.resolve());
 
-            await filesystem.writeText(filename, data);
+            await filesystem.writeText(filename, text);
 
             verifyAll();
         });