Deprecate GeneratedFile

Author: rbuckton

src/harness/compiler.ts

@@ -236,12 +236,9 @@ namespace compiler {
         private _inputsAndOutputs: core.KeyedCollection<string, CompilationOutput>;
 
         // from CompilerResult
-        public readonly files: ReadonlyArray<Harness.Compiler.GeneratedFile>;
-        public readonly declFilesCode: ReadonlyArray<Harness.Compiler.GeneratedFile>;
-        public readonly sourceMaps: ReadonlyArray<Harness.Compiler.GeneratedFile>;
-        public readonly errors: ReadonlyArray<ts.Diagnostic>;
-        public readonly currentDirectoryForProgram: string;
-        public readonly traceResults: ReadonlyArray<string>;
+        public readonly files: ReadonlyArray<documents.TextDocument>;
+        public readonly declFilesCode: ReadonlyArray<documents.TextDocument>;
+        public readonly sourceMaps: ReadonlyArray<documents.TextDocument>;
 
         constructor(host: CompilerHost, options: ts.CompilerOptions, program: ts.Program | undefined, result: ts.EmitResult | undefined, diagnostics: ts.Diagnostic[]) {
             this.host = host;
@@ -291,12 +288,10 @@ namespace compiler {
             }
 
             // from CompilerResult
-            this.files = Array.from(this.js.values(), file => file.asGeneratedFile());
-            this.declFilesCode = Array.from(this.dts.values(), file => file.asGeneratedFile());
-            this.sourceMaps = Array.from(this.maps.values(), file => file.asGeneratedFile());
-            this.errors = diagnostics;
-            this.currentDirectoryForProgram = host.vfs.currentDirectory;
-            this.traceResults = host.traces;
+            this.files = Array.from(this.js.values());
+            this.declFilesCode = Array.from(this.dts.values());
+            this.sourceMaps = Array.from(this.maps.values());
+            this.diagnostics = diagnostics;
         }
 
         public get vfs(): vfs.VirtualFileSystem {

src/harness/compilerRunner.ts

@@ -208,14 +208,14 @@ class CompilerTest {
         Harness.Compiler.doErrorBaseline(
             this.justName,
             this.tsConfigFiles.concat(this.toBeCompiled, this.otherFiles),
-            this.result.errors,
+            this.result.diagnostics,
             !!this.options.pretty);
     }
 
     public verifyModuleResolution() {
         if (this.options.traceResolution) {
             Harness.Baseline.runBaseline(this.justName.replace(/\.tsx?$/, ".trace.json"), () => {
-                return utils.removeTestPathPrefixes(JSON.stringify(this.result.traceResults || [], undefined, 4));
+                return utils.removeTestPathPrefixes(JSON.stringify(this.result.traces, undefined, 4));
             });
         }
     }
@@ -224,7 +224,7 @@ class CompilerTest {
         if (this.options.sourceMap || this.options.inlineSourceMap) {
             Harness.Baseline.runBaseline(this.justName.replace(/\.tsx?$/, ".sourcemap.txt"), () => {
                 const record = utils.removeTestPathPrefixes(this.result.getSourceMapRecord());
-                if ((this.options.noEmitOnError && this.result.errors.length !== 0) || record === undefined) {
+                if ((this.options.noEmitOnError && this.result.diagnostics.length !== 0) || record === undefined) {
                     // Because of the noEmitOnError option no files are created. We need to return null because baselining isn't required.
                     /* tslint:disable:no-null-keyword */
                     return null;

src/harness/core.ts

@@ -357,6 +357,11 @@ namespace core {
         return text;
     }
 
+    export function getByteOrderMark(text: string): string {
+        const length = getByteOrderMarkLength(text);
+        return length > 0 ? text.slice(0, length) : "";
+    }
+
     export function getByteOrderMarkLength(text: string): number {
         if (text.length >= 2) {
             const ch0 = text.charCodeAt(0);

src/harness/documents.ts

@@ -11,7 +11,6 @@ namespace documents {
 
         private _lineStarts: core.LineStarts | undefined;
         private _testFile: Harness.Compiler.TestFile | undefined;
-        private _generatedFile: Harness.Compiler.GeneratedFile | undefined;
 
         constructor(file: string, text: string, meta?: Map<string, string>) {
             this.file = file;
@@ -39,20 +38,6 @@ namespace documents {
                     .reduce((obj, [key, value]) => (obj[key] = value, obj), {} as Record<string, string>)
             });
         }
-
-        public static fromGeneratedFile(file: Harness.Compiler.GeneratedFile) {
-            return new TextDocument(
-                file.fileName,
-                file.writeByteOrderMark ? core.addUTF8ByteOrderMark(file.code) : file.code);
-        }
-
-        public asGeneratedFile() {
-            return this._generatedFile || (this._generatedFile = {
-                fileName: this.file,
-                code: core.removeByteOrderMark(this.text),
-                writeByteOrderMark: core.getByteOrderMarkLength(this.text) > 0
-            });
-        }
     }
 
     export interface RawSourceMap {

src/harness/harness.ts

@@ -1244,15 +1244,15 @@ namespace Harness {
             options: ts.CompilerOptions,
             // Current directory is needed for rwcRunner to be able to use currentDirectory defined in json file
             currentDirectory: string): DeclarationCompilationContext | undefined {
-            if (options.declaration && result.errors.length === 0 && result.declFilesCode.length !== result.files.length) {
+            if (options.declaration && result.diagnostics.length === 0 && result.declFilesCode.length !== result.files.length) {
                 throw new Error("There were no errors and declFiles generated did not match number of js files generated");
             }
 
             const declInputFiles: TestFile[] = [];
             const declOtherFiles: TestFile[] = [];
 
             // if the .d.ts is non-empty, confirm it compiles correctly as well
-            if (options.declaration && result.errors.length === 0 && result.declFilesCode.length > 0) {
+            if (options.declaration && result.diagnostics.length === 0 && result.declFilesCode.length > 0) {
                 ts.forEach(inputFiles, file => addDtsFile(file, declInputFiles));
                 ts.forEach(otherFiles, file => addDtsFile(file, declOtherFiles));
                 return { declInputFiles, declOtherFiles, harnessSettings, options, currentDirectory: currentDirectory || harnessSettings.currentDirectory };
@@ -1264,8 +1264,8 @@ namespace Harness {
                 }
                 else if (vpath.isTypeScript(file.unitName)) {
                     const declFile = findResultCodeFile(file.unitName);
-                    if (declFile && !findUnit(declFile.fileName, declInputFiles) && !findUnit(declFile.fileName, declOtherFiles)) {
-                        dtsFiles.push({ unitName: declFile.fileName, content: declFile.code });
+                    if (declFile && !findUnit(declFile.file, declInputFiles) && !findUnit(declFile.file, declOtherFiles)) {
+                        dtsFiles.push({ unitName: declFile.file, content: core.removeByteOrderMark(declFile.text) });
                     }
                 }
             }
@@ -1278,7 +1278,7 @@ namespace Harness {
                 const outFile = options.outFile || options.out;
                 if (!outFile) {
                     if (options.outDir) {
-                        let sourceFilePath = ts.getNormalizedAbsolutePath(sourceFile.fileName, result.currentDirectoryForProgram);
+                        let sourceFilePath = ts.getNormalizedAbsolutePath(sourceFile.fileName, result.vfs.currentDirectory);
                         sourceFilePath = sourceFilePath.replace(result.program.getCommonSourceDirectory(), "");
                         sourceFileName = ts.combinePaths(options.outDir, sourceFilePath);
                     }
@@ -1293,7 +1293,7 @@ namespace Harness {
 
                 const dTsFileName = ts.removeFileExtension(sourceFileName) + ts.Extension.Dts;
 
-                return ts.forEach(result.declFilesCode, declFile => declFile.fileName === dTsFileName ? declFile : undefined);
+                return ts.forEach(result.declFilesCode, declFile => declFile.file === dTsFileName ? declFile : undefined);
             }
 
             function findUnit(fileName: string, units: TestFile[]) {
@@ -1602,10 +1602,6 @@ namespace Harness {
             }
         }
 
-        function getByteOrderMarkText(file: Harness.Compiler.GeneratedFile): string {
-            return file.writeByteOrderMark ? "\u00EF\u00BB\u00BF" : "";
-        }
-
         export function doSourcemapBaseline(baselinePath: string, options: ts.CompilerOptions, result: compiler.CompilationResult, harnessSettings: Harness.TestCaseParser.CompilerSettings) {
             if (options.inlineSourceMap) {
                 if (result.sourceMaps.length > 0) {
@@ -1619,7 +1615,7 @@ namespace Harness {
                 }
 
                 Harness.Baseline.runBaseline(baselinePath.replace(/\.tsx?/, ".js.map"), () => {
-                    if ((options.noEmitOnError && result.errors.length !== 0) || result.sourceMaps.length === 0) {
+                    if ((options.noEmitOnError && result.diagnostics.length !== 0) || result.sourceMaps.length === 0) {
                         // We need to return null here or the runBaseLine will actually create a empty file.
                         // Baselining isn't required here because there is no output.
                         /* tslint:disable:no-null-keyword */
@@ -1638,7 +1634,7 @@ namespace Harness {
         }
 
         export function doJsEmitBaseline(baselinePath: string, header: string, options: ts.CompilerOptions, result: compiler.CompilationResult, tsConfigFiles: ReadonlyArray<Harness.Compiler.TestFile>, toBeCompiled: ReadonlyArray<Harness.Compiler.TestFile>, otherFiles: ReadonlyArray<Harness.Compiler.TestFile>, harnessSettings: Harness.TestCaseParser.CompilerSettings) {
-            if (!options.noEmit && result.files.length === 0 && result.errors.length === 0) {
+            if (!options.noEmit && result.files.length === 0 && result.diagnostics.length === 0) {
                 throw new Error("Expected at least one js file to be emitted or at least one error to be created.");
             }
 
@@ -1671,10 +1667,10 @@ namespace Harness {
                 );
                 const declFileCompilationResult = Harness.Compiler.compileDeclarationFiles(declFileContext);
 
-                if (declFileCompilationResult && declFileCompilationResult.declResult.errors.length) {
+                if (declFileCompilationResult && declFileCompilationResult.declResult.diagnostics.length) {
                     jsCode += "\r\n\r\n//// [DtsFileErrors]\r\n";
                     jsCode += "\r\n\r\n";
-                    jsCode += Harness.Compiler.getErrorBaseline(tsConfigFiles.concat(declFileCompilationResult.declInputFiles, declFileCompilationResult.declOtherFiles), declFileCompilationResult.declResult.errors);
+                    jsCode += Harness.Compiler.getErrorBaseline(tsConfigFiles.concat(declFileCompilationResult.declInputFiles, declFileCompilationResult.declOtherFiles), declFileCompilationResult.declResult.diagnostics);
                 }
 
                 if (jsCode.length > 0) {
@@ -1688,12 +1684,12 @@ namespace Harness {
             });
         }
 
-        function fileOutput(file: GeneratedFile, harnessSettings: Harness.TestCaseParser.CompilerSettings): string {
-            const fileName = harnessSettings.fullEmitPaths ? utils.removeTestPathPrefixes(file.fileName) : ts.getBaseFileName(file.fileName);
-            return "//// [" + fileName + "]\r\n" + getByteOrderMarkText(file) + utils.removeTestPathPrefixes(file.code);
+        function fileOutput(file: documents.TextDocument, harnessSettings: Harness.TestCaseParser.CompilerSettings): string {
+            const fileName = harnessSettings.fullEmitPaths ? utils.removeTestPathPrefixes(file.file) : ts.getBaseFileName(file.file);
+            return "//// [" + fileName + "]\r\n" + utils.removeTestPathPrefixes(file.text);
         }
 
-        export function collateOutputs(outputFiles: ReadonlyArray<Harness.Compiler.GeneratedFile>): string {
+        export function collateOutputs(outputFiles: ReadonlyArray<documents.TextDocument>): string {
             const gen = iterateOutputs(outputFiles);
             // Emit them
             let result = "";
@@ -1709,13 +1705,13 @@ namespace Harness {
             return result;
         }
 
-        export function *iterateOutputs(outputFiles: ReadonlyArray<Harness.Compiler.GeneratedFile>): IterableIterator<[string, string]> {
+        export function *iterateOutputs(outputFiles: ReadonlyArray<documents.TextDocument>): IterableIterator<[string, string]> {
             // Collect, test, and sort the fileNames
-            outputFiles.slice().sort((a, b) => ts.compareStringsCaseSensitive(cleanName(a.fileName), cleanName(b.fileName)));
+            outputFiles.slice().sort((a, b) => ts.compareStringsCaseSensitive(cleanName(a.file), cleanName(b.file)));
             const dupeCase = ts.createMap<number>();
             // Yield them
             for (const outputFile of outputFiles) {
-                yield [checkDuplicatedFileName(outputFile.fileName, dupeCase), "/*====== " + outputFile.fileName + " ======*/\r\n" + outputFile.code];
+                yield [checkDuplicatedFileName(outputFile.file, dupeCase), "/*====== " + outputFile.file + " ======*/\r\n" + core.removeByteOrderMark(outputFile.text)];
             }
 
             function cleanName(fn: string) {
@@ -1745,12 +1741,6 @@ namespace Harness {
             }
             return path;
         }
-
-        export interface GeneratedFile {
-            fileName: string;
-            code: string;
-            writeByteOrderMark: boolean;
-        }
     }
 
     export namespace TestCaseParser {