From 1ab1eb822227d2e9dd990881b652d73d2503a86a Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sun, 14 Sep 2025 13:09:31 -0700 Subject: [PATCH 1/6] Upgrade "js-yaml" from "~3.13.1" to "~4.1.0" --- apps/api-documenter/package.json | 4 +- apps/lockfile-explorer/package.json | 4 +- .../build-tests-subspace/pnpm-lock.yaml | 33 ++++------ .../build-tests-subspace/repo-state.json | 4 +- .../config/subspaces/default/pnpm-lock.yaml | 66 ++++++++----------- .../config/subspaces/default/repo-state.json | 2 +- libraries/rush-lib/package.json | 4 +- .../doc-plugin-rush-stack/package.json | 4 +- 8 files changed, 53 insertions(+), 68 deletions(-) diff --git a/apps/api-documenter/package.json b/apps/api-documenter/package.json index 0e2e59990da..dedd7522377 100644 --- a/apps/api-documenter/package.json +++ b/apps/api-documenter/package.json @@ -25,12 +25,12 @@ "@rushstack/node-core-library": "workspace:*", "@rushstack/terminal": "workspace:*", "@rushstack/ts-command-line": "workspace:*", - "js-yaml": "~3.13.1", + "js-yaml": "~4.1.0", "resolve": "~1.22.1" }, "devDependencies": { "@rushstack/heft": "workspace:*", - "@types/js-yaml": "3.12.1", + "@types/js-yaml": "4.0.9", "@types/resolve": "1.20.2", "eslint": "~9.25.1", "local-node-rig": "workspace:*" diff --git a/apps/lockfile-explorer/package.json b/apps/lockfile-explorer/package.json index 6969a39773d..4e175cb7851 100644 --- a/apps/lockfile-explorer/package.json +++ b/apps/lockfile-explorer/package.json @@ -51,7 +51,7 @@ "@rushstack/lockfile-explorer-web": "workspace:*", "@types/cors": "~2.8.12", "@types/express": "4.17.21", - "@types/js-yaml": "3.12.1", + "@types/js-yaml": "4.0.9", "@types/update-notifier": "~6.0.1", "eslint": "~9.25.1", "local-node-rig": "workspace:*", @@ -69,7 +69,7 @@ "@rushstack/ts-command-line": "workspace:*", "cors": "~2.8.5", "express": "4.20.0", - "js-yaml": "~3.13.1", + "js-yaml": "~4.1.0", "open": "~8.4.0", "semver": "~7.5.4", "update-notifier": "~5.1.0" diff --git a/common/config/subspaces/build-tests-subspace/pnpm-lock.yaml b/common/config/subspaces/build-tests-subspace/pnpm-lock.yaml index 31209c4ff7f..7c125ac9f67 100644 --- a/common/config/subspaces/build-tests-subspace/pnpm-lock.yaml +++ b/common/config/subspaces/build-tests-subspace/pnpm-lock.yaml @@ -105,10 +105,10 @@ importers: version: file:../../../apps/heft(@types/node@20.17.19) '@rushstack/heft-lint-plugin': specifier: file:../../heft-plugins/heft-lint-plugin - version: file:../../../heft-plugins/heft-lint-plugin(@rushstack/heft@0.74.3)(@types/node@20.17.19) + version: file:../../../heft-plugins/heft-lint-plugin(@rushstack/heft@0.74.5)(@types/node@20.17.19) '@rushstack/heft-typescript-plugin': specifier: file:../../heft-plugins/heft-typescript-plugin - version: file:../../../heft-plugins/heft-typescript-plugin(@rushstack/heft@0.74.3)(@types/node@20.17.19) + version: file:../../../heft-plugins/heft-typescript-plugin(@rushstack/heft@0.74.5)(@types/node@20.17.19) eslint: specifier: ~9.25.1 version: 9.25.1 @@ -4516,13 +4516,6 @@ packages: /js-tokens@4.0.0: resolution: {integrity: sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==} - /js-yaml@3.13.1: - resolution: {integrity: sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==} - hasBin: true - dependencies: - argparse: 1.0.10 - esprima: 4.0.1 - /js-yaml@3.14.1: resolution: {integrity: sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==} hasBin: true @@ -6902,7 +6895,7 @@ packages: - supports-color dev: true - file:../../../heft-plugins/heft-api-extractor-plugin(@rushstack/heft@0.74.3)(@types/node@20.17.19): + file:../../../heft-plugins/heft-api-extractor-plugin(@rushstack/heft@0.74.5)(@types/node@20.17.19): resolution: {directory: ../../../heft-plugins/heft-api-extractor-plugin, type: directory} id: file:../../../heft-plugins/heft-api-extractor-plugin name: '@rushstack/heft-api-extractor-plugin' @@ -6916,7 +6909,7 @@ packages: - '@types/node' dev: true - file:../../../heft-plugins/heft-jest-plugin(@rushstack/heft@0.74.3)(@types/node@20.17.19)(jest-environment-node@29.5.0): + file:../../../heft-plugins/heft-jest-plugin(@rushstack/heft@0.74.5)(@types/node@20.17.19)(jest-environment-node@29.5.0): resolution: {directory: ../../../heft-plugins/heft-jest-plugin, type: directory} id: file:../../../heft-plugins/heft-jest-plugin name: '@rushstack/heft-jest-plugin' @@ -6951,7 +6944,7 @@ packages: - ts-node dev: true - file:../../../heft-plugins/heft-lint-plugin(@rushstack/heft@0.74.3)(@types/node@20.17.19): + file:../../../heft-plugins/heft-lint-plugin(@rushstack/heft@0.74.5)(@types/node@20.17.19): resolution: {directory: ../../../heft-plugins/heft-lint-plugin, type: directory} id: file:../../../heft-plugins/heft-lint-plugin name: '@rushstack/heft-lint-plugin' @@ -6966,7 +6959,7 @@ packages: - '@types/node' dev: true - file:../../../heft-plugins/heft-typescript-plugin(@rushstack/heft@0.74.3)(@types/node@20.17.19): + file:../../../heft-plugins/heft-typescript-plugin(@rushstack/heft@0.74.5)(@types/node@20.17.19): resolution: {directory: ../../../heft-plugins/heft-typescript-plugin, type: directory} id: file:../../../heft-plugins/heft-typescript-plugin name: '@rushstack/heft-typescript-plugin' @@ -7120,7 +7113,7 @@ packages: https-proxy-agent: 5.0.1 ignore: 5.1.9 inquirer: 8.2.7(@types/node@20.17.19) - js-yaml: 3.13.1 + js-yaml: 4.1.0 npm-check: 6.0.1 npm-package-arg: 6.1.1 pnpm-sync-lib: 0.3.2 @@ -7193,7 +7186,7 @@ packages: transitivePeerDependencies: - '@types/node' - file:../../../rigs/heft-node-rig(@rushstack/heft@0.74.3)(@types/node@20.17.19): + file:../../../rigs/heft-node-rig(@rushstack/heft@0.74.5)(@types/node@20.17.19): resolution: {directory: ../../../rigs/heft-node-rig, type: directory} id: file:../../../rigs/heft-node-rig name: '@rushstack/heft-node-rig' @@ -7203,10 +7196,10 @@ packages: '@microsoft/api-extractor': file:../../../apps/api-extractor(@types/node@20.17.19) '@rushstack/eslint-config': file:../../../eslint/eslint-config(eslint@9.25.1)(typescript@5.8.2) '@rushstack/heft': file:../../../apps/heft(@types/node@20.17.19) - '@rushstack/heft-api-extractor-plugin': file:../../../heft-plugins/heft-api-extractor-plugin(@rushstack/heft@0.74.3)(@types/node@20.17.19) - '@rushstack/heft-jest-plugin': file:../../../heft-plugins/heft-jest-plugin(@rushstack/heft@0.74.3)(@types/node@20.17.19)(jest-environment-node@29.5.0) - '@rushstack/heft-lint-plugin': file:../../../heft-plugins/heft-lint-plugin(@rushstack/heft@0.74.3)(@types/node@20.17.19) - '@rushstack/heft-typescript-plugin': file:../../../heft-plugins/heft-typescript-plugin(@rushstack/heft@0.74.3)(@types/node@20.17.19) + '@rushstack/heft-api-extractor-plugin': file:../../../heft-plugins/heft-api-extractor-plugin(@rushstack/heft@0.74.5)(@types/node@20.17.19) + '@rushstack/heft-jest-plugin': file:../../../heft-plugins/heft-jest-plugin(@rushstack/heft@0.74.5)(@types/node@20.17.19)(jest-environment-node@29.5.0) + '@rushstack/heft-lint-plugin': file:../../../heft-plugins/heft-lint-plugin(@rushstack/heft@0.74.5)(@types/node@20.17.19) + '@rushstack/heft-typescript-plugin': file:../../../heft-plugins/heft-typescript-plugin(@rushstack/heft@0.74.5)(@types/node@20.17.19) '@types/heft-jest': 1.0.1 eslint: 9.25.1 jest-environment-node: 29.5.0 @@ -7228,7 +7221,7 @@ packages: '@microsoft/api-extractor': file:../../../apps/api-extractor(@types/node@20.17.19) '@rushstack/eslint-patch': file:../../../eslint/eslint-patch '@rushstack/heft': file:../../../apps/heft(@types/node@20.17.19) - '@rushstack/heft-node-rig': file:../../../rigs/heft-node-rig(@rushstack/heft@0.74.3)(@types/node@20.17.19) + '@rushstack/heft-node-rig': file:../../../rigs/heft-node-rig(@rushstack/heft@0.74.5)(@types/node@20.17.19) '@types/heft-jest': 1.0.1 '@types/node': 20.17.19 eslint: 9.25.1 diff --git a/common/config/subspaces/build-tests-subspace/repo-state.json b/common/config/subspaces/build-tests-subspace/repo-state.json index c8006dca5f9..df8d3168341 100644 --- a/common/config/subspaces/build-tests-subspace/repo-state.json +++ b/common/config/subspaces/build-tests-subspace/repo-state.json @@ -1,6 +1,6 @@ // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush. { - "pnpmShrinkwrapHash": "79b1140f2f030775f15eb0e2a4a1fc175f8f93e4", + "pnpmShrinkwrapHash": "f89693a88037554bf0c35db4f2295ef771cd2a71", "preferredVersionsHash": "550b4cee0bef4e97db6c6aad726df5149d20e7d9", - "packageJsonInjectedDependenciesHash": "e126030136de647c674c725e365ee7321eb18f72" + "packageJsonInjectedDependenciesHash": "364e001eac655a92be31ddb4bbf0d8b291d1e9cc" } diff --git a/common/config/subspaces/default/pnpm-lock.yaml b/common/config/subspaces/default/pnpm-lock.yaml index 03956e606a4..b19882175df 100644 --- a/common/config/subspaces/default/pnpm-lock.yaml +++ b/common/config/subspaces/default/pnpm-lock.yaml @@ -31,8 +31,8 @@ importers: specifier: workspace:* version: link:../../libraries/ts-command-line js-yaml: - specifier: ~3.13.1 - version: 3.13.1 + specifier: ~4.1.0 + version: 4.1.0 resolve: specifier: ~1.22.1 version: 1.22.8 @@ -41,8 +41,8 @@ importers: specifier: workspace:* version: link:../heft '@types/js-yaml': - specifier: 3.12.1 - version: 3.12.1 + specifier: 4.0.9 + version: 4.0.9 '@types/resolve': specifier: 1.20.2 version: 1.20.2 @@ -221,8 +221,8 @@ importers: specifier: 4.20.0 version: 4.20.0 js-yaml: - specifier: ~3.13.1 - version: 3.13.1 + specifier: ~4.1.0 + version: 4.1.0 open: specifier: ~8.4.0 version: 8.4.2 @@ -252,8 +252,8 @@ importers: specifier: 4.17.21 version: 4.17.21 '@types/js-yaml': - specifier: 3.12.1 - version: 3.12.1 + specifier: 4.0.9 + version: 4.0.9 '@types/semver': specifier: 7.5.0 version: 7.5.0 @@ -3633,8 +3633,8 @@ importers: specifier: ~8.2.7 version: 8.2.7 js-yaml: - specifier: ~3.13.1 - version: 3.13.1 + specifier: ~4.1.0 + version: 4.1.0 npm-check: specifier: ~6.0.1 version: 6.0.1 @@ -3700,8 +3700,8 @@ importers: specifier: 7.3.1 version: 7.3.1 '@types/js-yaml': - specifier: 3.12.1 - version: 3.12.1 + specifier: 4.0.9 + version: 4.0.9 '@types/npm-package-arg': specifier: 6.1.0 version: 6.1.0 @@ -3980,15 +3980,15 @@ importers: specifier: workspace:* version: link:../../libraries/node-core-library js-yaml: - specifier: ~3.13.1 - version: 3.13.1 + specifier: ~4.1.0 + version: 4.1.0 devDependencies: '@rushstack/heft': specifier: workspace:* version: link:../../apps/heft '@types/js-yaml': - specifier: 3.12.1 - version: 3.12.1 + specifier: 4.0.9 + version: 4.0.9 eslint: specifier: ~9.25.1 version: 9.25.1(supports-color@8.1.1) @@ -8026,7 +8026,7 @@ packages: globals: 12.4.0 ignore: 4.0.6 import-fresh: 3.3.0 - js-yaml: 3.13.1 + js-yaml: 3.14.1 lodash: 4.17.21 minimatch: 3.1.2 strip-json-comments: 3.1.1 @@ -8044,7 +8044,7 @@ packages: globals: 13.24.0 ignore: 4.0.6 import-fresh: 3.3.0 - js-yaml: 3.13.1 + js-yaml: 3.14.1 minimatch: 3.1.2 strip-json-comments: 3.1.1 transitivePeerDependencies: @@ -9702,7 +9702,7 @@ packages: camelcase: 5.3.1 find-up: 4.1.0 get-package-type: 0.1.0 - js-yaml: 3.13.1 + js-yaml: 3.14.1 resolve-from: 5.0.0 /@istanbuljs/schema@0.1.3: @@ -13879,8 +13879,8 @@ packages: resolution: {integrity: sha512-LFt+YA7Lv2IZROMwokZKiPNORAV5N3huMs3IKnzlE430HWhWYZ8b+78HiwJXJJP1V2IEjinyJURuRJfGoaFSIA==} dev: true - /@types/js-yaml@3.12.1: - resolution: {integrity: sha512-SGGAhXLHDx+PK4YLNcNGa6goPf9XRWQNAUUbffkwVGGXIxmDKWyGGL4inzq2sPmExu431Ekb9aEMn9BkPqEYFA==} + /@types/js-yaml@4.0.9: + resolution: {integrity: sha512-k4MGaQl5TGo/iipqb2UDG2UwjXziSWkh0uysQelTlJpX1qGlpUZYm8PnO4DxG1qBomtJUdYJ6qR6xdIah10JLg==} dev: true /@types/jsdom@20.0.1: @@ -19613,7 +19613,7 @@ packages: import-fresh: 3.3.0 imurmurhash: 0.1.4 is-glob: 4.0.3 - js-yaml: 3.13.1 + js-yaml: 3.14.1 json-stable-stringify-without-jsonify: 1.0.1 levn: 0.4.1 lodash: 4.17.21 @@ -19663,7 +19663,7 @@ packages: import-fresh: 3.3.0 imurmurhash: 0.1.4 is-glob: 4.0.3 - js-yaml: 3.13.1 + js-yaml: 3.14.1 json-stable-stringify-without-jsonify: 1.0.1 levn: 0.4.1 lodash.merge: 4.6.2 @@ -19709,7 +19709,7 @@ packages: import-fresh: 3.3.0 imurmurhash: 0.1.4 is-glob: 4.0.3 - js-yaml: 3.13.1 + js-yaml: 3.14.1 json-stable-stringify-without-jsonify: 1.0.1 levn: 0.4.1 lodash: 4.17.21 @@ -23363,20 +23363,12 @@ packages: /js-tokens@4.0.0: resolution: {integrity: sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==} - /js-yaml@3.13.1: - resolution: {integrity: sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==} - hasBin: true - dependencies: - argparse: 1.0.10 - esprima: 4.0.1 - /js-yaml@3.14.1: resolution: {integrity: sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==} hasBin: true dependencies: argparse: 1.0.10 esprima: 4.0.1 - dev: false /js-yaml@4.1.0: resolution: {integrity: sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==} @@ -23805,7 +23797,7 @@ packages: engines: {node: '>=6'} dependencies: graceful-fs: 4.2.11 - js-yaml: 3.13.1 + js-yaml: 3.14.1 pify: 4.0.1 strip-bom: 3.0.0 dev: false @@ -29310,7 +29302,7 @@ packages: commander: 2.20.3 diff: 4.0.2 glob: 7.2.3 - js-yaml: 3.13.1 + js-yaml: 3.14.1 minimatch: 3.1.2 mkdirp: 0.5.6 resolve: 1.22.8 @@ -29333,7 +29325,7 @@ packages: commander: 2.20.3 diff: 4.0.2 glob: 7.2.3 - js-yaml: 3.13.1 + js-yaml: 3.14.1 minimatch: 3.1.2 mkdirp: 0.5.6 resolve: 1.22.8 @@ -29356,7 +29348,7 @@ packages: commander: 2.20.3 diff: 4.0.2 glob: 7.2.3 - js-yaml: 3.13.1 + js-yaml: 3.14.1 minimatch: 3.1.2 mkdirp: 0.5.6 resolve: 1.22.8 @@ -29379,7 +29371,7 @@ packages: commander: 2.20.3 diff: 4.0.2 glob: 7.2.3 - js-yaml: 3.13.1 + js-yaml: 3.14.1 minimatch: 3.1.2 mkdirp: 0.5.6 resolve: 1.22.8 diff --git a/common/config/subspaces/default/repo-state.json b/common/config/subspaces/default/repo-state.json index b484328badb..3c852d397ea 100644 --- a/common/config/subspaces/default/repo-state.json +++ b/common/config/subspaces/default/repo-state.json @@ -1,5 +1,5 @@ // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush. { - "pnpmShrinkwrapHash": "0514179437811ed9b568114b19d8ecf0943f75dc", + "pnpmShrinkwrapHash": "43e8674ca74b9c3f20cf12f03de5ce2968017331", "preferredVersionsHash": "61cd419c533464b580f653eb5f5a7e27fe7055ca" } diff --git a/libraries/rush-lib/package.json b/libraries/rush-lib/package.json index 2fcae0639a1..1c5090d7350 100644 --- a/libraries/rush-lib/package.json +++ b/libraries/rush-lib/package.json @@ -54,7 +54,7 @@ "https-proxy-agent": "~5.0.0", "ignore": "~5.1.6", "inquirer": "~8.2.7", - "js-yaml": "~3.13.1", + "js-yaml": "~4.1.0", "npm-check": "~6.0.1", "npm-package-arg": "~6.1.0", "pnpm-sync-lib": "0.3.2", @@ -80,7 +80,7 @@ "@rushstack/webpack-preserve-dynamic-require-plugin": "workspace:*", "@types/cli-table": "0.3.0", "@types/inquirer": "7.3.1", - "@types/js-yaml": "3.12.1", + "@types/js-yaml": "4.0.9", "@types/npm-package-arg": "6.1.0", "@types/read-package-tree": "5.1.0", "@types/semver": "7.5.0", diff --git a/repo-scripts/doc-plugin-rush-stack/package.json b/repo-scripts/doc-plugin-rush-stack/package.json index 0ec18c28e86..aeaff892a36 100644 --- a/repo-scripts/doc-plugin-rush-stack/package.json +++ b/repo-scripts/doc-plugin-rush-stack/package.json @@ -15,11 +15,11 @@ "@microsoft/api-extractor-model": "workspace:*", "@microsoft/tsdoc": "~0.15.1", "@rushstack/node-core-library": "workspace:*", - "js-yaml": "~3.13.1" + "js-yaml": "~4.1.0" }, "devDependencies": { "@rushstack/heft": "workspace:*", - "@types/js-yaml": "3.12.1", + "@types/js-yaml": "4.0.9", "eslint": "~9.25.1", "local-node-rig": "workspace:*" } From d2100fb8cc4e0b913ecc9b6d9b70da3f201d3589 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sun, 14 Sep 2025 13:10:23 -0700 Subject: [PATCH 2/6] Fix up callers to use the new safe-by-default API --- apps/api-documenter/src/documenters/OfficeYamlDocumenter.ts | 4 ++-- apps/api-documenter/src/documenters/YamlDocumenter.ts | 2 +- apps/api-documenter/src/utils/ToSdpConvertHelper.ts | 4 ++-- libraries/rush-lib/src/logic/ProjectImpactGraphGenerator.ts | 2 +- .../src/logic/installManager/WorkspaceInstallManager.ts | 4 +++- libraries/rush-lib/src/logic/pnpm/PnpmShrinkwrapFile.ts | 4 ++-- libraries/rush-lib/src/logic/pnpm/PnpmWorkspaceFile.ts | 2 +- .../src/logic/pnpm/test/PnpmShrinkwrapConverters.test.ts | 4 ++-- repo-scripts/doc-plugin-rush-stack/src/RushStackFeature.ts | 2 +- 9 files changed, 15 insertions(+), 13 deletions(-) diff --git a/apps/api-documenter/src/documenters/OfficeYamlDocumenter.ts b/apps/api-documenter/src/documenters/OfficeYamlDocumenter.ts index 0050b7147ce..a080458ddb6 100644 --- a/apps/api-documenter/src/documenters/OfficeYamlDocumenter.ts +++ b/apps/api-documenter/src/documenters/OfficeYamlDocumenter.ts @@ -48,8 +48,8 @@ export class OfficeYamlDocumenter extends YamlDocumenter { console.log('Loading snippets from ' + snippetsFilePath); const snippetsContent: string = FileSystem.readFile(snippetsFilePath); - this._snippets = yaml.load(snippetsContent, { filename: snippetsFilePath }); - this._snippetsAll = yaml.load(snippetsContent, { filename: snippetsFilePath }); + this._snippets = yaml.load(snippetsContent, { filename: snippetsFilePath }) as ISnippetsFile; + this._snippetsAll = yaml.load(snippetsContent, { filename: snippetsFilePath }) as ISnippetsFile; } /** @override */ diff --git a/apps/api-documenter/src/documenters/YamlDocumenter.ts b/apps/api-documenter/src/documenters/YamlDocumenter.ts index b165622ce84..0d51be689f6 100644 --- a/apps/api-documenter/src/documenters/YamlDocumenter.ts +++ b/apps/api-documenter/src/documenters/YamlDocumenter.ts @@ -756,7 +756,7 @@ export class YamlDocumenter { ): void { JsonFile.validateNoUndefinedMembers(dataObject); - let stringified: string = yaml.safeDump(dataObject, { + let stringified: string = yaml.dump(dataObject, { lineWidth: 120 }); diff --git a/apps/api-documenter/src/utils/ToSdpConvertHelper.ts b/apps/api-documenter/src/utils/ToSdpConvertHelper.ts index 2de3530d9fc..73815485793 100644 --- a/apps/api-documenter/src/utils/ToSdpConvertHelper.ts +++ b/apps/api-documenter/src/utils/ToSdpConvertHelper.ts @@ -49,10 +49,10 @@ function convert(inputPath: string, outputPath: string): void { console.log(`convert file ${fpath} from udp to sdp`); - const file: IYamlApiFile = yaml.safeLoad(yamlContent) as IYamlApiFile; + const file: IYamlApiFile = yaml.load(yamlContent) as IYamlApiFile; const result: { model: CommonYamlModel; type: string } | undefined = convertToSDP(file); if (result && result.model) { - const stringified: string = `### YamlMime:TS${result.type}\n${yaml.safeDump(result.model, { + const stringified: string = `### YamlMime:TS${result.type}\n${yaml.dump(result.model, { lineWidth: 120 })}`; FileSystem.writeFile(`${outputPath}/${name}`, stringified, { diff --git a/libraries/rush-lib/src/logic/ProjectImpactGraphGenerator.ts b/libraries/rush-lib/src/logic/ProjectImpactGraphGenerator.ts index ecd36bea9fd..9bfb3a888c1 100644 --- a/libraries/rush-lib/src/logic/ProjectImpactGraphGenerator.ts +++ b/libraries/rush-lib/src/logic/ProjectImpactGraphGenerator.ts @@ -141,7 +141,7 @@ export class ProjectImpactGraphGenerator { const projects: Record = Object.fromEntries(projectEntries); const content: IProjectImpactGraphFile = { globalExcludedGlobs, projects }; - await FileSystem.writeFileAsync(this._projectImpactGraphFilePath, yaml.safeDump(content)); + await FileSystem.writeFileAsync(this._projectImpactGraphFilePath, yaml.dump(content)); stopwatch.stop(); this._terminal.writeLine(); diff --git a/libraries/rush-lib/src/logic/installManager/WorkspaceInstallManager.ts b/libraries/rush-lib/src/logic/installManager/WorkspaceInstallManager.ts index ca5f40a1cf5..3846b1217ca 100644 --- a/libraries/rush-lib/src/logic/installManager/WorkspaceInstallManager.ts +++ b/libraries/rush-lib/src/logic/installManager/WorkspaceInstallManager.ts @@ -697,7 +697,9 @@ export class WorkspaceInstallManager extends BaseInstallManager { ) { // Find the .modules.yaml file in the subspace temp/node_modules folder const modulesContent: string = await FileSystem.readFileAsync(modulesFilePath); - const yamlContent: IPnpmModules = yaml.load(modulesContent, { filename: modulesFilePath }); + const yamlContent: IPnpmModules = yaml.load(modulesContent, { + filename: modulesFilePath + }) as IPnpmModules; const { hoistedDependencies } = yamlContent; const subspaceProject: RushConfigurationProject = subspace.getProjects()[0]; const projectNodeModulesPath: string = `${subspaceProject.projectFolder}/node_modules`; diff --git a/libraries/rush-lib/src/logic/pnpm/PnpmShrinkwrapFile.ts b/libraries/rush-lib/src/logic/pnpm/PnpmShrinkwrapFile.ts index f9fac5a2620..5c63d293cd9 100644 --- a/libraries/rush-lib/src/logic/pnpm/PnpmShrinkwrapFile.ts +++ b/libraries/rush-lib/src/logic/pnpm/PnpmShrinkwrapFile.ts @@ -399,7 +399,7 @@ export class PnpmShrinkwrapFile extends BaseShrinkwrapFile { return cached; } - const shrinkwrapJson: IPnpmShrinkwrapYaml = yamlModule.safeLoad(shrinkwrapContent); + const shrinkwrapJson: IPnpmShrinkwrapYaml = yamlModule.load(shrinkwrapContent) as IPnpmShrinkwrapYaml; if ((shrinkwrapJson as LockfileFileV9).snapshots) { const lockfile: IPnpmShrinkwrapYaml | null = convertLockfileV9ToLockfileObject( shrinkwrapJson as LockfileFileV9 @@ -1317,6 +1317,6 @@ export class PnpmShrinkwrapFile extends BaseShrinkwrapFile { } } - return yamlModule.safeDump(shrinkwrapToSerialize, PNPM_SHRINKWRAP_YAML_FORMAT); + return yamlModule.dump(shrinkwrapToSerialize, PNPM_SHRINKWRAP_YAML_FORMAT); } } diff --git a/libraries/rush-lib/src/logic/pnpm/PnpmWorkspaceFile.ts b/libraries/rush-lib/src/logic/pnpm/PnpmWorkspaceFile.ts index 0615741be7c..989ad898f77 100644 --- a/libraries/rush-lib/src/logic/pnpm/PnpmWorkspaceFile.ts +++ b/libraries/rush-lib/src/logic/pnpm/PnpmWorkspaceFile.ts @@ -66,6 +66,6 @@ export class PnpmWorkspaceFile extends BaseWorkspaceFile { const workspaceYaml: IPnpmWorkspaceYaml = { packages: Array.from(this._workspacePackages) }; - return yamlModule.safeDump(workspaceYaml, PNPM_SHRINKWRAP_YAML_FORMAT); + return yamlModule.dump(workspaceYaml, PNPM_SHRINKWRAP_YAML_FORMAT); } } diff --git a/libraries/rush-lib/src/logic/pnpm/test/PnpmShrinkwrapConverters.test.ts b/libraries/rush-lib/src/logic/pnpm/test/PnpmShrinkwrapConverters.test.ts index 673bf4826ff..912bbc55b7a 100644 --- a/libraries/rush-lib/src/logic/pnpm/test/PnpmShrinkwrapConverters.test.ts +++ b/libraries/rush-lib/src/logic/pnpm/test/PnpmShrinkwrapConverters.test.ts @@ -10,7 +10,7 @@ describe(convertLockfileV9ToLockfileObject.name, () => { const lockfileContent: string = FileSystem.readFile( `${__dirname}/yamlFiles/pnpm-lock-v9/pnpm-lock-v9.yaml` ); - const lockfileJson: LockfileFileV9 = yamlModule.safeLoad(lockfileContent); + const lockfileJson: LockfileFileV9 = yamlModule.load(lockfileContent) as LockfileFileV9; const lockfile = convertLockfileV9ToLockfileObject(lockfileJson); it('merge packages and snapshots', () => { @@ -39,7 +39,7 @@ describe(convertLockfileV9ToLockfileObject.name, () => { }); }); - it("no nullish values", () => { + it('no nullish values', () => { const importers = new Map(Object.entries(lockfile.importers || {})); const currentPackage = importers.get('.'); diff --git a/repo-scripts/doc-plugin-rush-stack/src/RushStackFeature.ts b/repo-scripts/doc-plugin-rush-stack/src/RushStackFeature.ts index 7de3c775426..d214295a313 100644 --- a/repo-scripts/doc-plugin-rush-stack/src/RushStackFeature.ts +++ b/repo-scripts/doc-plugin-rush-stack/src/RushStackFeature.ts @@ -55,7 +55,7 @@ export class RushStackFeature extends MarkdownDocumenterFeature { this._buildNavigation(navigationFile.api_nav, this.context.apiModel); const navFilePath: string = path.join(this.context.outputFolder, '..', 'api_nav.yaml'); - const navFileContent: string = yaml.safeDump(navigationFile, { lineWidth: 120 }); + const navFileContent: string = yaml.dump(navigationFile, { lineWidth: 120 }); FileSystem.writeFile(navFilePath, navFileContent, { ensureFolderExists: true }); } From 3c36d39f049432acdcbef0d35254957dedfe6887 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sun, 14 Sep 2025 13:13:40 -0700 Subject: [PATCH 3/6] Regenerate snapshot, eliminating `!` garbage --- .../lfxGraphLoader54.test.ts.snap | 111 +++++------------- .../lfxGraphLoader60.test.ts.snap | 101 +++++----------- 2 files changed, 58 insertions(+), 154 deletions(-) diff --git a/apps/lockfile-explorer/src/graph/test/__snapshots__/lfxGraphLoader54.test.ts.snap b/apps/lockfile-explorer/src/graph/test/__snapshots__/lfxGraphLoader54.test.ts.snap index 7dfc13409ad..9bd8703a16b 100644 --- a/apps/lockfile-explorer/src/graph/test/__snapshots__/lfxGraphLoader54.test.ts.snap +++ b/apps/lockfile-explorer/src/graph/test/__snapshots__/lfxGraphLoader54.test.ts.snap @@ -16,16 +16,13 @@ exports[`lfxGraphLoader 5.4 loads a workspace 1`] = ` transitivePeerDependencies: [] - dependencies: - dependencyType: regular - entryId: 'project:./common/projects/d' + entryId: project:./common/projects/d name: '@rushstack/d' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 4 - version: 'link:../d' + version: link:../d displayText: 'Project: a' - entryId: 'project:./common/projects/a' + entryId: project:./common/projects/a entryPackageName: a entryPackageVersion: '' entrySuffix: '' @@ -37,25 +34,19 @@ exports[`lfxGraphLoader 5.4 loads a workspace 1`] = ` transitivePeerDependencies: [] - dependencies: - dependencyType: regular - entryId: 'project:./common/projects/d' + entryId: project:./common/projects/d name: '@rushstack/d' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 4 - version: 'link:../d' + version: link:../d - dependencyType: regular entryId: /@rushstack/n/2.0.0 name: '@rushstack/n' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 12 version: 2.0.0 displayText: 'Project: b' - entryId: 'project:./common/projects/b' + entryId: project:./common/projects/b entryPackageName: b entryPackageVersion: '' entrySuffix: '' @@ -67,34 +58,25 @@ exports[`lfxGraphLoader 5.4 loads a workspace 1`] = ` transitivePeerDependencies: [] - dependencies: - dependencyType: regular - entryId: 'project:./common/projects/e' + entryId: project:./common/projects/e name: '@rushstack/e' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 5 - version: 'link:../e' + version: link:../e - dependencyType: regular entryId: /@rushstack/k/1.0.0_@rushstack+m@1.0.0 name: '@rushstack/k' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 7 version: 1.0.0_@rushstack+m@1.0.0 - dependencyType: regular entryId: /@rushstack/m/1.0.0 name: '@rushstack/m' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 11 version: 1.0.0 displayText: 'Project: c' - entryId: 'project:./common/projects/c' + entryId: project:./common/projects/c entryPackageName: c entryPackageVersion: '' entrySuffix: '' @@ -106,34 +88,25 @@ exports[`lfxGraphLoader 5.4 loads a workspace 1`] = ` transitivePeerDependencies: [] - dependencies: - dependencyType: regular - entryId: 'project:./common/projects/e' + entryId: project:./common/projects/e name: '@rushstack/e' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 5 - version: 'link:../e' + version: link:../e - dependencyType: regular entryId: /@rushstack/j/1.0.0_@rushstack+n@2.0.0 name: '@rushstack/j' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 6 version: 1.0.0_@rushstack+n@2.0.0 - dependencyType: regular entryId: /@rushstack/n/2.0.0 name: '@rushstack/n' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 12 version: 2.0.0 displayText: 'Project: d' - entryId: 'project:./common/projects/d' + entryId: project:./common/projects/d entryPackageName: d entryPackageVersion: '' entrySuffix: '' @@ -149,14 +122,11 @@ exports[`lfxGraphLoader 5.4 loads a workspace 1`] = ` - dependencyType: regular entryId: /@rushstack/n/3.0.0 name: '@rushstack/n' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 13 version: 3.0.0 displayText: 'Project: e' - entryId: 'project:./common/projects/e' + entryId: project:./common/projects/e entryPackageName: e entryPackageVersion: '' entrySuffix: '' @@ -172,19 +142,13 @@ exports[`lfxGraphLoader 5.4 loads a workspace 1`] = ` - dependencyType: regular entryId: /@rushstack/k/1.0.0_wxpgugna4ivthu7yyu4fmciltu name: '@rushstack/k' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 8 version: 1.0.0_wxpgugna4ivthu7yyu4fmciltu - dependencyType: regular entryId: /@rushstack/m/1.0.0 name: '@rushstack/m' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 11 version: 1.0.0 displayText: '@rushstack/j 1.0.0 (@rushstack+n@2.0.0)' @@ -204,10 +168,7 @@ exports[`lfxGraphLoader 5.4 loads a workspace 1`] = ` - dependencyType: regular entryId: /@rushstack/l/1.0.0_@rushstack+m@1.0.0 name: '@rushstack/l' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 9 version: 1.0.0_@rushstack+m@1.0.0 displayText: '@rushstack/k 1.0.0 (@rushstack+m@1.0.0)' @@ -228,10 +189,7 @@ exports[`lfxGraphLoader 5.4 loads a workspace 1`] = ` - dependencyType: regular entryId: /@rushstack/l/1.0.0_wxpgugna4ivthu7yyu4fmciltu name: '@rushstack/l' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 10 version: 1.0.0_wxpgugna4ivthu7yyu4fmciltu displayText: '@rushstack/k 1.0.0 (wxpgugna4ivthu7yyu4fmciltu)' @@ -253,10 +211,7 @@ exports[`lfxGraphLoader 5.4 loads a workspace 1`] = ` - dependencyType: regular entryId: /@rushstack/m/1.0.0 name: '@rushstack/m' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 11 version: 1.0.0 - dependencyType: peer @@ -291,19 +246,13 @@ exports[`lfxGraphLoader 5.4 loads a workspace 1`] = ` - dependencyType: regular entryId: /@rushstack/m/1.0.0 name: '@rushstack/m' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 11 version: 1.0.0 - dependencyType: regular entryId: /@rushstack/n/2.0.0 name: '@rushstack/n' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 12 version: 2.0.0 - dependencyType: peer diff --git a/apps/lockfile-explorer/src/graph/test/__snapshots__/lfxGraphLoader60.test.ts.snap b/apps/lockfile-explorer/src/graph/test/__snapshots__/lfxGraphLoader60.test.ts.snap index c2330867ab2..abd0957fda8 100644 --- a/apps/lockfile-explorer/src/graph/test/__snapshots__/lfxGraphLoader60.test.ts.snap +++ b/apps/lockfile-explorer/src/graph/test/__snapshots__/lfxGraphLoader60.test.ts.snap @@ -16,16 +16,13 @@ exports[`lfxGraphLoader 6.0 loads a workspace 1`] = ` transitivePeerDependencies: [] - dependencies: - dependencyType: regular - entryId: 'project:./common/projects/d' + entryId: project:./common/projects/d name: '@rushstack/d' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 4 - version: 'link:../d' + version: link:../d displayText: 'Project: a' - entryId: 'project:./common/projects/a' + entryId: project:./common/projects/a entryPackageName: a entryPackageVersion: '' entrySuffix: '' @@ -37,25 +34,19 @@ exports[`lfxGraphLoader 6.0 loads a workspace 1`] = ` transitivePeerDependencies: [] - dependencies: - dependencyType: regular - entryId: 'project:./common/projects/d' + entryId: project:./common/projects/d name: '@rushstack/d' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 4 - version: 'link:../d' + version: link:../d - dependencyType: regular entryId: /@rushstack/n/2.0.0 name: '@rushstack/n' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 10 version: 2.0.0 displayText: 'Project: b' - entryId: 'project:./common/projects/b' + entryId: project:./common/projects/b entryPackageName: b entryPackageVersion: '' entrySuffix: '' @@ -67,34 +58,25 @@ exports[`lfxGraphLoader 6.0 loads a workspace 1`] = ` transitivePeerDependencies: [] - dependencies: - dependencyType: regular - entryId: 'project:./common/projects/e' + entryId: project:./common/projects/e name: '@rushstack/e' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 5 - version: 'link:../e' + version: link:../e - dependencyType: regular entryId: /@rushstack/k/1.0.0(@rushstack/m@1.0.0)(@rushstack/n@2.0.0) name: '@rushstack/k' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 7 version: 1.0.0(@rushstack/m@1.0.0)(@rushstack/n@2.0.0) - dependencyType: regular entryId: /@rushstack/m/1.0.0 name: '@rushstack/m' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 9 version: 1.0.0 displayText: 'Project: c' - entryId: 'project:./common/projects/c' + entryId: project:./common/projects/c entryPackageName: c entryPackageVersion: '' entrySuffix: '' @@ -106,34 +88,25 @@ exports[`lfxGraphLoader 6.0 loads a workspace 1`] = ` transitivePeerDependencies: [] - dependencies: - dependencyType: regular - entryId: 'project:./common/projects/e' + entryId: project:./common/projects/e name: '@rushstack/e' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 5 - version: 'link:../e' + version: link:../e - dependencyType: regular entryId: /@rushstack/j/1.0.0(@rushstack/n@2.0.0) name: '@rushstack/j' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 6 version: 1.0.0(@rushstack/n@2.0.0) - dependencyType: regular entryId: /@rushstack/n/2.0.0 name: '@rushstack/n' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 10 version: 2.0.0 displayText: 'Project: d' - entryId: 'project:./common/projects/d' + entryId: project:./common/projects/d entryPackageName: d entryPackageVersion: '' entrySuffix: '' @@ -149,14 +122,11 @@ exports[`lfxGraphLoader 6.0 loads a workspace 1`] = ` - dependencyType: regular entryId: /@rushstack/n/3.0.0 name: '@rushstack/n' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 11 version: 3.0.0 displayText: 'Project: e' - entryId: 'project:./common/projects/e' + entryId: project:./common/projects/e entryPackageName: e entryPackageVersion: '' entrySuffix: '' @@ -172,19 +142,13 @@ exports[`lfxGraphLoader 6.0 loads a workspace 1`] = ` - dependencyType: regular entryId: /@rushstack/k/1.0.0(@rushstack/m@1.0.0)(@rushstack/n@2.0.0) name: '@rushstack/k' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 7 version: 1.0.0(@rushstack/m@1.0.0)(@rushstack/n@2.0.0) - dependencyType: regular entryId: /@rushstack/m/1.0.0 name: '@rushstack/m' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 9 version: 1.0.0 displayText: '@rushstack/j/1.0.0(@rushstack n@2.0.0)' @@ -205,10 +169,7 @@ exports[`lfxGraphLoader 6.0 loads a workspace 1`] = ` - dependencyType: regular entryId: /@rushstack/l/1.0.0(@rushstack/m@1.0.0)(@rushstack/n@2.0.0) name: '@rushstack/l' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 8 version: 1.0.0(@rushstack/m@1.0.0)(@rushstack/n@2.0.0) displayText: '@rushstack/k/1.0.0(@rushstack/m@1.0.0)(@rushstack n@2.0.0)' @@ -231,19 +192,13 @@ exports[`lfxGraphLoader 6.0 loads a workspace 1`] = ` - dependencyType: regular entryId: /@rushstack/m/1.0.0 name: '@rushstack/m' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 9 version: 1.0.0 - dependencyType: regular entryId: /@rushstack/n/2.0.0 name: '@rushstack/n' - peerDependencyMeta: - name: ! '' - optional: ! '' - version: ! '' + peerDependencyMeta: {} resolvedEntryJsonId: 10 version: 2.0.0 - dependencyType: peer From df2db7196fa1ba25e81cf509610f82f680b1b05f Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sun, 14 Sep 2025 13:17:03 -0700 Subject: [PATCH 4/6] rush change --- .../octogonz-js-yaml-upgrade_2025-09-14-20-16.json | 11 +++++++++++ .../octogonz-js-yaml-upgrade_2025-09-14-20-16.json | 11 +++++++++++ .../octogonz-js-yaml-upgrade_2025-09-14-20-16.json | 11 +++++++++++ 3 files changed, 33 insertions(+) create mode 100644 common/changes/@microsoft/api-documenter/octogonz-js-yaml-upgrade_2025-09-14-20-16.json create mode 100644 common/changes/@microsoft/rush/octogonz-js-yaml-upgrade_2025-09-14-20-16.json create mode 100644 common/changes/@rushstack/lockfile-explorer/octogonz-js-yaml-upgrade_2025-09-14-20-16.json diff --git a/common/changes/@microsoft/api-documenter/octogonz-js-yaml-upgrade_2025-09-14-20-16.json b/common/changes/@microsoft/api-documenter/octogonz-js-yaml-upgrade_2025-09-14-20-16.json new file mode 100644 index 00000000000..a26c6b3afd1 --- /dev/null +++ b/common/changes/@microsoft/api-documenter/octogonz-js-yaml-upgrade_2025-09-14-20-16.json @@ -0,0 +1,11 @@ +{ + "changes": [ + { + "comment": "Upgraded `js-yaml` dependency", + "type": "patch", + "packageName": "@microsoft/api-documenter" + } + ], + "packageName": "@microsoft/api-documenter", + "email": "4673363+octogonz@users.noreply.github.com" +} \ No newline at end of file diff --git a/common/changes/@microsoft/rush/octogonz-js-yaml-upgrade_2025-09-14-20-16.json b/common/changes/@microsoft/rush/octogonz-js-yaml-upgrade_2025-09-14-20-16.json new file mode 100644 index 00000000000..bf925b6cda8 --- /dev/null +++ b/common/changes/@microsoft/rush/octogonz-js-yaml-upgrade_2025-09-14-20-16.json @@ -0,0 +1,11 @@ +{ + "changes": [ + { + "comment": "Upgraded `js-yaml` dependency", + "type": "none", + "packageName": "@microsoft/rush" + } + ], + "packageName": "@microsoft/rush", + "email": "4673363+octogonz@users.noreply.github.com" +} \ No newline at end of file diff --git a/common/changes/@rushstack/lockfile-explorer/octogonz-js-yaml-upgrade_2025-09-14-20-16.json b/common/changes/@rushstack/lockfile-explorer/octogonz-js-yaml-upgrade_2025-09-14-20-16.json new file mode 100644 index 00000000000..8675acd12cd --- /dev/null +++ b/common/changes/@rushstack/lockfile-explorer/octogonz-js-yaml-upgrade_2025-09-14-20-16.json @@ -0,0 +1,11 @@ +{ + "changes": [ + { + "comment": "Upgraded `js-yaml` dependency", + "type": "patch", + "packageName": "@rushstack/lockfile-explorer" + } + ], + "packageName": "@rushstack/lockfile-explorer", + "email": "4673363+octogonz@users.noreply.github.com" +} \ No newline at end of file From 9153e74c1021c24a2e2e5f8a757ef5a77a1c6d7a Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sun, 14 Sep 2025 13:19:38 -0700 Subject: [PATCH 5/6] Regenerate snapshot --- .../test/__snapshots__/snapshot.test.ts.snap | 318 +++++++++--------- 1 file changed, 159 insertions(+), 159 deletions(-) diff --git a/build-tests/api-documenter-test/src/test/__snapshots__/snapshot.test.ts.snap b/build-tests/api-documenter-test/src/test/__snapshots__/snapshot.test.ts.snap index 06d73c0c646..fabda2846fd 100644 --- a/build-tests/api-documenter-test/src/test/__snapshots__/snapshot.test.ts.snap +++ b/build-tests/api-documenter-test/src/test/__snapshots__/snapshot.test.ts.snap @@ -11,36 +11,36 @@ summary: |- This project tests various documentation generation scenarios and doc comment syntaxes. classes: - - 'api-documenter-test!AbstractClass:class' - - 'api-documenter-test!DecoratorExample:class' - - 'api-documenter-test!DocBaseClass:class' - - 'api-documenter-test!DocClass1:class' - - 'api-documenter-test!DocClassInterfaceMerge:class' - - 'api-documenter-test!Generic:class' - - 'api-documenter-test!SystemEvent:class' + - api-documenter-test!AbstractClass:class + - api-documenter-test!DecoratorExample:class + - api-documenter-test!DocBaseClass:class + - api-documenter-test!DocClass1:class + - api-documenter-test!DocClassInterfaceMerge:class + - api-documenter-test!Generic:class + - api-documenter-test!SystemEvent:class interfaces: - - 'api-documenter-test!Constraint:interface' - - 'api-documenter-test!DefaultType:interface' - - 'api-documenter-test!DocClassInterfaceMerge:interface' - - 'api-documenter-test!IDocInterface1:interface' - - 'api-documenter-test!IDocInterface2:interface' - - 'api-documenter-test!IDocInterface3:interface' - - 'api-documenter-test!IDocInterface4:interface' - - 'api-documenter-test!IDocInterface5:interface' - - 'api-documenter-test!IDocInterface6:interface' - - 'api-documenter-test!IDocInterface7:interface' + - api-documenter-test!Constraint:interface + - api-documenter-test!DefaultType:interface + - api-documenter-test!DocClassInterfaceMerge:interface + - api-documenter-test!IDocInterface1:interface + - api-documenter-test!IDocInterface2:interface + - api-documenter-test!IDocInterface3:interface + - api-documenter-test!IDocInterface4:interface + - api-documenter-test!IDocInterface5:interface + - api-documenter-test!IDocInterface6:interface + - api-documenter-test!IDocInterface7:interface enums: - - 'api-documenter-test!DocEnum:enum' - - 'api-documenter-test!DocEnumNamespaceMerge:enum' + - api-documenter-test!DocEnum:enum + - api-documenter-test!DocEnumNamespaceMerge:enum typeAliases: - - 'api-documenter-test!ExampleDuplicateTypeAlias:type' - - 'api-documenter-test!ExampleTypeAlias:type' - - 'api-documenter-test!ExampleUnionTypeAlias:type' - - 'api-documenter-test!GenericTypeAlias:type' - - 'api-documenter-test!TypeAlias:type' + - api-documenter-test!ExampleDuplicateTypeAlias:type + - api-documenter-test!ExampleTypeAlias:type + - api-documenter-test!ExampleUnionTypeAlias:type + - api-documenter-test!GenericTypeAlias:type + - api-documenter-test!TypeAlias:type functions: - - name: 'exampleFunction(x, y)' - uid: 'api-documenter-test!exampleFunction:function(1)' + - name: exampleFunction(x, y) + uid: api-documenter-test!exampleFunction:function(1) package: api-documenter-test! summary: An exported function with hyperlinked parameters and return value. remarks: '' @@ -52,15 +52,15 @@ functions: parameters: - id: x description: an API item that should get hyperlinked - type: '' + type: - id: 'y' description: a system type that should NOT get hyperlinked type: number return: - type: '' + type: description: an interface that should get hyperlinked - name: yamlReferenceUniquenessTest() - uid: 'api-documenter-test!yamlReferenceUniquenessTest:function(1)' + uid: api-documenter-test!yamlReferenceUniquenessTest:function(1) package: api-documenter-test! summary: '' remarks: '' @@ -70,12 +70,12 @@ functions: syntax: content: 'export declare function yamlReferenceUniquenessTest(): IDocInterface1;' return: - type: '' + type: description: '' ", "/api-documenter-test/abstractclass.yml": "### YamlMime:TSType name: AbstractClass -uid: 'api-documenter-test!AbstractClass:class' +uid: api-documenter-test!AbstractClass:class package: api-documenter-test! fullName: AbstractClass summary: Some abstract class with abstract members. @@ -86,7 +86,7 @@ isDeprecated: false type: class properties: - name: property - uid: 'api-documenter-test!AbstractClass#property:member' + uid: api-documenter-test!AbstractClass#property:member package: api-documenter-test! fullName: property summary: Some abstract property. @@ -100,7 +100,7 @@ properties: type: number methods: - name: method() - uid: 'api-documenter-test!AbstractClass#method:member(1)' + uid: api-documenter-test!AbstractClass#method:member(1) package: api-documenter-test! fullName: method() summary: Some abstract method. @@ -116,7 +116,7 @@ methods: ", "/api-documenter-test/constraint.yml": "### YamlMime:TSType name: Constraint -uid: 'api-documenter-test!Constraint:interface' +uid: api-documenter-test!Constraint:interface package: api-documenter-test! fullName: Constraint summary: Type parameter constraint used by test case below. @@ -128,7 +128,7 @@ type: interface ", "/api-documenter-test/decoratorexample.yml": "### YamlMime:TSType name: DecoratorExample -uid: 'api-documenter-test!DecoratorExample:class' +uid: api-documenter-test!DecoratorExample:class package: api-documenter-test! fullName: DecoratorExample summary: '' @@ -139,7 +139,7 @@ isDeprecated: false type: class properties: - name: creationDate - uid: 'api-documenter-test!DecoratorExample#creationDate:member' + uid: api-documenter-test!DecoratorExample#creationDate:member package: api-documenter-test! fullName: creationDate summary: The date when the record was created. @@ -154,7 +154,7 @@ properties: ", "/api-documenter-test/defaulttype.yml": "### YamlMime:TSType name: DefaultType -uid: 'api-documenter-test!DefaultType:interface' +uid: api-documenter-test!DefaultType:interface package: api-documenter-test! fullName: DefaultType summary: Type parameter default type used by test case below. @@ -166,7 +166,7 @@ type: interface ", "/api-documenter-test/docbaseclass.yml": "### YamlMime:TSType name: DocBaseClass -uid: 'api-documenter-test!DocBaseClass:class' +uid: api-documenter-test!DocBaseClass:class package: api-documenter-test! fullName: DocBaseClass summary: Example base class @@ -177,7 +177,7 @@ isDeprecated: false type: class constructors: - name: (constructor)() - uid: 'api-documenter-test!DocBaseClass:constructor(1)' + uid: api-documenter-test!DocBaseClass:constructor(1) package: api-documenter-test! fullName: (constructor)() summary: The simple constructor for \`DocBaseClass\` @@ -188,7 +188,7 @@ constructors: syntax: content: constructor(); - name: (constructor)(x) - uid: 'api-documenter-test!DocBaseClass:constructor(2)' + uid: api-documenter-test!DocBaseClass:constructor(2) package: api-documenter-test! fullName: (constructor)(x) summary: The overloaded constructor for \`DocBaseClass\` @@ -205,7 +205,7 @@ constructors: ", "/api-documenter-test/docclass1.yml": "### YamlMime:TSType name: DocClass1 -uid: 'api-documenter-test!DocClass1:class' +uid: api-documenter-test!DocClass1:class package: api-documenter-test! fullName: DocClass1 summary: This is an example class. @@ -225,7 +225,7 @@ isDeprecated: false type: class properties: - name: multipleModifiersProperty - uid: 'api-documenter-test!DocClass1.multipleModifiersProperty:member' + uid: api-documenter-test!DocClass1.multipleModifiersProperty:member package: api-documenter-test! fullName: multipleModifiersProperty summary: Some property with multiple modifiers. @@ -238,7 +238,7 @@ properties: return: type: boolean - name: protectedProperty - uid: 'api-documenter-test!DocClass1#protectedProperty:member' + uid: api-documenter-test!DocClass1#protectedProperty:member package: api-documenter-test! fullName: protectedProperty summary: Some protected property. @@ -251,7 +251,7 @@ properties: return: type: string - name: readonlyProperty - uid: 'api-documenter-test!DocClass1#readonlyProperty:member' + uid: api-documenter-test!DocClass1#readonlyProperty:member package: api-documenter-test! fullName: readonlyProperty summary: '' @@ -264,7 +264,7 @@ properties: return: type: string - name: regularProperty - uid: 'api-documenter-test!DocClass1#regularProperty:member' + uid: api-documenter-test!DocClass1#regularProperty:member package: api-documenter-test! fullName: regularProperty summary: This is a regular property that happens to use the SystemEvent type. @@ -275,9 +275,9 @@ properties: syntax: content: 'regularProperty: SystemEvent;' return: - type: '' + type: - name: writeableProperty - uid: 'api-documenter-test!DocClass1#writeableProperty:member' + uid: api-documenter-test!DocClass1#writeableProperty:member package: api-documenter-test! fullName: writeableProperty summary: '' @@ -293,7 +293,7 @@ properties: return: type: string - name: writeonlyProperty - uid: 'api-documenter-test!DocClass1#writeonlyProperty:member' + uid: api-documenter-test!DocClass1#writeonlyProperty:member package: api-documenter-test! fullName: writeonlyProperty summary: API Extractor will surface an \`ae-missing-getter\` finding for this property. @@ -307,7 +307,7 @@ properties: type: string methods: - name: deprecatedExample() - uid: 'api-documenter-test!DocClass1#deprecatedExample:member(1)' + uid: api-documenter-test!DocClass1#deprecatedExample:member(1) package: api-documenter-test! fullName: deprecatedExample() summary: '' @@ -321,10 +321,10 @@ methods: return: type: void description: '' - - name: 'exampleFunction(a, b)' - uid: 'api-documenter-test!DocClass1#exampleFunction:member(1)' + - name: exampleFunction(a, b) + uid: api-documenter-test!DocClass1#exampleFunction:member(1) package: api-documenter-test! - fullName: 'exampleFunction(a, b)' + fullName: exampleFunction(a, b) summary: This is an overloaded function. remarks: '' example: [] @@ -343,7 +343,7 @@ methods: type: string description: '' - name: exampleFunction(x) - uid: 'api-documenter-test!DocClass1#exampleFunction:member(2)' + uid: api-documenter-test!DocClass1#exampleFunction:member(2) package: api-documenter-test! fullName: exampleFunction(x) summary: This is also an overloaded function. @@ -361,7 +361,7 @@ methods: type: number description: '' - name: genericWithConstraintAndDefault(x) - uid: 'api-documenter-test!DocClass1#genericWithConstraintAndDefault:member(1)' + uid: api-documenter-test!DocClass1#genericWithConstraintAndDefault:member(1) package: api-documenter-test! fullName: genericWithConstraintAndDefault(x) summary: This is a method with a complex type parameter. @@ -379,7 +379,7 @@ methods: type: void description: '' - name: interestingEdgeCases() - uid: 'api-documenter-test!DocClass1#interestingEdgeCases:member(1)' + uid: api-documenter-test!DocClass1#interestingEdgeCases:member(1) package: api-documenter-test! fullName: interestingEdgeCases() summary: |- @@ -396,7 +396,7 @@ methods: type: void description: '' - name: optionalParamFunction(x) - uid: 'api-documenter-test!DocClass1#optionalParamFunction:member(1)' + uid: api-documenter-test!DocClass1#optionalParamFunction:member(1) package: api-documenter-test! fullName: optionalParamFunction(x) summary: This is a function with an optional parameter. @@ -413,10 +413,10 @@ methods: return: type: void description: '' - - name: 'sumWithExample(x, y)' - uid: 'api-documenter-test!DocClass1.sumWithExample:member(1)' + - name: sumWithExample(x, y) + uid: api-documenter-test!DocClass1.sumWithExample:member(1) package: api-documenter-test! - fullName: 'sumWithExample(x, y)' + fullName: sumWithExample(x, y) summary: Returns the sum of two numbers. remarks: This illustrates usage of the \`@example\` block tag. example: @@ -449,7 +449,7 @@ methods: type: number description: the sum of the two numbers - name: tableExample() - uid: 'api-documenter-test!DocClass1#tableExample:member(1)' + uid: api-documenter-test!DocClass1#tableExample:member(1) package: api-documenter-test! fullName: tableExample() summary: 'An example with tables:' @@ -464,7 +464,7 @@ methods: description: '' events: - name: malformedEvent - uid: 'api-documenter-test!DocClass1#malformedEvent:member' + uid: api-documenter-test!DocClass1#malformedEvent:member package: api-documenter-test! fullName: malformedEvent summary: This event should have been marked as readonly. @@ -475,9 +475,9 @@ events: syntax: content: 'malformedEvent: SystemEvent;' return: - type: '' + type: - name: modifiedEvent - uid: 'api-documenter-test!DocClass1#modifiedEvent:member' + uid: api-documenter-test!DocClass1#modifiedEvent:member package: api-documenter-test! fullName: modifiedEvent summary: This event is fired whenever the object is modified. @@ -488,12 +488,12 @@ events: syntax: content: 'readonly modifiedEvent: SystemEvent;' return: - type: '' -extends: '' + type: +extends: ", "/api-documenter-test/docclassinterfacemerge-class.yml": "### YamlMime:TSType name: DocClassInterfaceMerge -uid: 'api-documenter-test!DocClassInterfaceMerge:class' +uid: api-documenter-test!DocClassInterfaceMerge:class package: api-documenter-test! fullName: DocClassInterfaceMerge summary: Class that merges with interface @@ -508,7 +508,7 @@ type: class ", "/api-documenter-test/docclassinterfacemerge-interface.yml": "### YamlMime:TSType name: DocClassInterfaceMerge -uid: 'api-documenter-test!DocClassInterfaceMerge:interface' +uid: api-documenter-test!DocClassInterfaceMerge:interface package: api-documenter-test! fullName: DocClassInterfaceMerge summary: Interface that merges with class @@ -520,7 +520,7 @@ type: interface ", "/api-documenter-test/docenum.yml": "### YamlMime:TSEnum name: DocEnum -uid: 'api-documenter-test!DocEnum:enum' +uid: api-documenter-test!DocEnum:enum package: api-documenter-test! fullName: DocEnum summary: Docs for DocEnum @@ -530,12 +530,12 @@ isPreview: false isDeprecated: false fields: - name: One - uid: 'api-documenter-test!DocEnum.One:member' + uid: api-documenter-test!DocEnum.One:member package: api-documenter-test! summary: These are some docs for One value: '1' - name: Two - uid: 'api-documenter-test!DocEnum.Two:member' + uid: api-documenter-test!DocEnum.Two:member package: api-documenter-test! summary: |- These are some docs for Two. @@ -543,14 +543,14 @@ fields: [DocEnum.One](xref:api-documenter-test!DocEnum.One:member) is a direct link to another enum member. value: '2' - name: Zero - uid: 'api-documenter-test!DocEnum.Zero:member' + uid: api-documenter-test!DocEnum.Zero:member package: api-documenter-test! summary: These are some docs for Zero value: '0' ", "/api-documenter-test/docenumnamespacemerge-enum.yml": "### YamlMime:TSEnum name: DocEnumNamespaceMerge -uid: 'api-documenter-test!DocEnumNamespaceMerge:enum' +uid: api-documenter-test!DocEnumNamespaceMerge:enum package: api-documenter-test! fullName: DocEnumNamespaceMerge summary: Enum that merges with namespace @@ -565,19 +565,19 @@ isPreview: false isDeprecated: false fields: - name: Left - uid: 'api-documenter-test!DocEnumNamespaceMerge.Left:member' + uid: api-documenter-test!DocEnumNamespaceMerge.Left:member package: api-documenter-test! summary: These are some docs for Left value: '0' - name: Right - uid: 'api-documenter-test!DocEnumNamespaceMerge.Right:member' + uid: api-documenter-test!DocEnumNamespaceMerge.Right:member package: api-documenter-test! summary: These are some docs for Right value: '1' ", "/api-documenter-test/docenumnamespacemerge-namespace.yml": "### YamlMime:UniversalReference items: - - uid: 'api-documenter-test!DocEnumNamespaceMerge:namespace' + - uid: api-documenter-test!DocEnumNamespaceMerge:namespace summary: Namespace that merges with enum name: DocEnumNamespaceMerge fullName: DocEnumNamespaceMerge @@ -586,14 +586,14 @@ items: type: namespace package: api-documenter-test! children: - - 'api-documenter-test!DocEnumNamespaceMerge.exampleFunction:function(1)' - - uid: 'api-documenter-test!DocEnumNamespaceMerge.exampleFunction:function(1)' + - api-documenter-test!DocEnumNamespaceMerge.exampleFunction:function(1) + - uid: api-documenter-test!DocEnumNamespaceMerge.exampleFunction:function(1) summary: This is a function inside of a namespace that merges with an enum. name: exampleFunction() fullName: DocEnumNamespaceMerge.exampleFunction() langs: - typeScript - namespace: 'api-documenter-test!DocEnumNamespaceMerge:namespace' + namespace: api-documenter-test!DocEnumNamespaceMerge:namespace type: function syntax: content: 'function exampleFunction(): void;' @@ -604,7 +604,7 @@ items: ", "/api-documenter-test/ecmasymbols.yml": "### YamlMime:UniversalReference items: - - uid: 'api-documenter-test!EcmaSymbols:namespace' + - uid: api-documenter-test!EcmaSymbols:namespace summary: A namespace containing an ECMAScript symbol name: EcmaSymbols fullName: EcmaSymbols @@ -613,14 +613,14 @@ items: type: namespace package: api-documenter-test! children: - - 'api-documenter-test!EcmaSymbols.example:var' - - uid: 'api-documenter-test!EcmaSymbols.example:var' + - api-documenter-test!EcmaSymbols.example:var + - uid: api-documenter-test!EcmaSymbols.example:var summary: An ECMAScript symbol name: example fullName: EcmaSymbols.example langs: - typeScript - namespace: 'api-documenter-test!EcmaSymbols:namespace' + namespace: api-documenter-test!EcmaSymbols:namespace type: variable syntax: content: 'example: unique symbol' @@ -630,7 +630,7 @@ items: ", "/api-documenter-test/exampleduplicatetypealias.yml": "### YamlMime:TSTypeAlias name: ExampleDuplicateTypeAlias -uid: 'api-documenter-test!ExampleDuplicateTypeAlias:type' +uid: api-documenter-test!ExampleDuplicateTypeAlias:type package: api-documenter-test! fullName: ExampleDuplicateTypeAlias summary: A type alias that has duplicate references. @@ -642,7 +642,7 @@ syntax: export type ExampleDuplicateTypeAlias = SystemEvent | typeof SystemEvent ", "/api-documenter-test/exampletypealias.yml": "### YamlMime:TSTypeAlias name: ExampleTypeAlias -uid: 'api-documenter-test!ExampleTypeAlias:type' +uid: api-documenter-test!ExampleTypeAlias:type package: api-documenter-test! fullName: ExampleTypeAlias summary: A type alias @@ -654,7 +654,7 @@ syntax: export type ExampleTypeAlias = Promise; ", "/api-documenter-test/exampleuniontypealias.yml": "### YamlMime:TSTypeAlias name: ExampleUnionTypeAlias -uid: 'api-documenter-test!ExampleUnionTypeAlias:type' +uid: api-documenter-test!ExampleUnionTypeAlias:type package: api-documenter-test! fullName: ExampleUnionTypeAlias summary: A type alias that references multiple other types. @@ -666,7 +666,7 @@ syntax: export type ExampleUnionTypeAlias = IDocInterface1 | IDocInterface3; ", "/api-documenter-test/generic.yml": "### YamlMime:TSType name: Generic -uid: 'api-documenter-test!Generic:class' +uid: api-documenter-test!Generic:class package: api-documenter-test! fullName: Generic summary: Generic class. @@ -678,7 +678,7 @@ type: class ", "/api-documenter-test/generictypealias.yml": "### YamlMime:TSTypeAlias name: GenericTypeAlias -uid: 'api-documenter-test!GenericTypeAlias:type' +uid: api-documenter-test!GenericTypeAlias:type package: api-documenter-test! fullName: GenericTypeAlias summary: '' @@ -686,11 +686,11 @@ remarks: '' example: [] isPreview: false isDeprecated: false -syntax: 'export type GenericTypeAlias = T[];' +syntax: export type GenericTypeAlias = T[]; ", "/api-documenter-test/idocinterface1.yml": "### YamlMime:TSType name: IDocInterface1 -uid: 'api-documenter-test!IDocInterface1:interface' +uid: api-documenter-test!IDocInterface1:interface package: api-documenter-test! fullName: IDocInterface1 summary: '' @@ -701,7 +701,7 @@ isDeprecated: false type: interface properties: - name: regularProperty - uid: 'api-documenter-test!IDocInterface1#regularProperty:member' + uid: api-documenter-test!IDocInterface1#regularProperty:member package: api-documenter-test! fullName: regularProperty summary: Does something @@ -712,11 +712,11 @@ properties: syntax: content: 'regularProperty: SystemEvent;' return: - type: '' + type: ", "/api-documenter-test/idocinterface2.yml": "### YamlMime:TSType name: IDocInterface2 -uid: 'api-documenter-test!IDocInterface2:interface' +uid: api-documenter-test!IDocInterface2:interface package: api-documenter-test! fullName: IDocInterface2 summary: '' @@ -727,7 +727,7 @@ isDeprecated: false type: interface methods: - name: deprecatedExample() - uid: 'api-documenter-test!IDocInterface2#deprecatedExample:member(1)' + uid: api-documenter-test!IDocInterface2#deprecatedExample:member(1) package: api-documenter-test! fullName: deprecatedExample() summary: '' @@ -741,11 +741,11 @@ methods: return: type: void description: '' -extends: '' +extends: ", "/api-documenter-test/idocinterface3.yml": "### YamlMime:TSType name: IDocInterface3 -uid: 'api-documenter-test!IDocInterface3:interface' +uid: api-documenter-test!IDocInterface3:interface package: api-documenter-test! fullName: IDocInterface3 summary: Some less common TypeScript declaration kinds. @@ -756,7 +756,7 @@ isDeprecated: false type: interface properties: - name: '\\"[not.a.symbol]\\"' - uid: 'api-documenter-test!IDocInterface3#\\"[not.a.symbol]\\":member' + uid: api-documenter-test!IDocInterface3#\\"[not.a.symbol]\\":member package: api-documenter-test! fullName: '\\"[not.a.symbol]\\"' summary: An identifier that does need quotes. It misleadingly looks like an ECMAScript symbol. @@ -769,7 +769,7 @@ properties: return: type: string - name: '[EcmaSymbols.example]' - uid: 'api-documenter-test!IDocInterface3#[EcmaSymbols.example]:member' + uid: api-documenter-test!IDocInterface3#[EcmaSymbols.example]:member package: api-documenter-test! fullName: '[EcmaSymbols.example]' summary: ECMAScript symbol @@ -782,7 +782,7 @@ properties: return: type: string - name: redundantQuotes - uid: 'api-documenter-test!IDocInterface3#redundantQuotes:member' + uid: api-documenter-test!IDocInterface3#redundantQuotes:member package: api-documenter-test! fullName: redundantQuotes summary: A quoted identifier with redundant quotes. @@ -797,7 +797,7 @@ properties: ", "/api-documenter-test/idocinterface4.yml": "### YamlMime:TSType name: IDocInterface4 -uid: 'api-documenter-test!IDocInterface4:interface' +uid: api-documenter-test!IDocInterface4:interface package: api-documenter-test! fullName: IDocInterface4 summary: Type union in an interface. @@ -808,7 +808,7 @@ isDeprecated: false type: interface properties: - name: Context - uid: 'api-documenter-test!IDocInterface4#Context:member' + uid: api-documenter-test!IDocInterface4#Context:member package: api-documenter-test! fullName: Context summary: Test newline rendering when code blocks are used in tables @@ -827,7 +827,7 @@ properties: children: string; }) => boolean - name: generic - uid: 'api-documenter-test!IDocInterface4#generic:member' + uid: api-documenter-test!IDocInterface4#generic:member package: api-documenter-test! fullName: generic summary: make sure html entities are escaped in tables. @@ -838,9 +838,9 @@ properties: syntax: content: 'generic: Generic;' return: - type: '<number>' + type: <number> - name: numberOrFunction - uid: 'api-documenter-test!IDocInterface4#numberOrFunction:member' + uid: api-documenter-test!IDocInterface4#numberOrFunction:member package: api-documenter-test! fullName: numberOrFunction summary: a union type with a function @@ -853,7 +853,7 @@ properties: return: type: number | (() => number) - name: stringOrNumber - uid: 'api-documenter-test!IDocInterface4#stringOrNumber:member' + uid: api-documenter-test!IDocInterface4#stringOrNumber:member package: api-documenter-test! fullName: stringOrNumber summary: a union type @@ -868,7 +868,7 @@ properties: ", "/api-documenter-test/idocinterface5.yml": "### YamlMime:TSType name: IDocInterface5 -uid: 'api-documenter-test!IDocInterface5:interface' +uid: api-documenter-test!IDocInterface5:interface package: api-documenter-test! fullName: IDocInterface5 summary: Interface without inline tag to test custom TOC @@ -879,7 +879,7 @@ isDeprecated: false type: interface properties: - name: regularProperty - uid: 'api-documenter-test!IDocInterface5#regularProperty:member' + uid: api-documenter-test!IDocInterface5#regularProperty:member package: api-documenter-test! fullName: regularProperty summary: Property of type string that does something @@ -894,7 +894,7 @@ properties: ", "/api-documenter-test/idocinterface6.yml": "### YamlMime:TSType name: IDocInterface6 -uid: 'api-documenter-test!IDocInterface6:interface' +uid: api-documenter-test!IDocInterface6:interface package: api-documenter-test! fullName: IDocInterface6 summary: Interface without inline tag to test custom TOC with injection @@ -905,7 +905,7 @@ isDeprecated: false type: interface properties: - name: arrayProperty - uid: 'api-documenter-test!IDocInterface6#arrayProperty:member' + uid: api-documenter-test!IDocInterface6#arrayProperty:member package: api-documenter-test! fullName: arrayProperty summary: '' @@ -916,9 +916,9 @@ properties: syntax: content: 'arrayProperty: IDocInterface1[];' return: - type: '[]' + type: [] - name: intersectionProperty - uid: 'api-documenter-test!IDocInterface6#intersectionProperty:member' + uid: api-documenter-test!IDocInterface6#intersectionProperty:member package: api-documenter-test! fullName: intersectionProperty summary: '' @@ -933,7 +933,7 @@ properties: & - name: regularProperty - uid: 'api-documenter-test!IDocInterface6#regularProperty:member' + uid: api-documenter-test!IDocInterface6#regularProperty:member package: api-documenter-test! fullName: regularProperty summary: Property of type number that does something @@ -946,7 +946,7 @@ properties: return: type: number - name: tupleProperty - uid: 'api-documenter-test!IDocInterface6#tupleProperty:member' + uid: api-documenter-test!IDocInterface6#tupleProperty:member package: api-documenter-test! fullName: tupleProperty summary: '' @@ -961,7 +961,7 @@ properties: [, ] - name: typeReferenceProperty - uid: 'api-documenter-test!IDocInterface6#typeReferenceProperty:member' + uid: api-documenter-test!IDocInterface6#typeReferenceProperty:member package: api-documenter-test! fullName: typeReferenceProperty summary: '' @@ -976,7 +976,7 @@ properties: <> - name: unionProperty - uid: 'api-documenter-test!IDocInterface6#unionProperty:member' + uid: api-documenter-test!IDocInterface6#unionProperty:member package: api-documenter-test! fullName: unionProperty summary: '' @@ -992,7 +992,7 @@ properties: uid=\\"api-documenter-test!IDocInterface2:interface\\" /> methods: - name: genericReferenceMethod(x) - uid: 'api-documenter-test!IDocInterface6#genericReferenceMethod:member(1)' + uid: api-documenter-test!IDocInterface6#genericReferenceMethod:member(1) package: api-documenter-test! fullName: genericReferenceMethod(x) summary: '' @@ -1012,7 +1012,7 @@ methods: ", "/api-documenter-test/idocinterface7.yml": "### YamlMime:TSType name: IDocInterface7 -uid: 'api-documenter-test!IDocInterface7:interface' +uid: api-documenter-test!IDocInterface7:interface package: api-documenter-test! fullName: IDocInterface7 summary: Interface for testing optional properties @@ -1023,7 +1023,7 @@ isDeprecated: false type: interface properties: - name: optionalField - uid: 'api-documenter-test!IDocInterface7#optionalField:member' + uid: api-documenter-test!IDocInterface7#optionalField:member package: api-documenter-test! fullName: optionalField summary: Description of optionalField @@ -1036,7 +1036,7 @@ properties: return: type: boolean - name: optionalReadonlyField - uid: 'api-documenter-test!IDocInterface7#optionalReadonlyField:member' + uid: api-documenter-test!IDocInterface7#optionalReadonlyField:member package: api-documenter-test! fullName: optionalReadonlyField summary: Description of optionalReadonlyField @@ -1049,7 +1049,7 @@ properties: return: type: boolean - name: optionalUndocumentedField - uid: 'api-documenter-test!IDocInterface7#optionalUndocumentedField:member' + uid: api-documenter-test!IDocInterface7#optionalUndocumentedField:member package: api-documenter-test! fullName: optionalUndocumentedField summary: '' @@ -1063,7 +1063,7 @@ properties: type: boolean methods: - name: optionalMember() - uid: 'api-documenter-test!IDocInterface7#optionalMember:member(1)' + uid: api-documenter-test!IDocInterface7#optionalMember:member(1) package: api-documenter-test! fullName: optionalMember() summary: Description of optionalMember @@ -1079,7 +1079,7 @@ methods: ", "/api-documenter-test/outernamespace.innernamespace.yml": "### YamlMime:UniversalReference items: - - uid: 'api-documenter-test!OuterNamespace.InnerNamespace:namespace' + - uid: api-documenter-test!OuterNamespace.InnerNamespace:namespace summary: A nested namespace name: OuterNamespace.InnerNamespace fullName: OuterNamespace.InnerNamespace @@ -1088,14 +1088,14 @@ items: type: namespace package: api-documenter-test! children: - - 'api-documenter-test!OuterNamespace.InnerNamespace.nestedFunction:function(1)' - - uid: 'api-documenter-test!OuterNamespace.InnerNamespace.nestedFunction:function(1)' + - api-documenter-test!OuterNamespace.InnerNamespace.nestedFunction:function(1) + - uid: api-documenter-test!OuterNamespace.InnerNamespace.nestedFunction:function(1) summary: A function inside a namespace name: nestedFunction(x) fullName: OuterNamespace.InnerNamespace.nestedFunction(x) langs: - typeScript - namespace: 'api-documenter-test!OuterNamespace.InnerNamespace:namespace' + namespace: api-documenter-test!OuterNamespace.InnerNamespace:namespace type: function syntax: content: 'function nestedFunction(x: number): number;' @@ -1112,7 +1112,7 @@ items: ", "/api-documenter-test/outernamespace.yml": "### YamlMime:UniversalReference items: - - uid: 'api-documenter-test!OuterNamespace:namespace' + - uid: api-documenter-test!OuterNamespace:namespace summary: A top-level namespace name: OuterNamespace fullName: OuterNamespace @@ -1121,14 +1121,14 @@ items: type: namespace package: api-documenter-test! children: - - 'api-documenter-test!OuterNamespace.nestedVariable:var' - - uid: 'api-documenter-test!OuterNamespace.nestedVariable:var' + - api-documenter-test!OuterNamespace.nestedVariable:var + - uid: api-documenter-test!OuterNamespace.nestedVariable:var summary: A variable exported from within a namespace. name: nestedVariable fullName: OuterNamespace.nestedVariable langs: - typeScript - namespace: 'api-documenter-test!OuterNamespace:namespace' + namespace: api-documenter-test!OuterNamespace:namespace type: variable syntax: content: 'nestedVariable: boolean' @@ -1138,7 +1138,7 @@ items: ", "/api-documenter-test/systemevent.yml": "### YamlMime:TSType name: SystemEvent -uid: 'api-documenter-test!SystemEvent:class' +uid: api-documenter-test!SystemEvent:class package: api-documenter-test! fullName: SystemEvent summary: A class used to exposed events. @@ -1149,7 +1149,7 @@ isDeprecated: false type: class methods: - name: addHandler(handler) - uid: 'api-documenter-test!SystemEvent#addHandler:member(1)' + uid: api-documenter-test!SystemEvent#addHandler:member(1) package: api-documenter-test! fullName: addHandler(handler) summary: Adds an handler for the event. @@ -1169,7 +1169,7 @@ methods: ", "/api-documenter-test/typealias.yml": "### YamlMime:TSTypeAlias name: TypeAlias -uid: 'api-documenter-test!TypeAlias:type' +uid: api-documenter-test!TypeAlias:type package: api-documenter-test! fullName: TypeAlias summary: '' @@ -1191,75 +1191,75 @@ syntax: export type TypeAlias = number; - name: DocBaseClass items: - name: DocBaseClass - uid: 'api-documenter-test!DocBaseClass:class' + uid: api-documenter-test!DocBaseClass:class - name: IDocInterface1 - uid: 'api-documenter-test!IDocInterface1:interface' + uid: api-documenter-test!IDocInterface1:interface - name: IDocInterface2 - uid: 'api-documenter-test!IDocInterface2:interface' + uid: api-documenter-test!IDocInterface2:interface - name: DocClass1 items: - name: DocClass1 - uid: 'api-documenter-test!DocClass1:class' + uid: api-documenter-test!DocClass1:class - name: IDocInterface3 - uid: 'api-documenter-test!IDocInterface3:interface' + uid: api-documenter-test!IDocInterface3:interface - name: IDocInterface4 - uid: 'api-documenter-test!IDocInterface4:interface' + uid: api-documenter-test!IDocInterface4:interface - name: Interfaces items: - name: Interface5 items: - name: IDocInterface5 - uid: 'api-documenter-test!IDocInterface5:interface' + uid: api-documenter-test!IDocInterface5:interface - name: Interface6 items: - name: InjectedCustomInterface uid: customUid - name: IDocInterface6 - uid: 'api-documenter-test!IDocInterface6:interface' + uid: api-documenter-test!IDocInterface6:interface - name: References items: - name: InjectedCustomItem uid: customUrl - name: AbstractClass - uid: 'api-documenter-test!AbstractClass:class' + uid: api-documenter-test!AbstractClass:class - name: Constraint - uid: 'api-documenter-test!Constraint:interface' + uid: api-documenter-test!Constraint:interface - name: DecoratorExample - uid: 'api-documenter-test!DecoratorExample:class' + uid: api-documenter-test!DecoratorExample:class - name: DefaultType - uid: 'api-documenter-test!DefaultType:interface' + uid: api-documenter-test!DefaultType:interface - name: DocClassInterfaceMerge (Class) - uid: 'api-documenter-test!DocClassInterfaceMerge:class' + uid: api-documenter-test!DocClassInterfaceMerge:class - name: DocClassInterfaceMerge (Interface) - uid: 'api-documenter-test!DocClassInterfaceMerge:interface' + uid: api-documenter-test!DocClassInterfaceMerge:interface - name: DocEnum - uid: 'api-documenter-test!DocEnum:enum' + uid: api-documenter-test!DocEnum:enum - name: DocEnumNamespaceMerge (Enum) - uid: 'api-documenter-test!DocEnumNamespaceMerge:enum' + uid: api-documenter-test!DocEnumNamespaceMerge:enum - name: DocEnumNamespaceMerge (Namespace) - uid: 'api-documenter-test!DocEnumNamespaceMerge:namespace' + uid: api-documenter-test!DocEnumNamespaceMerge:namespace - name: EcmaSymbols - uid: 'api-documenter-test!EcmaSymbols:namespace' + uid: api-documenter-test!EcmaSymbols:namespace - name: ExampleDuplicateTypeAlias - uid: 'api-documenter-test!ExampleDuplicateTypeAlias:type' + uid: api-documenter-test!ExampleDuplicateTypeAlias:type - name: ExampleTypeAlias - uid: 'api-documenter-test!ExampleTypeAlias:type' + uid: api-documenter-test!ExampleTypeAlias:type - name: ExampleUnionTypeAlias - uid: 'api-documenter-test!ExampleUnionTypeAlias:type' + uid: api-documenter-test!ExampleUnionTypeAlias:type - name: Generic - uid: 'api-documenter-test!Generic:class' + uid: api-documenter-test!Generic:class - name: GenericTypeAlias - uid: 'api-documenter-test!GenericTypeAlias:type' + uid: api-documenter-test!GenericTypeAlias:type - name: IDocInterface7 - uid: 'api-documenter-test!IDocInterface7:interface' + uid: api-documenter-test!IDocInterface7:interface - name: OuterNamespace - uid: 'api-documenter-test!OuterNamespace:namespace' + uid: api-documenter-test!OuterNamespace:namespace - name: OuterNamespace.InnerNamespace - uid: 'api-documenter-test!OuterNamespace.InnerNamespace:namespace' + uid: api-documenter-test!OuterNamespace.InnerNamespace:namespace - name: SystemEvent - uid: 'api-documenter-test!SystemEvent:class' + uid: api-documenter-test!SystemEvent:class - name: TypeAlias - uid: 'api-documenter-test!TypeAlias:type' + uid: api-documenter-test!TypeAlias:type ", } `; From f5b1c9cd209941d14d739b3a127cadb8f0dafb72 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Sun, 14 Sep 2025 13:19:52 -0700 Subject: [PATCH 6/6] Rebuild all --- build-tests/api-extractor-test-05/dist/tsdoc-metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build-tests/api-extractor-test-05/dist/tsdoc-metadata.json b/build-tests/api-extractor-test-05/dist/tsdoc-metadata.json index 5b39d9101b7..d95757eac5e 100644 --- a/build-tests/api-extractor-test-05/dist/tsdoc-metadata.json +++ b/build-tests/api-extractor-test-05/dist/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.11" + "packageVersion": "7.52.13" } ] }