microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-02-04 12:32:08 -06:00
Code Issues Packages Projects Releases 212 Wiki Activity

Show a diff when the public api baselines fail (#39108)

Browse Source 
* Add semantic highlighting pt1

* Make the public API unit tests echo out a diff
This commit is contained in:
Orta 2020-06-17 17:00:46 -04:00 committed by GitHub
parent 0bc29acc08
commit d7aa5f3ee1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
package.json
View File

@ -65,6 +65,7 @@
"chalk": "latest",
"convert-source-map": "latest",
"del": "5.1.0",
"diff": "^4.0.2",
"eslint": "6.8.0",
"eslint-formatter-autolinkable-stylish": "1.1.2",
"eslint-plugin-import": "2.20.2",

14
src/harness/harnessIO.ts
View File

@ -1293,6 +1293,7 @@ namespace Harness {
export interface BaselineOptions {
Subfolder?: string;
Baselinefolder?: string;
PrintDiff?: true;
}
export function localPath(fileName: string, baselineFolder?: string, subfolder?: string) {
@ -1347,7 +1348,7 @@ namespace Harness {
return { expected, actual };
}
function writeComparison(expected: string, actual: string, relativeFileName: string, actualFileName: string) {
function writeComparison(expected: string, actual: string, relativeFileName: string, actualFileName: string, opts?: BaselineOptions) {
// For now this is written using TypeScript, because sys is not available when running old test cases.
// But we need to move to sys once we have
// Creates the directory including its parent if not already present
@ -1381,7 +1382,14 @@ namespace Harness {
else {
IO.writeFile(actualFileName, encodedActual);
}
throw new Error(`The baseline file ${relativeFileName} has changed.`);
if (require && opts && opts.PrintDiff) {
const Diff = require("diff");
const patch = Diff.createTwoFilesPatch("Expected", "Actual", expected, actual, "The current baseline", "The new version");
throw new Error(`The baseline file ${relativeFileName} has changed.${ts.ForegroundColorEscapeSequences.Grey}\n\n${patch}`);
}
else {
throw new Error(`The baseline file ${relativeFileName} has changed.`);
}
}
}
@ -1391,7 +1399,7 @@ namespace Harness {
throw new Error("The generated content was \"undefined\". Return \"null\" if no baselining is required.\"");
}
const comparison = compareToBaseline(actual, relativeFileName, opts);
writeComparison(comparison.expected, comparison.actual, relativeFileName, actualFileName);
writeComparison(comparison.expected, comparison.actual, relativeFileName, actualFileName, opts);
}
export function runMultifileBaseline(relativeFileBase: string, extension: string, generateContent: () => IterableIterator<[string, string, number]> | IterableIterator<[string, string]> | null, opts?: BaselineOptions, referencedExtensions?: string[]): void {

2
src/testRunner/unittests/publicApi.ts
View File

@ -10,7 +10,7 @@ describe("unittests:: Public APIs", () => {
});
it("should be acknowledged when they change", () => {
Harness.Baseline.runBaseline(api, fileContent);
Harness.Baseline.runBaseline(api, fileContent, { PrintDiff: true });
});
it("should compile", () => {