Simplify fourslash tests by adding some helpers

Author: Andy Hanson

src/harness/fourslash.ts

@@ -372,8 +372,8 @@ namespace FourSlash {
         }
 
         // Entry points from fourslash.ts
-        public goToMarker(name = "") {
-            const marker = this.getMarkerByName(name);
+        public goToMarker(name: string | Marker = "") {
+            const marker = typeof name === "string" ? this.getMarkerByName(name) : name;
             if (this.activeFile.fileName !== marker.fileName) {
                 this.openFile(marker.fileName);
             }
@@ -382,10 +382,37 @@ namespace FourSlash {
             if (marker.position === -1 || marker.position > content.length) {
                 throw new Error(`Marker "${name}" has been invalidated by unrecoverable edits to the file.`);
             }
-            this.lastKnownMarker = name;
+            const mName = typeof name === "string" ? name : this.markerName(marker);
+            this.lastKnownMarker = mName;
             this.goToPosition(marker.position);
         }
 
+        public goToEachMarker(action: () => void) {
+            const markers = this.getMarkers();
+            assert(markers.length);
+            for (const marker of markers) {
+                this.goToMarker(marker);
+                action();
+            }
+        }
+
+        public goToEachRange(action: () => void) {
+            const ranges = this.getRanges();
+            assert(ranges.length);
+            for (const range of ranges) {
+                this.goToRangeStart(range);
+                action();
+            }
+        }
+
+        private markerName(m: Marker): string {
+            return ts.forEachEntry(this.testData.markerPositions, (marker, name) => {
+                if (marker === m) {
+                    return name;
+                }
+            })!;
+        }
+
         public goToPosition(pos: number) {
             this.currentCaretPosition = pos;
         }
@@ -1668,7 +1695,7 @@ namespace FourSlash {
             this.goToPosition(len);
         }
 
-        private goToRangeStart({fileName, start}: Range) {
+        public goToRangeStart({fileName, start}: Range) {
             this.openFile(fileName);
             this.goToPosition(start);
         }
@@ -2365,6 +2392,21 @@ namespace FourSlash {
             return this.languageService.getDocumentHighlights(this.activeFile.fileName, this.currentCaretPosition, filesToSearch);
         }
 
+        public verifyRangesAreOccurrences(isWriteAccess?: boolean) {
+            const ranges = this.getRanges();
+            for (const r of ranges) {
+                this.goToRangeStart(r);
+                this.verifyOccurrencesAtPositionListCount(ranges.length);
+                for (const range of ranges) {
+                    this.verifyOccurrencesAtPositionListContains(range.fileName, range.start, range.end, isWriteAccess);
+                }
+            }
+        }
+
+        public verifyRangesAreRenameLocations(findInStrings: boolean, findInComments: boolean) {
+            this.goToEachRange(() => this.verifyRenameLocations(findInStrings, findInComments));
+        }
+
         public verifyRangesWithSameTextAreDocumentHighlights() {
             this.rangesByText().forEach(ranges => this.verifyRangesAreDocumentHighlights(ranges));
         }
@@ -3078,10 +3120,22 @@ namespace FourSlashInterface {
         // Moves the caret to the specified marker,
         // or the anonymous marker ('/**/') if no name
         // is given
-        public marker(name?: string) {
+        public marker(name?: string | FourSlash.Marker) {
             this.state.goToMarker(name);
         }
 
+        public eachMarker(action: () => void) {
+            this.state.goToEachMarker(action);
+        }
+
+        public rangeStart(range: FourSlash.Range) {
+            this.state.goToRangeStart(range);
+        }
+
+        public eachRange(action: () => void) {
+            this.state.goToEachRange(action);
+        }
+
         public bof() {
             this.state.goToBOF();
         }
@@ -3432,6 +3486,14 @@ namespace FourSlashInterface {
             this.state.verifyOccurrencesAtPositionListCount(expectedCount);
         }
 
+        public rangesAreOccurrences(isWriteAccess?: boolean) {
+            this.state.verifyRangesAreOccurrences(isWriteAccess);
+        }
+
+        public rangesAreRenameLocations(findInStrings = false, findInComments = false) {
+            this.state.verifyRangesAreRenameLocations(findInStrings, findInComments);
+        }
+
         public rangesAreDocumentHighlights(ranges?: FourSlash.Range[]) {
             this.state.verifyRangesAreDocumentHighlights(ranges);
         }

tests/cases/fourslash/completionListAtIdentifierDefinitionLocations_Generics.ts

@@ -11,8 +11,4 @@
 
 ////function A</*genericName5*/
 
-
-test.markers().forEach((m) => {
-    goTo.position(m.position, m.fileName);
-    verify.completionListIsEmpty();
-});
+goTo.eachMarker(() => verify.completionListIsEmpty());

tests/cases/fourslash/completionListAtIdentifierDefinitionLocations_catch.ts

@@ -6,8 +6,4 @@
 
 //// try {} catch(a/*catchVariable2*/
 
-
-test.markers().forEach((m) => {
-    goTo.position(m.position, m.fileName);
-    verify.completionListIsEmpty();
-});
+goTo.eachMarker(() => verify.completionListIsEmpty());

tests/cases/fourslash/completionListAtIdentifierDefinitionLocations_classes.ts

@@ -6,7 +6,4 @@
 
 ////class a/*className2*/
 
-test.markers().forEach((m) => {
-    goTo.position(m.position, m.fileName);
-    verify.completionListIsEmpty();
-});
+goTo.eachMarker(() => verify.completionListIsEmpty());

tests/cases/fourslash/completionListAtIdentifierDefinitionLocations_destructuring.ts

@@ -16,7 +16,4 @@
 
 //// function func2({ a, b/*parameter2*/
 
-test.markers().forEach(m => {
-    goTo.position(m.position, m.fileName);
-    verify.completionListIsEmpty();
-});
+goTo.eachMarker(() => verify.completionListIsEmpty());

tests/cases/fourslash/completionListAtIdentifierDefinitionLocations_enumMembers.ts

@@ -4,8 +4,4 @@
 
 ////enum a { /*enumValueName1*/
 
-
-test.markers().forEach((m) => {
-    goTo.position(m.position, m.fileName);
-    verify.completionListIsEmpty();
-});
+goTo.eachMarker(() => verify.completionListIsEmpty());

tests/cases/fourslash/completionListAtIdentifierDefinitionLocations_enumMembers2.ts

@@ -3,7 +3,4 @@
 ////var aa = 1;
 ////enum a { foo, /*enumValueName3*/
 
-test.markers().forEach((m) => {
-    goTo.position(m.position, m.fileName);
-    verify.completionListIsEmpty();
-});
+goTo.eachMarker(() => verify.completionListIsEmpty());

tests/cases/fourslash/completionListAtIdentifierDefinitionLocations_enums.ts

@@ -8,7 +8,4 @@
 
 ////var x = 0; enum /*enumName4*/
 
-test.markers().forEach((m) => {
-    goTo.position(m.position, m.fileName);
-    verify.completionListIsEmpty();
-});
+goTo.eachMarker(() => verify.completionListIsEmpty());

tests/cases/fourslash/completionListAtIdentifierDefinitionLocations_functions.ts

@@ -6,8 +6,4 @@
 
 ////function a/*functionName2*/
 
-
-test.markers().forEach((m) => {
-    goTo.position(m.position, m.fileName);
-    verify.completionListIsEmpty();
-});
+goTo.eachMarker(() => verify.completionListIsEmpty());

tests/cases/fourslash/completionListAtIdentifierDefinitionLocations_interfaceMembers.ts

@@ -4,7 +4,4 @@
 
 ////interface a { /*interfaceValue1*/
 
-test.markers().forEach((m) => {
-    goTo.position(m.position, m.fileName);
-    verify.completionListIsEmpty();
-});
+goTo.eachMarker(() => verify.completionListIsEmpty());