Add a test case to repro GitHub #2797

octogonz · octogonz · commit 4c4151b2b085 · 2021-07-08T16:11:17.000-07:00
diff --git a/apps/api-extractor/.vscode/launch.json b/apps/api-extractor/.vscode/launch.json
@@ -79,7 +79,7 @@
         "run",
         "--local",
         "--config",
-        "./temp/configs/api-extractor-exportImportStarAs2.json"
+        "./temp/configs/api-extractor-spanSorting.json"
       ],
       "sourceMaps": true
     }
diff --git a/apps/api-extractor/src/analyzer/Span.ts b/apps/api-extractor/src/analyzer/Span.ts
@@ -403,6 +403,49 @@ export class Span {
     return result;
   }
 
+  /**
+   * Returns a diagnostic dump of the tree, showing the SpanModification settings for each nodde.
+   */
+  public getModifiedDump(indent: string = ''): string {
+    let result: string = indent + ts.SyntaxKind[this.node.kind] + ': ';
+
+    if (this.prefix) {
+      result += ' pre=[' + this._getTrimmed(this.modification.prefix) + ']';
+    }
+    if (this.suffix) {
+      result += ' suf=[' + this._getTrimmed(this.modification.suffix) + ']';
+    }
+    if (this.separator) {
+      result += ' sep=[' + this._getTrimmed(this.separator) + ']';
+    }
+    if (this.modification.indentDocComment !== IndentDocCommentScope.None) {
+      result += ' indentDocComment=' + IndentDocCommentScope[this.modification.indentDocComment];
+    }
+    if (this.modification.omitChildren) {
+      result += ' omitChildren';
+    }
+    if (this.modification.omitSeparatorAfter) {
+      result += ' omitSeparatorAfter';
+    }
+    if (this.modification.sortChildren) {
+      result += ' sortChildren';
+    }
+    if (this.modification.sortKey !== undefined) {
+      result += ` sortKey="${this.modification.sortKey}"`;
+    }
+    result += '\n';
+
+    if (!this.modification.omitChildren) {
+      for (const child of this.children) {
+        result += child.getModifiedDump(indent + '  ');
+      }
+    } else {
+      result += `${indent}  (${this.children.length} children)\n`;
+    }
+
+    return result;
+  }
+
   /**
    * Recursive implementation of `getModifiedText()` and `writeModifiedText()`.
    */
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/spanSorting/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/spanSorting/api-extractor-scenarios.api.json
@@ -351,6 +351,27 @@
             }
           ],
           "implementsTokenRanges": []
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "api-extractor-scenarios!exampleD:var",
+          "docComment": "/**\n * Outer description\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "exampleD: "
+            },
+            {
+              "kind": "Content",
+              "text": "(o: {\n    a: number;\n    b(): string;\n}) => void"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "exampleD",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
         }
       ]
     }
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/spanSorting/api-extractor-scenarios.api.md b/build-tests/api-extractor-scenarios/etc/test-outputs/spanSorting/api-extractor-scenarios.api.md
@@ -22,6 +22,12 @@ export class ExampleC {
     member1(): void;
 }
 
+// @public
+export const exampleD: (o: {
+    a: number;
+    b(): string;
+}) => void;
+
 // (No @packageDocumentation comment for this package)
 
 ```
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/spanSorting/rollup.d.ts b/build-tests/api-extractor-scenarios/etc/test-outputs/spanSorting/rollup.d.ts
@@ -35,4 +35,19 @@ export declare class ExampleC {
     member1(): void;
 }
 
+/**
+ * Outer description
+ */
+export declare const exampleD: (o: {
+    /**
+     * Inner description
+     */
+    a: number;
+    /**
+     * @returns a string
+     * {@link http://example.com}
+     */
+    b(): string;
+}) => void;
+
 export { }
diff --git a/build-tests/api-extractor-scenarios/src/spanSorting/index.ts b/build-tests/api-extractor-scenarios/src/spanSorting/index.ts
@@ -39,3 +39,19 @@ export class ExampleC {
      */
   public member1(): void {}
 }
+
+/**
+ * Outer description
+ */
+export const exampleD = (o: {
+  /**
+   * Inner description
+   */
+  a: number;
+
+  /**
+   * @returns a string
+   * {@link http://example.com}
+   */
+  b(): string;
+}) => {};

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@`
`79`	`79`	`"run",`
`80`	`80`	`"--local",`
`81`	`81`	`"--config",`
`82`		`- "./temp/configs/api-extractor-exportImportStarAs2.json"`
	`82`	`+ "./temp/configs/api-extractor-spanSorting.json"`
`83`	`83`	`],`
`84`	`84`	`"sourceMaps": true`
`85`	`85`	`}`