Remove unnecessary code

microsoft · Oct 11, 2022 · 1361612 · 1361612
1 parent 920a125
commit 1361612
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 53 deletions.
diff --git a/apps/api-extractor/src/api/IConfigFile.ts b/apps/api-extractor/src/api/IConfigFile.ts
@@ -141,7 +141,7 @@ export interface IConfigDocModel {
    *
    * @defaultValue `false`
    */
-   includeForgottenExports?: boolean;
+  includeForgottenExports?: boolean;
 
   /**
    * The URL to the `<projectFolder>` token where the project's source code can be viewed on a website like GitHub or
@@ -153,9 +153,9 @@ export interface IConfigDocModel {
    * item's file path is "api/ExtractorConfig.ts", the full URL file path would be
    * "https://github.com/microsoft/rushstack/tree/main/apps/api-extractor/api/ExtractorConfig.js".
    *
-   * Can be omitted if you don't care about including source code links in your API documentation reference.
+   * Can be omitted if you don't need source code links in your API documentation reference.
    */
-   projectFolderUrl?: string;
+  projectFolderUrl?: string;
 }
 
 /**

diff --git a/apps/api-extractor/src/generators/ApiModelGenerator.ts b/apps/api-extractor/src/generators/ApiModelGenerator.ts
@@ -152,8 +152,7 @@ export class ApiModelGenerator {
         releaseTag: ReleaseTag.None,
         excerptTokens: [],
         isExported,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
       parentApiItem.addMember(apiNamespace);
     }
@@ -309,8 +308,7 @@ export class ApiModelGenerator {
         overloadIndex,
         excerptTokens,
         returnTypeTokenRange,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
 
       parentApiItem.addMember(apiCallSignature);
@@ -351,8 +349,7 @@ export class ApiModelGenerator {
         parameters,
         overloadIndex,
         excerptTokens,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
 
       parentApiItem.addMember(apiConstructor);
@@ -408,8 +405,7 @@ export class ApiModelGenerator {
         extendsTokenRange,
         implementsTokenRanges,
         isExported,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
 
       parentApiItem.addMember(apiClass);
@@ -466,8 +462,7 @@ export class ApiModelGenerator {
         overloadIndex,
         excerptTokens,
         returnTypeTokenRange,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
 
       parentApiItem.addMember(apiConstructSignature);
@@ -496,8 +491,7 @@ export class ApiModelGenerator {
         excerptTokens,
         preserveMemberOrder,
         isExported,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
       parentApiItem.addMember(apiEnum);
     }
@@ -539,8 +533,7 @@ export class ApiModelGenerator {
         releaseTag,
         excerptTokens,
         initializerTokenRange,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
 
       parentApiItem.addMember(apiEnumMember);
@@ -590,8 +583,7 @@ export class ApiModelGenerator {
         excerptTokens,
         returnTypeTokenRange,
         isExported,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
 
       parentApiItem.addMember(apiFunction);
@@ -636,8 +628,7 @@ export class ApiModelGenerator {
         excerptTokens,
         returnTypeTokenRange,
         isReadonly,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
 
       parentApiItem.addMember(apiIndexSignature);
@@ -689,8 +680,7 @@ export class ApiModelGenerator {
         typeParameters,
         extendsTokenRanges,
         isExported,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
 
       parentApiItem.addMember(apiInterface);
@@ -752,8 +742,7 @@ export class ApiModelGenerator {
         overloadIndex,
         excerptTokens,
         returnTypeTokenRange,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
 
       parentApiItem.addMember(apiMethod);
@@ -808,8 +797,7 @@ export class ApiModelGenerator {
         overloadIndex,
         excerptTokens,
         returnTypeTokenRange,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
 
       parentApiItem.addMember(apiMethodSignature);
@@ -837,8 +825,7 @@ export class ApiModelGenerator {
         releaseTag,
         excerptTokens,
         isExported,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
       parentApiItem.addMember(apiNamespace);
     }
@@ -901,8 +888,7 @@ export class ApiModelGenerator {
         excerptTokens,
         propertyTypeTokenRange,
         initializerTokenRange,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
       parentApiItem.addMember(apiProperty);
     } else {
@@ -947,8 +933,7 @@ export class ApiModelGenerator {
         excerptTokens,
         propertyTypeTokenRange,
         isReadonly,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
 
       parentApiItem.addMember(apiPropertySignature);
@@ -995,8 +980,7 @@ export class ApiModelGenerator {
         excerptTokens,
         typeTokenRange,
         isExported,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
 
       parentApiItem.addMember(apiTypeAlias);
@@ -1041,8 +1025,7 @@ export class ApiModelGenerator {
         initializerTokenRange,
         isReadonly,
         isExported,
-        fileUrlPath,
-        parent: parentApiItem
+        fileUrlPath
       });
 
       parentApiItem.addMember(apiVariable);

diff --git a/apps/api-extractor/src/schemas/api-extractor-template.json b/apps/api-extractor/src/schemas/api-extractor-template.json
@@ -226,7 +226,7 @@
      * item's file path is "api/ExtractorConfig.ts", the full URL file path would be
      * "https://github.com/microsoft/rushstack/tree/main/apps/api-extractor/api/ExtractorConfig.js".
      *
-     * Can be omitted if you don't care about including source code links in your API documentation reference.
+     * Can be omitted if you don't need source code links in your API documentation reference.
      *
      * SUPPORTED TOKENS: none
      * DEFAULT VALUE: ""

diff --git a/apps/api-extractor/src/schemas/api-extractor.schema.json b/apps/api-extractor/src/schemas/api-extractor.schema.json
@@ -108,7 +108,7 @@
           "type": "boolean"
         },
         "projectFolderUrl": {
-          "description": "The URL to the `<projectFolder>` token where the project's source code can be viewed on a website like GitHub or Azure DevOps. This URL is concatenated with the file paths serialized to the doc model to produce URL file paths to individual API items. For example, if the `projectFolderUrl` is \"https://github.com/microsoft/rushstack/tree/main/apps/api-extractor\" and an API item's file path is \"api/ExtractorConfig.ts\", the full URL file path would be \"https://github.com/microsoft/rushstack/tree/main/apps/api-extractor/api/ExtractorConfig.js\". Can be omitted if you don't care about including source code links in your API documentation reference.",
+          "description": "The URL to the `<projectFolder>` token where the project's source code can be viewed on a website like GitHub or Azure DevOps. This URL is concatenated with the file paths serialized to the doc model to produce URL file paths to individual API items. For example, if the `projectFolderUrl` is \"https://github.com/microsoft/rushstack/tree/main/apps/api-extractor\" and an API item's file path is \"api/ExtractorConfig.ts\", the full URL file path would be \"https://github.com/microsoft/rushstack/tree/main/apps/api-extractor/api/ExtractorConfig.js\". Can be omitted if you don't need source code links in your API documentation reference.",
           "type": "string"
         }
       },

diff --git a/common/reviews/api/api-extractor-model.api.md b/common/reviews/api/api-extractor-model.api.md
@@ -752,8 +752,6 @@ export interface IApiDeclaredItemOptions extends IApiDocumentedItemOptions {
     excerptTokens: IExcerptToken[];
     // (undocumented)
     fileUrlPath?: string;
-    // (undocumented)
-    parent?: ApiItemContainerMixin;
 }
 
 // @public

diff --git a/libraries/api-extractor-model/src/items/ApiDeclaredItem.ts b/libraries/api-extractor-model/src/items/ApiDeclaredItem.ts
@@ -6,15 +6,13 @@ import { ApiDocumentedItem, IApiDocumentedItemJson, IApiDocumentedItemOptions }
 import { Excerpt, ExcerptToken, IExcerptTokenRange, IExcerptToken } from '../mixins/Excerpt';
 import { DeserializerContext } from '../model/DeserializerContext';
 import { SourceLocation } from '../model/SourceLocation';
-import { ApiItemContainerMixin } from '../mixins/ApiItemContainerMixin';
 
 /**
  * Constructor options for {@link ApiDeclaredItem}.
  * @public
  */
 export interface IApiDeclaredItemOptions extends IApiDocumentedItemOptions {
   excerptTokens: IExcerptToken[];
-  parent?: ApiItemContainerMixin;
   fileUrlPath?: string;
 }
 
@@ -55,10 +53,7 @@ export class ApiDeclaredItem extends ApiDocumentedItem {
     this._excerpt = new Excerpt(this.excerptTokens, { startIndex: 0, endIndex: this.excerptTokens.length });
 
     const projectFolderUrl: string | undefined = this.getAssociatedPackage()?.projectFolderUrl;
-    const fileUrlPath: string | undefined =
-      options.parent instanceof ApiDeclaredItem
-        ? options.fileUrlPath || options.parent.sourceLocation.fileUrlPath
-        : options.fileUrlPath;
+    const fileUrlPath: string | undefined = options.fileUrlPath || this._parentSourceLocation?.fileUrlPath;
 
     this._sourceLocation = new SourceLocation({
       projectFolderUrl: projectFolderUrl,
@@ -140,16 +135,11 @@ export class ApiDeclaredItem extends ApiDocumentedItem {
       return excerptToken;
     });
 
-    let parentSourceLocation: SourceLocation | undefined;
-    if (this.parent instanceof ApiDeclaredItem) {
-      parentSourceLocation = this.parent.sourceLocation;
-    }
-
     // Only serialize this API item's file URL path if it exists and it's different from its parent's
     // (a little optimization to keep the doc model succinct).
     if (
       this._sourceLocation.fileUrlPath &&
-      this._sourceLocation.fileUrlPath !== parentSourceLocation?.fileUrlPath
+      this._sourceLocation.fileUrlPath !== this._parentSourceLocation?.fileUrlPath
     ) {
       jsonObject.fileUrlPath = this._sourceLocation.fileUrlPath;
     }
@@ -161,4 +151,8 @@ export class ApiDeclaredItem extends ApiDocumentedItem {
   public buildExcerpt(tokenRange: IExcerptTokenRange): Excerpt {
     return new Excerpt(this.excerptTokens, tokenRange);
   }
+
+  private get _parentSourceLocation(): SourceLocation | undefined {
+    return this.parent instanceof ApiDeclaredItem ? this.parent.sourceLocation : undefined;
+  }
 }