Only use one route for grabbing outline nodes, which now includes special casing the EOF token

Author: orta

src/harness/fourslashImpl.ts

@@ -2469,18 +2469,35 @@ namespace FourSlash {
 
         public printOutliningSpans() {
             const spans = this.languageService.getOutliningSpans(this.activeFile.fileName);
-            Harness.IO.log(`Outlining spans (${spans.length} items)`);
+            Harness.IO.log(`Outlining spans (${spans.length} items)\nResults:`);
             Harness.IO.log(stringify(spans));
+            this.printOutliningSpansInline(spans);
+        }
+
+        private printOutliningSpansInline(spans: ts.OutliningSpan[]) {
+            const allSpanInsets = [] as { text: string, pos: number }[];
+            let annotated = this.activeFile.content;
+            ts.forEach(spans, span => {
+                allSpanInsets.push({ text: "[|", pos: span.textSpan.start });
+                allSpanInsets.push({ text: "|]", pos: span.textSpan.start + span.textSpan.length });
+            });
+
+            const reverseSpans = allSpanInsets.sort((l, r) => r.pos - l.pos);
+            ts.forEach(reverseSpans, span => {
+               annotated = annotated.slice(0, span.pos) + span.text + annotated.slice(span.pos);
+            });
+            Harness.IO.log(`\nMockup:\n${annotated}`);
         }
 
         public verifyOutliningSpans(spans: Range[], kind?: "comment" | "region" | "code" | "imports") {
             const actual = this.languageService.getOutliningSpans(this.activeFile.fileName);
 
-            if (actual.length !== spans.length) {
-                this.raiseError(`verifyOutliningSpans failed - expected total spans to be ${spans.length}, but was ${actual.length}`);
+            const filterActual = ts.filter(actual, f => kind === undefined ? true : f.kind === kind);
+            if (filterActual.length !== spans.length) {
+                this.raiseError(`verifyOutliningSpans failed - expected total spans to be ${spans.length}, but was ${actual.length}\n\nFound Spans:\n\n${this.printOutliningSpansInline(actual)}`);
             }
 
-            ts.zipWith(spans, actual, (expectedSpan, actualSpan, i) => {
+            ts.zipWith(spans, filterActual, (expectedSpan, actualSpan, i) => {
                 if (expectedSpan.pos !== actualSpan.textSpan.start || expectedSpan.end !== ts.textSpanEnd(actualSpan.textSpan)) {
                     return this.raiseError(`verifyOutliningSpans failed - span ${(i + 1)} expected: (${expectedSpan.pos},${expectedSpan.end}),  actual: (${actualSpan.textSpan.start},${ts.textSpanEnd(actualSpan.textSpan)})`);
                 }

src/services/outliningElementsCollector.ts

@@ -4,14 +4,14 @@ namespace ts.OutliningElementsCollector {
         const res: OutliningSpan[] = [];
         addNodeOutliningSpans(sourceFile, cancellationToken, res);
         addRegionOutliningSpans(sourceFile, res);
-        addTopLevelUnattachedCommentSpans(sourceFile, res);
         return res.sort((span1, span2) => span1.textSpan.start - span2.textSpan.start);
     }
 
     function addNodeOutliningSpans(sourceFile: SourceFile, cancellationToken: CancellationToken, out: Push<OutliningSpan>): void {
         let depthRemaining = 40;
         let current = 0;
-        const statements = sourceFile.statements;
+        // Includes the EOF Token so that comments which aren't attached to statements are included
+        const statements = [...sourceFile.statements, sourceFile.endOfFileToken];
         const n = statements.length;
         while (current < n) {
             while (current < n && !isAnyImportSyntax(statements[current])) {
@@ -34,7 +34,7 @@ namespace ts.OutliningElementsCollector {
             if (depthRemaining === 0) return;
             cancellationToken.throwIfCancellationRequested();
 
-            if (isDeclaration(n)) {
+            if (isDeclaration(n) || n.kind === SyntaxKind.EndOfFileToken) {
                 addOutliningForLeadingCommentsForNode(n, sourceFile, cancellationToken, out);
             }
 
@@ -107,23 +107,6 @@ namespace ts.OutliningElementsCollector {
         return regionDelimiterRegExp.exec(lineText);
     }
 
-    function addTopLevelUnattachedCommentSpans(sourceFile: SourceFile, out: Push<OutliningSpan>): void {
-        // Comments which are attached to statements would be included in addNodeOutliningSpans
-        if (sourceFile.statements.length > 0) return;
-
-        // This will instead set up spans for the missing ones
-        forEach(getLeadingCommentRangesOfNode(sourceFile, sourceFile), (range) => {
-            // To not mess with // #region support
-            const isMultiline = sourceFile.text.substring(range.pos, 2) === "/*";
-            if (!isMultiline) return;
-
-            const span = createTextSpanFromBounds(range.pos, range.end);
-            const comment = sourceFile.text.substring(range.pos, range.end);
-            const outline = createOutliningSpan(span, OutliningSpanKind.Comment, span, /*autoCollapse*/ false, comment);
-            out.push(outline);
-        });
-    }
-
     function addOutliningForLeadingCommentsForNode(n: Node, sourceFile: SourceFile, cancellationToken: CancellationToken, out: Push<OutliningSpan>): void {
         const comments = getLeadingCommentRangesOfNode(n, sourceFile);
         if (!comments) return;
@@ -289,6 +272,9 @@ namespace ts.OutliningElementsCollector {
     }
 
     function createOutliningSpan(textSpan: TextSpan, kind: OutliningSpanKind, hintSpan: TextSpan = textSpan, autoCollapse = false, bannerText = "..."): OutliningSpan {
+        if(kind === OutliningSpanKind.Region) {
+            debugger;
+        }
         return { textSpan, kind, hintSpan, bannerText, autoCollapse };
     }
 }

tests/cases/fourslash/fourslash.ts

@@ -317,7 +317,7 @@ declare namespace FourSlashInterface {
         baselineQuickInfo(): void;
         baselineSmartSelection(): void;
         nameOrDottedNameSpanTextIs(text: string): void;
-        outliningSpansInCurrentFile(spans: Range[]): void;
+        outliningSpansInCurrentFile(spans: Range[], kind?: "comment" | "region" | "code" | "imports"): void;
         outliningHintSpansInCurrentFile(spans: Range[]): void;
         todoCommentsInCurrentFile(descriptors: string[]): void;
         matchingBracePositionInCurrentFile(bracePosition: number, expectedMatchPosition: number): void;

tests/cases/fourslash/outlineSpansTrailingBlockCommentsAfterStatements.ts

@@ -0,0 +1,10 @@
+/// <reference path="fourslash.ts"/>
+
+// #22732
+
+////console.log(0);
+////[|/*
+///// * Some text
+////  */|]
+
+verify.outliningHintSpansInCurrentFile(test.ranges());

tests/cases/fourslash/server/getOutliningSpansForRegions.ts

@@ -48,4 +48,4 @@
 ////// #endregion
 ////*/
 
-verify.outliningSpansInCurrentFile(test.ranges(), "region");
+verify.outliningSpansInCurrentFile(test.ranges(), "region");