fourslash diagnostics tests: use objects instead of strings

Author: Andy Hanson

src/harness/fourslash.ts

@@ -1236,20 +1236,18 @@ Actual: ${stringify(fullActual)}`);
             return this.languageService.findReferences(this.activeFile.fileName, this.currentCaretPosition);
         }
 
-        public getSyntacticDiagnostics(expected: string) {
+        public getSyntacticDiagnostics(expected: ReadonlyArray<ts.RealizedDiagnostic>) {
             const diagnostics = this.languageService.getSyntacticDiagnostics(this.activeFile.fileName);
             this.testDiagnostics(expected, diagnostics);
         }
 
-        public getSemanticDiagnostics(expected: string) {
+        public getSemanticDiagnostics(expected: ReadonlyArray<ts.RealizedDiagnostic>) {
             const diagnostics = this.languageService.getSemanticDiagnostics(this.activeFile.fileName);
             this.testDiagnostics(expected, diagnostics);
         }
 
-        private testDiagnostics(expected: string, diagnostics: ReadonlyArray<ts.Diagnostic>) {
-            const realized = ts.realizeDiagnostics(diagnostics, "\r\n");
-            const actual = stringify(realized);
-            assert.equal(actual, expected);
+        private testDiagnostics(expected: ReadonlyArray<ts.RealizedDiagnostic>, diagnostics: ReadonlyArray<ts.Diagnostic>) {
+            assert.deepEqual(ts.realizeDiagnostics(diagnostics, ts.newLineCharacter), expected);
         }
 
         public verifyQuickInfoAt(markerName: string, expectedText: string, expectedDocumentation?: string) {
@@ -4321,11 +4319,11 @@ namespace FourSlashInterface {
             this.state.verifyQuickInfoDisplayParts(kind, kindModifiers, textSpan, displayParts, documentation, tags);
         }
 
-        public getSyntacticDiagnostics(expected: string) {
+        public getSyntacticDiagnostics(expected: ReadonlyArray<ts.RealizedDiagnostic>) {
             this.state.getSyntacticDiagnostics(expected);
         }
 
-        public getSemanticDiagnostics(expected: string) {
+        public getSemanticDiagnostics(expected: ReadonlyArray<ts.RealizedDiagnostic>) {
             this.state.getSemanticDiagnostics(expected);
         }
 

src/services/shims.ts

@@ -581,7 +581,7 @@ namespace ts {
         }
     }
 
-    interface RealizedDiagnostic {
+    export interface RealizedDiagnostic {
         message: string;
         start: number;
         length: number;

tests/cases/fourslash/fourslash.ts

@@ -347,8 +347,8 @@ declare namespace FourSlashInterface {
             start: number;
             length: number;
         }, displayParts: ts.SymbolDisplayPart[], documentation: ts.SymbolDisplayPart[], tags: ts.JSDocTagInfo[]): void;
-        getSyntacticDiagnostics(expected: string): void;
-        getSemanticDiagnostics(expected: string): void;
+        getSyntacticDiagnostics(expected: ReadonlyArray<RealizedDiagnostic>): void;
+        getSemanticDiagnostics(expected: ReadonlyArray<RealizedDiagnostic>): void;
         ProjectInfo(expected: string[]): void;
         allRangesAppearInImplementationList(markerName: string): void;
     }
@@ -520,6 +520,13 @@ declare namespace FourSlashInterface {
         text: string;
         range: Range;
     }
+    interface RealizedDiagnostic {
+        message: string;
+        start: number;
+        length: number;
+        category: string;
+        code: number;
+    }
 }
 declare function verifyOperationIsCancelled(f: any): void;
 declare var test: FourSlashInterface.test_;

tests/cases/fourslash/getJavaScriptSyntacticDiagnostics1.ts

@@ -4,12 +4,12 @@
 // @Filename: a.js
 //// import a = b;
 
-verify.getSyntacticDiagnostics(`[
+verify.getSyntacticDiagnostics([
   {
-    "message": "'import ... =' can only be used in a .ts file.",
-    "start": 0,
-    "length": 13,
-    "category": "error",
-    "code": 8002
+    message: "'import ... =' can only be used in a .ts file.",
+    start: 0,
+    length: 13,
+    category: "error",
+    code: 8002
   }
-]`);
+]);

tests/cases/fourslash/getJavaScriptSyntacticDiagnostics10.ts

@@ -4,12 +4,12 @@
 // @Filename: a.js
 //// function F<T>() { }
 
-verify.getSyntacticDiagnostics(`[
+verify.getSyntacticDiagnostics([
   {
-    "message": "'type parameter declarations' can only be used in a .ts file.",
-    "start": 11,
-    "length": 1,
-    "category": "error",
-    "code": 8004
+    message: "'type parameter declarations' can only be used in a .ts file.",
+    start: 11,
+    length: 1,
+    category: "error",
+    code: 8004
   }
-]`);
+]);

tests/cases/fourslash/getJavaScriptSyntacticDiagnostics11.ts

@@ -4,12 +4,12 @@
 // @Filename: a.js
 //// function F(): number { }
 
-verify.getSyntacticDiagnostics(`[
+verify.getSyntacticDiagnostics([
   {
-    "message": "'types' can only be used in a .ts file.",
-    "start": 14,
-    "length": 6,
-    "category": "error",
-    "code": 8010
+    message: "'types' can only be used in a .ts file.",
+    start: 14,
+    length: 6,
+    category: "error",
+    code: 8010
   }
-]`);
+]);

tests/cases/fourslash/getJavaScriptSyntacticDiagnostics12.ts

@@ -4,12 +4,12 @@
 // @Filename: a.js
 //// declare var v;
 
-verify.getSyntacticDiagnostics(`[
+verify.getSyntacticDiagnostics([
   {
-    "message": "'declare' can only be used in a .ts file.",
-    "start": 0,
-    "length": 7,
-    "category": "error",
-    "code": 8009
+    message: "'declare' can only be used in a .ts file.",
+    start: 0,
+    length: 7,
+    category: "error",
+    code: 8009
   }
-]`);
+]);

tests/cases/fourslash/getJavaScriptSyntacticDiagnostics13.ts

@@ -4,12 +4,12 @@
 // @Filename: a.js
 //// var v: () => number;
 
-verify.getSyntacticDiagnostics(`[
+verify.getSyntacticDiagnostics([
   {
-    "message": "'types' can only be used in a .ts file.",
-    "start": 7,
-    "length": 12,
-    "category": "error",
-    "code": 8010
+    message: "'types' can only be used in a .ts file.",
+    start: 7,
+    length: 12,
+    category: "error",
+    code: 8010
   }
-]`);
+]);

tests/cases/fourslash/getJavaScriptSyntacticDiagnostics14.ts

@@ -4,12 +4,12 @@
 // @Filename: a.js
 //// Foo<number>();
 
-verify.getSyntacticDiagnostics(`[
+verify.getSyntacticDiagnostics([
   {
-    "message": "'type arguments' can only be used in a .ts file.",
-    "start": 4,
-    "length": 6,
-    "category": "error",
-    "code": 8011
+    message: "'type arguments' can only be used in a .ts file.",
+    start: 4,
+    length: 6,
+    category: "error",
+    code: 8011
   }
-]`);
+]);

tests/cases/fourslash/getJavaScriptSyntacticDiagnostics15.ts

@@ -4,12 +4,12 @@
 // @Filename: a.js
 //// function F(public p) { }
 
-verify.getSyntacticDiagnostics(`[
+verify.getSyntacticDiagnostics([
   {
-    "message": "'parameter modifiers' can only be used in a .ts file.",
-    "start": 11,
-    "length": 6,
-    "category": "error",
-    "code": 8012
+    message: "'parameter modifiers' can only be used in a .ts file.",
+    start: 11,
+    length: 6,
+    category: "error",
+    code: 8012
   }
-]`);
+]);