Factor out IFileSystemUtils.

Author: ericsnowcurrently

src/client/common/platform/fileSystem.ts

@@ -14,7 +14,7 @@ import { createDeferred } from '../utils/async';
 import { getOSType, OSType } from '../utils/platform';
 import {
     FileStat, FileType,
-    IFileSystem, IRawFileSystem,
+    IFileSystem, IFileSystemUtils, IRawFileSystem,
     TemporaryFile, WriteStream
 } from './types';
 
@@ -63,10 +63,9 @@ interface IRawFSExtra {
     createWriteStream(dest: string): fsextra.WriteStream;
 }
 
-// Later we will rename "FileSystem" to "FileSystemUtils" and
-// "RawFileSystem" to "FileSystem".
+// Later we will drop "FileSystem", switching usage to
+// "FileSystemUtils" and then rename "RawFileSystem" to "FileSystem".
 
-@injectable()
 class RawFileSystem {
     constructor(
         private readonly nodefs: IRawFS = fs,
@@ -168,8 +167,9 @@ class RawFileSystem {
     }
 }
 
+// more aliases (to cause less churn)
 @injectable()
-export class FileSystem implements IFileSystem {
+export class FileSystemUtils implements IFileSystemUtils {
     constructor(
         private readonly isWindows = (getOSType() === OSType.Windows),
         //public readonly raw: IFileSystem = {}
@@ -179,14 +179,6 @@ export class FileSystem implements IFileSystem {
     //****************************
     // aliases
 
-    public async readFile(filename: string): Promise<string> {
-        return this.raw.readText(filename);
-    }
-
-    public async writeFile(filename: string, data: {}): Promise<void> {
-        return this.raw.writeText(filename, data);
-    }
-
     public async createDirectory(dirname: string): Promise<void> {
         return this.raw.mkdirp(dirname);
     }
@@ -199,22 +191,6 @@ export class FileSystem implements IFileSystem {
         return this.raw.rmfile(filename);
     }
 
-    public async chmod(filename: string, mode: string): Promise<void> {
-        return this.raw.chmod(filename, mode);
-    }
-
-    public async copyFile(src: string, dest: string): Promise<void> {
-        return this.raw.copyFile(src, dest);
-    }
-
-    public readFileSync(filename: string): string {
-        return this.raw.readTextSync(filename);
-    }
-
-    public createWriteStream(filename: string): WriteStream {
-        return this.raw.createWriteStream(filename);
-    }
-
     //****************************
     // helpers
 
@@ -336,3 +312,30 @@ export class FileSystem implements IFileSystem {
         });
     }
 }
+
+@injectable()
+export class FileSystem extends FileSystemUtils implements IFileSystem {
+    public async readFile(filename: string): Promise<string> {
+        return this.raw.readText(filename);
+    }
+
+    public async writeFile(filename: string, data: {}): Promise<void> {
+        return this.raw.writeText(filename, data);
+    }
+
+    public async chmod(filename: string, mode: string): Promise<void> {
+        return this.raw.chmod(filename, mode);
+    }
+
+    public async copyFile(src: string, dest: string): Promise<void> {
+        return this.raw.copyFile(src, dest);
+    }
+
+    public readFileSync(filename: string): string {
+        return this.raw.readTextSync(filename);
+    }
+
+    public createWriteStream(filename: string): WriteStream {
+        return this.raw.createWriteStream(filename);
+    }
+}

src/client/common/platform/serviceRegistry.ts

@@ -3,13 +3,14 @@
 'use strict';
 
 import { IServiceManager } from '../../ioc/types';
-import { FileSystem } from './fileSystem';
+import { FileSystem, FileSystemUtils } from './fileSystem';
 import { PlatformService } from './platformService';
 import { RegistryImplementation } from './registry';
-import { IFileSystem, IPlatformService, IRegistry } from './types';
+import { IFileSystem, IFileSystemUtils, IPlatformService, IRegistry } from './types';
 
 export function registerTypes(serviceManager: IServiceManager) {
     serviceManager.addSingleton<IPlatformService>(IPlatformService, PlatformService);
     serviceManager.addSingleton<IFileSystem>(IFileSystem, FileSystem);
+    serviceManager.addSingleton<IFileSystemUtils>(IFileSystemUtils, FileSystemUtils);
     serviceManager.addSingleton<IRegistry>(IRegistry, RegistryImplementation);
 }

src/client/common/platform/types.ts

@@ -45,8 +45,8 @@ export import FileType = vscode.FileType;
 export type FileStat = fsextra.Stats;
 export type WriteStream = fs.WriteStream;
 
-// Later we will rename "IFileSystem" to "IFileSystemUtils" and
-// "IRawFileSystem" to "IFileSystem".
+// Later we will drop "IFileSystem", switching usage to
+// "IFileSystemUtils" and then rename "IRawFileSystem" to "IFileSystem".
 
 export interface IRawFileSystem {
     stat(filename: string): Promise<FileStat>;
@@ -68,20 +68,13 @@ export interface IRawFileSystem {
     createWriteStream(filename: string): WriteStream;
 }
 
-export const IFileSystem = Symbol('IFileSystem');
-export interface IFileSystem {
+export const IFileSystemUtils = Symbol('IFileSystemUtils');
+export interface IFileSystemUtils {
     raw: IRawFileSystem;
-    // aliases (to cause less churn)
-    readFile(filename: string): Promise<string>;
-    writeFile(filename: string, data: {}): Promise<void>;
+    // aliases
     createDirectory(dirname: string): Promise<void>;
     deleteDirectory(dirname: string): Promise<void>;
     deleteFile(filename: string): Promise<void>;
-    chmod(filename: string, mode: string): Promise<void>;
-    copyFile(src: string, dest: string): Promise<void>;
-    // aliases (non-async)
-    readFileSync(filename: string): string;
-    createWriteStream(filename: string): WriteStream;
     // helpers
     pathExists(filename: string, fileType?: FileType): Promise<boolean>;
     fileExists(filename: string): Promise<boolean>;
@@ -96,3 +89,15 @@ export interface IFileSystem {
     arePathsSame(path1: string, path2: string): boolean;  // Move to IPathUtils.
     fileExistsSync(filename: string): boolean;
 }
+
+// more aliases (to cause less churn)
+export const IFileSystem = Symbol('IFileSystem');
+export interface IFileSystem extends IFileSystemUtils {
+    readFile(filename: string): Promise<string>;
+    writeFile(filename: string, data: {}): Promise<void>;
+    chmod(filename: string, mode: string): Promise<void>;
+    copyFile(src: string, dest: string): Promise<void>;
+    // non-async
+    readFileSync(filename: string): string;
+    createWriteStream(filename: string): WriteStream;
+}