Fix issue with duplicate yaml references

rbuckton · rbuckton · commit d395618ab0bc · 2019-09-10T11:03:37.000-07:00
diff --git a/apps/api-documenter/src/documenters/YamlDocumenter.ts b/apps/api-documenter/src/documenters/YamlDocumenter.ts
@@ -116,6 +116,12 @@ export class YamlDocumenter {
   }
 
   private _visitApiItems(apiItem: ApiDocumentedItem, parentYamlFile: IYamlApiFile | undefined): boolean {
+    let savedYamlReferences: IYamlReferences | undefined;
+    if (!this._shouldEmbed(apiItem.kind)) {
+      savedYamlReferences = this._yamlReferences;
+      this._yamlReferences = undefined;
+    }
+
     const yamlItem: IYamlItem | undefined = this._generateYamlItem(apiItem);
     if (!yamlItem) {
       return false;
@@ -155,17 +161,12 @@ export class YamlDocumenter {
         }
       }
 
-      if (this._yamlReferences) {
-        if (this._yamlReferences.references.length > 0) {
-          if (newYamlFile.references) {
-            newYamlFile.references = [...newYamlFile.references, ...this._yamlReferences.references];
-          } else {
-            newYamlFile.references = this._yamlReferences.references;
-          }
-        }
-        this._yamlReferences = undefined;
+      if (this._yamlReferences && this._yamlReferences.references.length > 0) {
+        newYamlFile.references = this._yamlReferences.references;
       }
 
+      this._yamlReferences = savedYamlReferences;
+
       const yamlFilePath: string = this._getYamlFilePath(apiItem);
 
       if (apiItem.kind === ApiItemKind.Package) {
@@ -175,15 +176,10 @@ export class YamlDocumenter {
       this._writeYamlFile(newYamlFile, yamlFilePath, 'UniversalReference', yamlApiSchema);
 
       if (parentYamlFile) {
-        if (!parentYamlFile.references) {
-          parentYamlFile.references = [];
-        }
-
-        parentYamlFile.references.push({
-          uid: this._getUid(apiItem),
-          name: this._getYamlItemName(apiItem)
-        });
-
+        this._recordYamlReference(
+          this._ensureYamlReferences(),
+          this._getUid(apiItem),
+          this._getYamlItemName(apiItem));
       }
     }
 
diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json
@@ -1602,6 +1602,34 @@
             }
           ],
           "implementsTokenRanges": []
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "api-documenter-test!yamlReferenceUniquenessTest:function(1)",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function yamlReferenceUniquenessTest(): "
+            },
+            {
+              "kind": "Reference",
+              "text": "IDocInterface1",
+              "canonicalReference": "api-documenter-test!IDocInterface1:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "returnTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [],
+          "name": "yamlReferenceUniquenessTest"
         }
       ]
     }
diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.md b/build-tests/api-documenter-test/etc/api-documenter-test.api.md
@@ -123,5 +123,8 @@ export class SystemEvent {
     addHandler(handler: () => void): void;
 }
 
+// @public (undocumented)
+export function yamlReferenceUniquenessTest(): IDocInterface1;
+
 
 ```
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.md
@@ -28,6 +28,7 @@ This project tests various documentation generation scenarios and doc comment sy
 |  Function | Description |
 |  --- | --- |
 |  [globalFunction(x)](./api-documenter-test.globalfunction.md) | An exported function |
+|  [yamlReferenceUniquenessTest()](./api-documenter-test.yamlreferenceuniquenesstest.md) |  |
 
 ## Interfaces
 
diff --git a/build-tests/api-documenter-test/etc/markdown/api-documenter-test.yamlreferenceuniquenesstest.md b/build-tests/api-documenter-test/etc/markdown/api-documenter-test.yamlreferenceuniquenesstest.md
@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [api-documenter-test](./api-documenter-test.md) &gt; [yamlReferenceUniquenessTest](./api-documenter-test.yamlreferenceuniquenesstest.md)
+
+## yamlReferenceUniquenessTest() function
+
+
+<b>Signature:</b>
+
+```typescript
+export declare function yamlReferenceUniquenessTest(): IDocInterface1;
+```
+<b>Returns:</b>
+
+`IDocInterface1`
+
diff --git a/build-tests/api-documenter-test/etc/yaml/api-documenter-test.yml b/build-tests/api-documenter-test/etc/yaml/api-documenter-test.yml
@@ -24,6 +24,7 @@ items:
       - 'api-documenter-test!IDocInterface6:interface'
       - 'api-documenter-test!OuterNamespace.InnerNamespace.nestedFunction:function(1)'
       - 'api-documenter-test!SystemEvent:class'
+      - 'api-documenter-test!yamlReferenceUniquenessTest:function(1)'
   - uid: 'api-documenter-test!globalFunction:function(1)'
     summary: An exported function
     name: globalFunction(x)
@@ -60,6 +61,18 @@ items:
           description: ''
           type:
             - number
+  - uid: 'api-documenter-test!yamlReferenceUniquenessTest:function(1)'
+    name: yamlReferenceUniquenessTest()
+    fullName: yamlReferenceUniquenessTest()
+    langs:
+      - typeScript
+    type: function
+    syntax:
+      content: 'export declare function yamlReferenceUniquenessTest(): IDocInterface1;'
+      return:
+        type:
+          - 'api-documenter-test!IDocInterface1:interface'
+        description: ''
 references:
   - uid: 'api-documenter-test!DocBaseClass:class'
     name: DocBaseClass
diff --git a/build-tests/api-documenter-test/src/index.ts b/build-tests/api-documenter-test/src/index.ts
@@ -12,6 +12,7 @@
 
 export * from './DocClass1';
 export * from './DocEnums';
+import { IDocInterface1 } from './DocClass1';
 
 /**
  * A type alias
@@ -55,3 +56,8 @@ export namespace OuterNamespace {
    */
   export let nestedVariable: boolean = false;
 }
+
+/**
+ * @public
+ */
+export declare function yamlReferenceUniquenessTest(): IDocInterface1;

Original file line number	Diff line number	Diff line change
`@@ -123,5 +123,8 @@ export class SystemEvent {`
`123`	`123`	`addHandler(handler: () => void): void;`
`124`	`124`	`}`
`125`	`125`
	`126`	`+// @public (undocumented)`
	`127`	`+export function yamlReferenceUniquenessTest(): IDocInterface1;`
	`128`	`+`
`126`	`129`
`127`	`130`	```