Implement a temporary workaround for Issue #1095 based on a hardcoded…

… list of common names
microsoft · Feb 12, 2019 · d120a59 · d120a59
1 parent 79991cb
commit d120a59
Show file tree

Hide file tree

Showing 3 changed files with 71 additions and 3 deletions.
diff --git a/apps/api-extractor/src/collector/Collector.ts b/apps/api-extractor/src/collector/Collector.ts
@@ -336,6 +336,7 @@ export class Collector {
    */
   private _makeUniqueNames(): void {
     const usedNames: Set<string> = new Set<string>();
+    this._collectGlobalNames(usedNames);
 
     // First collect the explicit package exports (named)
     for (const entity of this._entities) {
@@ -375,6 +376,73 @@ export class Collector {
     }
   }
 
+  /**
+   * Adds global names to the usedNames set, to prevent API Extractor from emitting names that conflict with
+   * a global name.
+   */
+  private _collectGlobalNames(usedNames: Set<string>): void {
+    // As a temporary workaround, this a short list of names that appear in typical projects.
+    // The full solution is tracked by this issue:
+    // https://github.com/Microsoft/web-build-tools/issues/1095
+    const globalNames: string[] = [
+      'Array',
+      'ArrayConstructor',
+      'Console',
+      'Date',
+      'DateConstructor',
+      'Error',
+      'ErrorConstructor',
+      'Float32Array',
+      'Float32ArrayConstructor',
+      'Float64Array',
+      'Float64ArrayConstructor',
+      'IArguments',
+      'Int16Array',
+      'Int16ArrayConstructor',
+      'Int32Array',
+      'Int32ArrayConstructor',
+      'Int8Array',
+      'Int8ArrayConstructor',
+      'Iterable',
+      'IterableIterator',
+      'Iterator',
+      'IteratorResult',
+      'Map',
+      'MapConstructor',
+      'Promise',
+      'PromiseConstructor',
+      'ReadonlyArray',
+      'ReadonlyMap',
+      'ReadonlySet',
+      'Set',
+      'SetConstructor',
+      'String',
+      'Symbol',
+      'SymbolConstructor',
+      'Uint16Array',
+      'Uint16ArrayConstructor',
+      'Uint32Array',
+      'Uint32ArrayConstructor',
+      'Uint8Array',
+      'Uint8ArrayConstructor',
+      'Uint8ClampedArray',
+      'Uint8ClampedArrayConstructor',
+      'WeakMap',
+      'WeakMapConstructor',
+      'WeakSet',
+      'WeakSetConstructor',
+      'clearInterval',
+      'clearTimeout',
+      'console',
+      'setInterval',
+      'setTimeout',
+      'undefined'
+    ];
+    for (const globalName of globalNames) {
+      usedNames.add(globalName);
+    }
+  }
+
   /**
    * Reports an error message to the registered ApiErrorHandler.
    */

diff --git a/...i-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.ts b/...i-extractor-scenarios/etc/test-outputs/ambientNameConflict/api-extractor-scenarios.api.ts
@@ -1,5 +1,5 @@
 // @public (undocumented)
-declare function ambientNameConflict(p1: Promise<void>, p2: Promise<void>): void;
+declare function ambientNameConflict(p1: Promise<void>, p2: Promise_2<void>): void;
 
 
 // (No @packageDocumentation comment for this package)
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/rollup.d.ts b/build-tests/api-extractor-scenarios/etc/test-outputs/ambientNameConflict/rollup.d.ts
@@ -2,12 +2,12 @@
 /**
  * @public
  */
-export declare function ambientNameConflict(p1: Promise<void>, p2: Promise<void>): void;
+export declare function ambientNameConflict(p1: Promise<void>, p2: Promise_2<void>): void;
 
 /**
  * @public
  */
-declare class Promise<T> {
+declare class Promise_2<T> {
     notTheRealPromise(arg: T): void;
 }