Merge branch 'main' into dont-mark-external-items-as-undocumented

microsoft · Feb 27, 2024 · 2809dd1 · 2809dd1
2 parents 87a8c40 + a6b1ff4
commit 2809dd1
Show file tree

Hide file tree

Showing 338 changed files with 10,717 additions and 5,783 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -16,10 +16,17 @@
 				"--nolazy",
 				"--inspect-brk"
 			],
+      "skipFiles": ["<node_internals>/**"],
+      // Don't scan the file system on startup
+      "outFiles": [],
+      // Evaluate source maps for all workspace-local files
+      "resolveSourceMapLocations": ["${workspaceFolder}/**", "!**/node_modules/**"],
 			"env": {
 				"NODE_ENV": "development"
 			},
-			"sourceMaps": true
+			"sourceMaps": true,
+			"console": "integratedTerminal",
+			"internalConsoleOptions": "neverOpen"
 		},
 		{
 			"type": "node",

diff --git a/apps/api-documenter/CHANGELOG.json b/apps/api-documenter/CHANGELOG.json
@@ -1,6 +1,77 @@
 {
   "name": "@microsoft/api-documenter",
   "entries": [
+    {
+      "version": "7.23.31",
+      "tag": "@microsoft/api-documenter_v7.23.31",
+      "date": "Sat, 24 Feb 2024 23:02:51 GMT",
+      "comments": {
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/terminal\" to `0.10.0`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/ts-command-line\" to `4.17.4`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/heft\" to `0.65.5`"
+          }
+        ]
+      }
+    },
+    {
+      "version": "7.23.30",
+      "tag": "@microsoft/api-documenter_v7.23.30",
+      "date": "Thu, 22 Feb 2024 01:36:09 GMT",
+      "comments": {
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/heft\" to `0.65.4`"
+          }
+        ]
+      }
+    },
+    {
+      "version": "7.23.29",
+      "tag": "@microsoft/api-documenter_v7.23.29",
+      "date": "Wed, 21 Feb 2024 21:45:28 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Replace the dependency on the `colors` package with `Colorize` from `@rushstack/terminal`."
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@microsoft/api-extractor-model\" to `7.28.13`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/node-core-library\" to `4.0.2`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/terminal\" to `0.9.0`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/ts-command-line\" to `4.17.3`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/heft\" to `0.65.3`"
+          }
+        ]
+      }
+    },
+    {
+      "version": "7.23.28",
+      "tag": "@microsoft/api-documenter_v7.23.28",
+      "date": "Wed, 21 Feb 2024 08:55:47 GMT",
+      "comments": {
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/heft\" to `0.65.2`"
+          }
+        ]
+      }
+    },
     {
       "version": "7.23.27",
       "tag": "@microsoft/api-documenter_v7.23.27",

diff --git a/apps/api-documenter/CHANGELOG.md b/apps/api-documenter/CHANGELOG.md
@@ -1,6 +1,28 @@
 # Change Log - @microsoft/api-documenter
 
-This log was last generated on Tue, 20 Feb 2024 21:45:10 GMT and should not be manually modified.
+This log was last generated on Sat, 24 Feb 2024 23:02:51 GMT and should not be manually modified.
+
+## 7.23.31
+Sat, 24 Feb 2024 23:02:51 GMT
+
+_Version update only_
+
+## 7.23.30
+Thu, 22 Feb 2024 01:36:09 GMT
+
+_Version update only_
+
+## 7.23.29
+Wed, 21 Feb 2024 21:45:28 GMT
+
+### Patches
+
+- Replace the dependency on the `colors` package with `Colorize` from `@rushstack/terminal`.
+
+## 7.23.28
+Wed, 21 Feb 2024 08:55:47 GMT
+
+_Version update only_
 
 ## 7.23.27
 Tue, 20 Feb 2024 21:45:10 GMT

diff --git a/apps/api-documenter/package.json b/apps/api-documenter/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/api-documenter",
-  "version": "7.23.27",
+  "version": "7.23.31",
   "description": "Read JSON files from api-extractor, generate documentation pages",
   "repository": {
     "type": "git",
@@ -23,15 +23,15 @@
     "@microsoft/api-extractor-model": "workspace:*",
     "@microsoft/tsdoc": "0.14.2",
     "@rushstack/node-core-library": "workspace:*",
+    "@rushstack/terminal": "workspace:*",
     "@rushstack/ts-command-line": "workspace:*",
-    "colors": "~1.2.1",
     "js-yaml": "~3.13.1",
     "resolve": "~1.22.1"
   },
   "devDependencies": {
     "@rushstack/heft": "workspace:*",
-    "local-node-rig": "workspace:*",
     "@types/js-yaml": "3.12.1",
-    "@types/resolve": "1.20.2"
+    "@types/resolve": "1.20.2",
+    "local-node-rig": "workspace:*"
   }
 }
diff --git a/apps/api-documenter/src/cli/BaseAction.ts b/apps/api-documenter/src/cli/BaseAction.ts
@@ -3,7 +3,6 @@
 
 import * as path from 'path';
 import type * as tsdoc from '@microsoft/tsdoc';
-import colors from 'colors/safe';
 
 import {
   CommandLineAction,
@@ -18,6 +17,7 @@ import {
   ApiDocumentedItem,
   type IResolveDeclarationReferenceResult
 } from '@microsoft/api-extractor-model';
+import { Colorize } from '@rushstack/terminal';
 
 export interface IBuildApiModelResult {
   apiModel: ApiModel;
@@ -94,7 +94,7 @@ export abstract class BaseAction extends CommandLineAction {
 
           if (result.errorMessage) {
             console.log(
-              colors.yellow(
+              Colorize.yellow(
                 `Warning: Unresolved @inheritDoc tag for ${apiItem.displayName}: ` + result.errorMessage
               )
             );

diff --git a/apps/api-documenter/src/documenters/OfficeYamlDocumenter.ts b/apps/api-documenter/src/documenters/OfficeYamlDocumenter.ts
@@ -1,12 +1,12 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import colors from 'colors';
 import * as path from 'path';
 import yaml = require('js-yaml');
 
 import type { ApiModel } from '@microsoft/api-extractor-model';
 import { FileSystem } from '@rushstack/node-core-library';
+import { Colorize } from '@rushstack/terminal';
 
 import type { IYamlTocItem } from '../yaml/IYamlTocFile';
 import type { IYamlItem } from '../yaml/IYamlApiFile';
@@ -59,7 +59,7 @@ export class OfficeYamlDocumenter extends YamlDocumenter {
     // After we generate everything, check for any unused snippets
     console.log();
     for (const apiName of Object.keys(this._snippets)) {
-      console.error(colors.yellow('Warning: Unused snippet ' + apiName));
+      console.error(Colorize.yellow('Warning: Unused snippet ' + apiName));
     }
   }
 

diff --git a/apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts b/apps/api-documenter/src/markdown/CustomMarkdownEmitter.ts
@@ -1,10 +1,9 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import colors from 'colors';
-
 import type { DocNode, DocLinkTag, StringBuilder } from '@microsoft/tsdoc';
 import type { ApiModel, IResolveDeclarationReferenceResult, ApiItem } from '@microsoft/api-extractor-model';
+import { Colorize } from '@rushstack/terminal';
 
 import { CustomDocNodeKind } from '../nodes/CustomDocNodeKind';
 import type { DocHeading } from '../nodes/DocHeading';
@@ -183,12 +182,12 @@ export class CustomMarkdownEmitter extends MarkdownEmitter {
           context.writer.write(encodedLinkText);
           context.writer.write(`](${filename!})`);
         } else {
-          console.log(colors.yellow('WARNING: Unable to determine link text'));
+          console.log(Colorize.yellow('WARNING: Unable to determine link text'));
         }
       }
     } else if (result.errorMessage) {
       console.log(
-        colors.yellow(
+        Colorize.yellow(
           `WARNING: Unable to resolve reference "${docLinkTag.codeDestination!.emitAsTsdoc()}": ` +
             result.errorMessage
         )

diff --git a/apps/api-documenter/src/start.ts b/apps/api-documenter/src/start.ts
@@ -2,17 +2,19 @@
 // See LICENSE in the project root for license information.
 
 import * as os from 'os';
-import colors from 'colors';
 
 import { PackageJsonLookup } from '@rushstack/node-core-library';
+import { Colorize } from '@rushstack/terminal';
 
 import { ApiDocumenterCommandLine } from './cli/ApiDocumenterCommandLine';
 
 const myPackageVersion: string = PackageJsonLookup.loadOwnPackageJson(__dirname).version;
 
 console.log(
   os.EOL +
-    colors.bold(`api-documenter ${myPackageVersion} ` + colors.cyan(' - https://api-extractor.com/') + os.EOL)
+    Colorize.bold(
+      `api-documenter ${myPackageVersion} ` + Colorize.cyan(' - https://api-extractor.com/') + os.EOL
+    )
 );
 
 const parser: ApiDocumenterCommandLine = new ApiDocumenterCommandLine();

diff --git a/apps/api-extractor/CHANGELOG.json b/apps/api-extractor/CHANGELOG.json
@@ -1,6 +1,64 @@
 {
   "name": "@microsoft/api-extractor",
   "entries": [
+    {
+      "version": "7.41.0",
+      "tag": "@microsoft/api-extractor_v7.41.0",
+      "date": "Sat, 24 Feb 2024 23:02:51 GMT",
+      "comments": {
+        "minor": [
+          {
+            "comment": "Replace const enums with conventional enums to allow for compatibility with JavaScript consumers."
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@rushstack/terminal\" to `0.10.0`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/ts-command-line\" to `4.17.4`"
+          }
+        ]
+      }
+    },
+    {
+      "version": "7.40.6",
+      "tag": "@microsoft/api-extractor_v7.40.6",
+      "date": "Wed, 21 Feb 2024 21:45:28 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Replace the dependency on the `colors` package with `Colorize` from `@rushstack/terminal`."
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@microsoft/api-extractor-model\" to `7.28.13`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/node-core-library\" to `4.0.2`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/terminal\" to `0.9.0`"
+          },
+          {
+            "comment": "Updating dependency \"@rushstack/ts-command-line\" to `4.17.3`"
+          }
+        ]
+      }
+    },
+    {
+      "version": "7.40.5",
+      "tag": "@microsoft/api-extractor_v7.40.5",
+      "date": "Wed, 21 Feb 2024 08:55:47 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Fix an issue where imports were trimmed from external packages based when generating .d.ts rollups"
+          }
+        ]
+      }
+    },
     {
       "version": "7.40.4",
       "tag": "@microsoft/api-extractor_v7.40.4",

diff --git a/apps/api-extractor/CHANGELOG.md b/apps/api-extractor/CHANGELOG.md
@@ -1,6 +1,27 @@
 # Change Log - @microsoft/api-extractor
 
-This log was last generated on Tue, 20 Feb 2024 21:45:10 GMT and should not be manually modified.
+This log was last generated on Sat, 24 Feb 2024 23:02:51 GMT and should not be manually modified.
+
+## 7.41.0
+Sat, 24 Feb 2024 23:02:51 GMT
+
+### Minor changes
+
+- Replace const enums with conventional enums to allow for compatibility with JavaScript consumers.
+
+## 7.40.6
+Wed, 21 Feb 2024 21:45:28 GMT
+
+### Patches
+
+- Replace the dependency on the `colors` package with `Colorize` from `@rushstack/terminal`.
+
+## 7.40.5
+Wed, 21 Feb 2024 08:55:47 GMT
+
+### Patches
+
+- Fix an issue where imports were trimmed from external packages based when generating .d.ts rollups
 
 ## 7.40.4
 Tue, 20 Feb 2024 21:45:10 GMT

diff --git a/apps/api-extractor/package.json b/apps/api-extractor/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/api-extractor",
-  "version": "7.40.4",
+  "version": "7.41.0",
   "description": "Analyze the exported API for a TypeScript library and generate reviews, documentation, and .d.ts rollups",
   "keywords": [
     "typescript",
@@ -38,26 +38,26 @@
   },
   "dependencies": {
     "@microsoft/api-extractor-model": "workspace:*",
-    "@microsoft/tsdoc": "0.14.2",
     "@microsoft/tsdoc-config": "~0.16.1",
+    "@microsoft/tsdoc": "0.14.2",
     "@rushstack/node-core-library": "workspace:*",
     "@rushstack/rig-package": "workspace:*",
+    "@rushstack/terminal": "workspace:*",
     "@rushstack/ts-command-line": "workspace:*",
-    "colors": "~1.2.1",
     "lodash": "~4.17.15",
     "resolve": "~1.22.1",
     "semver": "~7.5.4",
     "source-map": "~0.6.1",
     "typescript": "5.3.3"
   },
   "devDependencies": {
-    "local-eslint-config": "workspace:*",
-    "@rushstack/heft": "0.64.0",
-    "@rushstack/heft-node-rig": "2.4.0",
+    "@rushstack/heft-node-rig": "2.4.16",
+    "@rushstack/heft": "0.65.4",
     "@types/heft-jest": "1.0.1",
     "@types/lodash": "4.14.116",
     "@types/node": "18.17.15",
     "@types/resolve": "1.20.2",
-    "@types/semver": "7.5.0"
+    "@types/semver": "7.5.0",
+    "local-eslint-config": "workspace:*"
   }
 }