Rename and simplify fourslash interface

aozgaa · aozgaa · commit e5279fd828fb · 2016-11-02T12:39:55.000-07:00
diff --git a/src/harness/fourslash.ts b/src/harness/fourslash.ts
@@ -92,11 +92,14 @@ namespace FourSlash {
         end: number;
     }
 
-    export interface ErrorIdentifier {
+    export interface CodeFixIdentifier {
+        /**
+         * Error code to search over for codefix.
+         */
         code: number;
         /**
          * In a file where there is more than one error with code `code`, `count` refers
-         * to which 0-indexed error, sorted by order of occurence, to consider.
+         * to which 0-indexed codefix, sorted by order of occurence, to consider.
          */
         count: number;
     }
@@ -2022,14 +2025,14 @@ namespace FourSlash {
          * Because codefixes are only applied on the working file, it is unsafe
          * to apply this more than once (consider a refactoring across files).
          */
-        public verifyCodeFixAtPosition(expectedText: string, errorCode?: number) {
+        public verifyRangeAfterCodeFix(expectedText: string, codeFixIdentifier?: CodeFixIdentifier) {
             const ranges = this.getRanges();
             if (ranges.length !== 1) {
                 this.raiseError("Exactly one range should be specified in the testfile.");
             }
 
             const fileName = this.activeFile.fileName;
-            const codeFix: ts.CodeAction = this.getCodeFix(fileName, errorCode ? { code: errorCode, count: 0 } : undefined);
+            const codeFix: ts.CodeAction = this.getCodeFix(fileName, codeFixIdentifier);
 
             if (!codeFix) {
                 this.raiseError("Should find exactly one codefix.");
@@ -2052,37 +2055,36 @@ namespace FourSlash {
          * Applies fixes for the errors in fileName and compares the results to
          * expectedContents after all fixes have been applied.
          * 
+         * It is safe to apply this multiple times in a single test.
+         *
          * Note: applying one codefix may generate another (eg: remove duplicate implements
          * may generate an extends -> interface conversion fix).
          * @param expectedContents The contents of the file after the fixes are applied.
          * @param fileName The file to check. If not supplied, the current open file is used.
          * @param errorsToFix An array of errors for which quickfixes will be applied. If not
          * supplied, all codefixes in the file are applied until none are left, starting from
          * the first available codefix.
-         * 
+         *
          */
-        public verifyFileAfterCodeFix(expectedContents: string, fileName?: string, errorsToFix?: ErrorIdentifier[]) {
+        public verifyFileAfterCodeFix(expectedContents: string, fileName?: string, codeFixIdentifier?: CodeFixIdentifier) {
             fileName = fileName ? fileName : this.activeFile.fileName;
 
-            if (errorsToFix) {
-                for (const error of errorsToFix) {
-                    const fix = this.getCodeFix(fileName, error);
-                    if (fix === undefined) {
-                        this.raiseError(`Couldn't find the ${error.count}'th error with code ${error.code}.`);
-                    }
-                    this.applyCodeAction(fix);
+            const codeFix = this.getCodeFix(fileName, codeFixIdentifier);
+
+            if (codeFix === undefined) {
+                if (codeFixIdentifier) {
+                    this.raiseError(`Couldn't find the ${codeFixIdentifier.count}'th error with code ${codeFixIdentifier.code}.`);
                 }
-            }
-            else {
-                let fix: ts.CodeAction;
-                while (fix = this.getCodeFix(fileName)) {
-                    this.applyCodeAction(fix);
+                else {
+                    this.raiseError("No code fix could be found.");
                 }
             }
 
+            this.applyCodeAction(codeFix);
+
             const actualContents: string = this.getFileContent(fileName);
             if (this.removeWhitespace(actualContents) !== this.removeWhitespace(expectedContents)) {
-                this.raiseError(`Actual text doesn't match expected text. Actual:\n${actualContents}\n\nExpected:\n${expectedContents}`);
+                this.raiseError(`Actual text doesn't match expected text. Actual:\n${actualContents}\n\nExpected:\n\n${expectedContents}`);
             }
         }
 
@@ -2093,7 +2095,7 @@ namespace FourSlash {
          * 
          * If undefined, we get the first codefix available.
          */
-        private getCodeFix(fileName: string, error?: ErrorIdentifier): ts.CodeAction | undefined {
+        private getCodeFix(fileName: string, error?: CodeFixIdentifier): ts.CodeAction | undefined {
             const diagnostics: ts.Diagnostic[] = this.getDiagnostics(fileName);
             const errorCount = error ? error.count : 0;
 
@@ -3364,12 +3366,12 @@ namespace FourSlashInterface {
             this.DocCommentTemplate(/*expectedText*/ undefined, /*expectedOffset*/ undefined, /*empty*/ true);
         }
 
-        public codeFixAtPosition(expectedText: string, errorCode?: number): void {
-            this.state.verifyCodeFixAtPosition(expectedText, errorCode);
+        public rangeAfterCodeFix(expectedText: string, codeFixidentifier?: FourSlash.CodeFixIdentifier): void {
+            this.state.verifyRangeAfterCodeFix(expectedText, codeFixidentifier);
         }
 
-        public fileAfterCodeFixes(expectedContents: string, fileName?: string, errorsToFix?: FourSlash.ErrorIdentifier[]): void {
-            this.state.verifyFileAfterCodeFix(expectedContents, fileName, errorsToFix);
+        public fileAfterCodeFix(expectedContents: string, fileName?: string, codeFixidentifier?: FourSlash.CodeFixIdentifier): void {
+            this.state.verifyFileAfterCodeFix(expectedContents, fileName, codeFixidentifier);
         }
 
         public navigationBar(json: any) {
diff --git a/tests/cases/fourslash/codeFixAddSuperCall.ts b/tests/cases/fourslash/codeFixAddSuperCall.ts
@@ -7,4 +7,4 @@
 ////    }
 ////}
 
-verify.codeFixAtPosition('super();');
+verify.rangeAfterCodeFix('super();');
diff --git a/tests/cases/fourslash/codeFixChangeExtendsToImplementsFS1.ts b/tests/cases/fourslash/codeFixChangeExtendsToImplementsFS1.ts
@@ -3,4 +3,4 @@
 //// interface I1 {}
 //// [|class c1 extends I1|]{}
 
-verify.codeFixAtPosition("class c1 implements I1");
+verify.rangeAfterCodeFix("class c1 implements I1");
diff --git a/tests/cases/fourslash/codeFixChangeExtendsToImplementsFS2.ts b/tests/cases/fourslash/codeFixChangeExtendsToImplementsFS2.ts
@@ -3,4 +3,4 @@
 ////interface I1 {}
 ////[|class c1<T extends string , U> extends I1|]{}
 
-verify.codeFixAtPosition("class c1<T extends string , U> implements I1");
+verify.rangeAfterCodeFix("class c1<T extends string , U> implements I1");
diff --git a/tests/cases/fourslash/codeFixClassExtendsAbstractFunction.ts b/tests/cases/fourslash/codeFixClassExtendsAbstractFunction.ts
@@ -7,7 +7,7 @@
 //// class C extends A {[|
 //// |]}
 
-verify.codeFixAtPosition(`f(){
+verify.rangeAfterCodeFix(`f(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixClassExtendsAbstractNumber.ts b/tests/cases/fourslash/codeFixClassExtendsAbstractNumber.ts
@@ -7,6 +7,6 @@
 //// class C extends A {[|
 //// |]}
 
-verify.codeFixAtPosition(`
+verify.rangeAfterCodeFix(`
 abstract x: number;
 `);
diff --git a/tests/cases/fourslash/codeFixClassExtendsAbstractProtectedNumber.ts b/tests/cases/fourslash/codeFixClassExtendsAbstractProtectedNumber.ts
@@ -7,6 +7,6 @@
 //// class C extends A {[|
 //// |]}
 
-verify.codeFixAtPosition(`
+verify.rangeAfterCodeFix(`
 protected abstract x: number;
 `);
diff --git a/tests/cases/fourslash/codeFixClassExtendsAbstractPublicNumber.ts b/tests/cases/fourslash/codeFixClassExtendsAbstractPublicNumber.ts
@@ -7,6 +7,6 @@
 //// class C extends A {[|
 //// |]}
 
-verify.codeFixAtPosition(`
+verify.rangeAfterCodeFix(`
 public abstract x: number;
 `);
diff --git a/tests/cases/fourslash/codeFixInterfaceInExtendsClause.ts b/tests/cases/fourslash/codeFixInterfaceInExtendsClause.ts
@@ -1,14 +1,9 @@
 /// <reference path='fourslash.ts' />
 
-//// interface I1 { }
-//// class C1 extends I1 { }
-//// interface I2 { }
-//// class C2 extends I2 { }
+//// interface I { }
+//// class C extends I { }
 
-// verify.codeFixAvailable();
-verify.fileAfterCodeFixes(`
-interface I1 { }
-class C1 implements I1 { }
-interface I2 { }
-class C2 implements I2 { }
+verify.fileAfterCodeFix(`
+interface I { }
+class C implements I { }
 `);
diff --git a/tests/cases/fourslash/codeFixReOrderSuper.ts b/tests/cases/fourslash/codeFixReOrderSuper.ts
@@ -10,4 +10,4 @@
 ////    }
 ////}
 
-verify.codeFixAtPosition("super(); this.a = 12;");
+verify.rangeAfterCodeFix("super(); this.a = 12;");
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterface36.ts b/tests/cases/fourslash/codeFixUnImplementedInterface36.ts
@@ -14,7 +14,7 @@
 ////
 //// |]}
 
-verify.codeFixAtPosition(`f1<T extends number>(){
+verify.rangeAfterCodeFix(`f1<T extends number>(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterface37.ts b/tests/cases/fourslash/codeFixUnImplementedInterface37.ts
@@ -14,7 +14,7 @@
 ////
 //// |]}
 
-verify.codeFixAtPosition(`f1<T extends number>(){
+verify.rangeAfterCodeFix(`f1<T extends number>(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterface39.ts b/tests/cases/fourslash/codeFixUnImplementedInterface39.ts
@@ -12,7 +12,7 @@
 //// class C1 implements N1.I1 {[|
 //// |]}
 
-verify.codeFixAtPosition(`f1():string{
+verify.rangeAfterCodeFix(`f1():string{
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingAbstractFunctionGenericParamExtendsNumber.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingAbstractFunctionGenericParamExtendsNumber.ts
@@ -8,7 +8,7 @@
 ////
 //// |]}
 
-verify.codeFixAtPosition(`f1<T extends number>(){
+verify.rangeAfterCodeFix(`f1<T extends number>(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingAbstractFunctionGenericParamExtendsNumberViaHeritageClause.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingAbstractFunctionGenericParamExtendsNumberViaHeritageClause.ts
@@ -12,7 +12,7 @@
 ////     |]f2(){}
 //// }
 
-verify.codeFixAtPosition(`f1<T extends number>(){
+verify.rangeAfterCodeFix(`f1<T extends number>(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingAbstractFunctionGenericParamExtendsNumberViaHeritageClause2.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingAbstractFunctionGenericParamExtendsNumberViaHeritageClause2.ts
@@ -10,7 +10,7 @@
 ////
 //// |]}
 
-verify.codeFixAtPosition(`f1<T extends number>(){
+verify.rangeAfterCodeFix(`f1<T extends number>(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingAbstractFunctionGenericParamViaHeritageClause.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingAbstractFunctionGenericParamViaHeritageClause.ts
@@ -12,7 +12,7 @@
 ////     |]f2(){}
 //// }
 
-verify.codeFixAtPosition(`f1<T>(){
+verify.rangeAfterCodeFix(`f1<T>(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingAbstractFunctionViaHeritageClause.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingAbstractFunctionViaHeritageClause.ts
@@ -12,7 +12,7 @@
 ////     |]f2(){}
 //// }
 
-verify.codeFixAtPosition(`f1(){
+verify.rangeAfterCodeFix(`f1(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunction.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunction.ts
@@ -12,7 +12,7 @@
 //// class C1 implements N1.I1 {[|
 //// |]}
 
-verify.codeFixAtPosition(`f1(){
+verify.rangeAfterCodeFix(`f1(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionAndExtends.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionAndExtends.ts
@@ -11,7 +11,7 @@
 //// class C1 implements I2 {[|
 //// |]}
 
-verify.codeFixAtPosition(`f1(){
+verify.rangeAfterCodeFix(`f1(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionFromAbstract.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionFromAbstract.ts
@@ -8,7 +8,7 @@
 ////     |]f2(){}
 //// }
 
-verify.codeFixAtPosition(`f1(){
+verify.rangeAfterCodeFix(`f1(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionFromAbstractClassViaHeritageClause.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionFromAbstractClassViaHeritageClause.ts
@@ -12,7 +12,7 @@
 ////     |]f2(){}
 //// }
 
-verify.codeFixAtPosition(`f1(){
+verify.rangeAfterCodeFix(`f1(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionFromHeritageClause1.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionFromHeritageClause1.ts
@@ -11,7 +11,7 @@
 //// class C1 implements I2 {[|
 //// |]}
 
-verify.codeFixAtPosition(`f1(){
+verify.rangeAfterCodeFix(`f1(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionFromHeritageClause2.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionFromHeritageClause2.ts
@@ -13,7 +13,7 @@
 //// class C1 implements I3 {[|
 //// |]}
 
-verify.codeFixAtPosition(`f1(){
+verify.rangeAfterCodeFix(`f1(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionFromHeritageClause3.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionFromHeritageClause3.ts
@@ -13,7 +13,7 @@
 //// class C1 implements I3 {[|
 //// |]}
 
-verify.codeFixAtPosition(`f1(){
+verify.rangeAfterCodeFix(`f1(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionFromHeritageClause4.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionFromHeritageClause4.ts
@@ -13,7 +13,7 @@
 //// class C1 implements I3 {[|
 //// |]}
 
-verify.codeFixAtPosition(`f1(){
+verify.rangeAfterCodeFix(`f1(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionGenericParamExtendsString.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionGenericParamExtendsString.ts
@@ -9,7 +9,7 @@
 //// class C1 implements I1 {[|
 //// |]}
 
-verify.codeFixAtPosition(`f1<T extends string>(x: number,y: C2){
+verify.rangeAfterCodeFix(`f1<T extends string>(x: number,y: C2){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionGenericParams.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionGenericParams.ts
@@ -9,7 +9,7 @@
 //// class C1 implements I1 {[|
 //// |]}
 
-verify.codeFixAtPosition(`f1<T>(x: number,y: C2){
+verify.rangeAfterCodeFix(`f1<T>(x: number,y: C2){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionNoSemicolon.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionNoSemicolon.ts
@@ -12,7 +12,7 @@
 //// class C1 implements N1.I1 {[|
 //// |]}
 
-verify.codeFixAtPosition(`f1(){
+verify.rangeAfterCodeFix(`f1(){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionWithParams.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionWithParams.ts
@@ -12,7 +12,7 @@
 //// class C1 implements N1.I1 {[|
 //// |]}
 
-verify.codeFixAtPosition(`f1(x: number,y: string){
+verify.rangeAfterCodeFix(`f1(x: number,y: string){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionWithParamsClass.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingFunctionWithParamsClass.ts
@@ -9,7 +9,7 @@
 //// class C1 implements I1 {[|
 //// |]}
 
-verify.codeFixAtPosition(`f1(x: number,y: T){
+verify.rangeAfterCodeFix(`f1(x: number,y: T){
     throw new Error('Method not Implemented');
 }
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingNumber.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingNumber.ts
@@ -12,5 +12,5 @@
 //// class C1 implements N1.I1 {[|
 //// |]}
 
-verify.codeFixAtPosition(`x: number;
+verify.rangeAfterCodeFix(`x: number;
 `);
diff --git a/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingNumberNoSemicolon.ts b/tests/cases/fourslash/codeFixUnImplementedInterfaceMissingNumberNoSemicolon.ts
diff --git a/tests/cases/fourslash/codeFixUnimplementedInterfaceMissingMultipleFunctions.ts b/tests/cases/fourslash/codeFixUnimplementedInterfaceMissingMultipleFunctions.ts
diff --git a/tests/cases/fourslash/codeFixUnimplementedInterfaceMissingMultipleFunctionsDeepInheritance.ts b/tests/cases/fourslash/codeFixUnimplementedInterfaceMissingMultipleFunctionsDeepInheritance.ts
diff --git a/tests/cases/fourslash/fourslash.ts b/tests/cases/fourslash/fourslash.ts
diff --git a/tests/cases/fourslash/server/codeFixAddSuperCall.ts b/tests/cases/fourslash/server/codeFixAddSuperCall.ts

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`//// class C extends A {[\|`
`8`	`8`	`//// \|]}`
`9`	`9`
`10`		-verify.codeFixAtPosition(`f(){
	`10`	+verify.rangeAfterCodeFix(`f(){
`11`	`11`	`throw new Error('Method not Implemented');`
`12`	`12`	`}`
`13`	`13`	`);