refactor: use ECMAScript #private methods and accessors

Convert TypeScript private method and getter/setter declarations to
native #private syntax across api-documenter, api-extractor,
api-extractor-model, credential-cache, debug-certificate-manager,
heft-config-file, lookup-by-path, npm-check-fork, operation-graph,
package-extractor, stream-collator, terminal, ts-command-line,
typings-generator, worker-pool, and doc-plugin-rush-stack, stripping
the conventional leading underscore. Extends the prior #private field
conversion to methods and accessors using the same symbol-aware tool.

Adds an eslint-disable-next-line @rushstack/no-new-null suppression to
SourceMapper#getSourceMap, matching the existing suppression on its
sibling private field, since converting the method to native #private
syntax exposed it to the same decoupled-lint-rule gap.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 8ebd5bf2-c44b-42d5-be25-e7936d4b0a14
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Author: 2 people

apps/api-documenter/src/cli/ApiDocumenterCommandLine.ts

@@ -15,10 +15,10 @@ export class ApiDocumenterCommandLine extends CommandLineParser {
         'Reads *.api.json files produced by api-extractor, ' +
         ' and generates API documentation in various output formats.'
     });
-    this._populateActions();
+    this.#populateActions();
   }
 
-  private _populateActions(): void {
+  #populateActions(): void {
     this.addAction(new MarkdownAction(this));
     this.addAction(new YamlAction(this));
     this.addAction(new GenerateAction(this));

apps/api-documenter/src/cli/BaseAction.ts

@@ -71,15 +71,15 @@ export abstract class BaseAction extends CommandLineAction {
       }
     }
 
-    this._applyInheritDoc(apiModel, apiModel);
+    this.#applyInheritDoc(apiModel, apiModel);
 
     return { apiModel, inputFolder, outputFolder };
   }
 
   // TODO: This is a temporary workaround.  The long term plan is for API Extractor's DocCommentEnhancer
   // to apply all @inheritDoc tags before the .api.json file is written.
   // See DocCommentEnhancer._applyInheritDoc() for more info.
-  private _applyInheritDoc(apiItem: ApiItem, apiModel: ApiModel): void {
+  #applyInheritDoc(apiItem: ApiItem, apiModel: ApiModel): void {
     if (apiItem instanceof ApiDocumentedItem) {
       if (apiItem.tsdocComment) {
         const inheritDocTag: tsdoc.DocInheritDocTag | undefined = apiItem.tsdocComment.inheritDocTag;
@@ -103,7 +103,7 @@ export abstract class BaseAction extends CommandLineAction {
               result.resolvedApiItem.tsdocComment &&
               result.resolvedApiItem !== apiItem
             ) {
-              this._copyInheritedDocs(apiItem.tsdocComment, result.resolvedApiItem.tsdocComment);
+              this.#copyInheritedDocs(apiItem.tsdocComment, result.resolvedApiItem.tsdocComment);
             }
           }
         }
@@ -113,7 +113,7 @@ export abstract class BaseAction extends CommandLineAction {
     // Recurse members
     if (ApiItemContainerMixin.isBaseClassOf(apiItem)) {
       for (const member of apiItem.members) {
-        this._applyInheritDoc(member, apiModel);
+        this.#applyInheritDoc(member, apiModel);
       }
     }
   }
@@ -122,7 +122,7 @@ export abstract class BaseAction extends CommandLineAction {
    * Copy the content from `sourceDocComment` to `targetDocComment`.
    * This code is borrowed from DocCommentEnhancer as a temporary workaround.
    */
-  private _copyInheritedDocs(targetDocComment: tsdoc.DocComment, sourceDocComment: tsdoc.DocComment): void {
+  #copyInheritedDocs(targetDocComment: tsdoc.DocComment, sourceDocComment: tsdoc.DocComment): void {
     targetDocComment.summarySection = sourceDocComment.summarySection;
     targetDocComment.remarksBlock = sourceDocComment.remarksBlock;
 

apps/api-documenter/src/documenters/ExperimentalYamlDocumenter.ts

@@ -24,15 +24,15 @@ export class ExperimentalYamlDocumenter extends YamlDocumenter {
 
     this.#tocPointerMap = {};
 
-    this._generateTocPointersMap(this.#config.tocConfig);
+    this.#generateTocPointersMap(this.#config.tocConfig);
   }
 
   protected override buildYamlTocFile(apiItems: ReadonlyArray<ApiItem>): IYamlTocFile {
-    this._buildTocItems2(apiItems);
+    this.#buildTocItems2(apiItems);
     return this.#config.tocConfig;
   }
 
-  private _buildTocItems2(apiItems: ReadonlyArray<ApiItem>): IYamlTocItem[] {
+  #buildTocItems2(apiItems: ReadonlyArray<ApiItem>): IYamlTocItem[] {
     const tocItems: IYamlTocItem[] = [];
     for (const apiItem of apiItems) {
       let tocItem: IYamlTocItem;
@@ -52,14 +52,14 @@ export class ExperimentalYamlDocumenter extends YamlDocumenter {
         };
 
         if (apiItem.kind !== ApiItemKind.Package) {
-          this._filterItem(apiItem, tocItem);
+          this.#filterItem(apiItem, tocItem);
         }
       }
 
       tocItems.push(tocItem);
 
       const children: ApiItem[] = this._getLogicalChildren(apiItem);
-      const childItems: IYamlTocItem[] = this._buildTocItems2(children);
+      const childItems: IYamlTocItem[] = this.#buildTocItems2(children);
       if (childItems.length > 0) {
         tocItem.items = childItems;
       }
@@ -68,13 +68,13 @@ export class ExperimentalYamlDocumenter extends YamlDocumenter {
   }
 
   // Parses the tocConfig object to build a pointers map of nodes where we want to sort out the API items
-  private _generateTocPointersMap(tocConfig: IYamlTocFile | IYamlTocItem): void {
+  #generateTocPointersMap(tocConfig: IYamlTocFile | IYamlTocItem): void {
     const { catchAllCategory } = this.#config;
 
     if (tocConfig.items) {
       for (const tocItem of tocConfig.items) {
-        if (tocItem.items && tocItem.items.length > 0 && this._shouldNotIncludeInPointersMap(tocItem)) {
-          this._generateTocPointersMap(tocItem);
+        if (tocItem.items && tocItem.items.length > 0 && this.#shouldNotIncludeInPointersMap(tocItem)) {
+          this.#generateTocPointersMap(tocItem);
         } else {
           // check for presence of the `catchAllCategory` config option
           if (catchAllCategory && tocItem.name === catchAllCategory) {
@@ -90,15 +90,15 @@ export class ExperimentalYamlDocumenter extends YamlDocumenter {
   /**
    * Filtering out the api-item by inlineTags or category name presence in the item name.
    */
-  private _filterItem(apiItem: ApiItem, tocItem: IYamlTocItem): void {
+  #filterItem(apiItem: ApiItem, tocItem: IYamlTocItem): void {
     const { categoryInlineTag, categorizeByName } = this.#config;
     const { name: itemName } = tocItem;
     let filtered: boolean = false;
 
     // First we attempt to filter by inline tag if provided.
     if (apiItem instanceof ApiDocumentedItem) {
       const docInlineTag: DocInlineTag | undefined = categoryInlineTag
-        ? this._findInlineTagByName(categoryInlineTag, apiItem.tsdocComment)
+        ? this.#findInlineTagByName(categoryInlineTag, apiItem.tsdocComment)
         : undefined;
 
       const tagContent: string | undefined =
@@ -132,7 +132,7 @@ export class ExperimentalYamlDocumenter extends YamlDocumenter {
 
   // This is a direct copy of a @docCategory inline tag finder in office-ui-fabric-react,
   // but is generic enough to be used for any inline tag
-  private _findInlineTagByName(
+  #findInlineTagByName(
     tagName: string,
     docComment: DocComment | undefined
   ): DocInlineTag | undefined {
@@ -145,7 +145,7 @@ export class ExperimentalYamlDocumenter extends YamlDocumenter {
     }
     if (docComment) {
       for (const childNode of docComment.getChildNodes()) {
-        const result: DocInlineTag | undefined = this._findInlineTagByName(tagName, childNode as DocComment);
+        const result: DocInlineTag | undefined = this.#findInlineTagByName(tagName, childNode as DocComment);
         if (result !== undefined) {
           return result;
         }
@@ -154,7 +154,7 @@ export class ExperimentalYamlDocumenter extends YamlDocumenter {
     return undefined;
   }
 
-  private _shouldNotIncludeInPointersMap(item: IYamlTocItem): boolean {
+  #shouldNotIncludeInPointersMap(item: IYamlTocItem): boolean {
     const { nonEmptyCategoryNodeNames } = this.#config;
     if (nonEmptyCategoryNodeNames && nonEmptyCategoryNodeNames.length) {
       return nonEmptyCategoryNodeNames.indexOf(item.name) === -1;