Skip to content

Upgrade "js-yaml" from "~3.13.1" to "~4.1.0" #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
octogonz merged 6 commits into from
Sep 14, 2025
Merged

Upgrade "js-yaml" from "~3.13.1" to "~4.1.0" #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1ab1eb8
Upgrade "js-yaml" from "~3.13.1" to "~4.1.0"
octogonz Sep 14, 2025
d2100fb
Fix up callers to use the new safe-by-default API
octogonz Sep 14, 2025
3c36d39
Regenerate snapshot, eliminating `!<tag:yaml.org,2002:js/undefined>` …
octogonz Sep 14, 2025
df2db71
rush change
octogonz Sep 14, 2025
9153e74
Regenerate snapshot
octogonz Sep 14, 2025
f5b1c9c
Rebuild all
octogonz Sep 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions apps/api-documenter/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:*"
Expand Down
4 changes: 2 additions & 2 deletions apps/api-documenter/src/documenters/OfficeYamlDocumenter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Comment on lines +51 to +52
Copy link

@iclanton iclanton Sep 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

load isn't generic? What type does it return?

Copy link
Owner Author

@octogonz octogonz Sep 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the new version, it returns unknown instead of any which requires an explicit type cast.

Arguably as ISnippetsFile better captures the assumption/conversion happening here, versus <ISnippetsFile>.

}

/** @override */
Expand Down
2 changes: 1 addition & 1 deletion apps/api-documenter/src/documenters/YamlDocumenter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
});

Expand Down
4 changes: 2 additions & 2 deletions apps/api-documenter/src/utils/ToSdpConvertHelper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, {
Expand Down
4 changes: 2 additions & 2 deletions apps/lockfile-explorer/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:*",
Expand All @@ -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"
Expand Down
111 changes: 30 additions & 81 deletions apps/lockfile-explorer/src/graph/test/__snapshots__/lfxGraphLoader54.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
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: ''
Expand All @@ -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: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
peerDependencyMeta: {}
resolvedEntryJsonId: 4
version: 'link:../d'
version: link:../d
- dependencyType: regular
entryId: /@rushstack/n/2.0.0
name: '@rushstack/n'
peerDependencyMeta:
name: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
peerDependencyMeta: {}
resolvedEntryJsonId: 12
version: 2.0.0
displayText: 'Project: b'
entryId: 'project:./common/projects/b'
entryId: project:./common/projects/b
entryPackageName: b
entryPackageVersion: ''
entrySuffix: ''
Expand All @@ -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: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
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: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
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: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
peerDependencyMeta: {}
resolvedEntryJsonId: 11
version: 1.0.0
displayText: 'Project: c'
entryId: 'project:./common/projects/c'
entryId: project:./common/projects/c
entryPackageName: c
entryPackageVersion: ''
entrySuffix: ''
Expand All @@ -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: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
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: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
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: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
peerDependencyMeta: {}
resolvedEntryJsonId: 12
version: 2.0.0
displayText: 'Project: d'
entryId: 'project:./common/projects/d'
entryId: project:./common/projects/d
entryPackageName: d
entryPackageVersion: ''
entrySuffix: ''
Expand All @@ -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: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
peerDependencyMeta: {}
resolvedEntryJsonId: 13
version: 3.0.0
displayText: 'Project: e'
entryId: 'project:./common/projects/e'
entryId: project:./common/projects/e
entryPackageName: e
entryPackageVersion: ''
entrySuffix: ''
Expand All @@ -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: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
peerDependencyMeta: {}
resolvedEntryJsonId: 8
version: 1.0.0_wxpgugna4ivthu7yyu4fmciltu
- dependencyType: regular
entryId: /@rushstack/m/1.0.0
name: '@rushstack/m'
peerDependencyMeta:
name: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
peerDependencyMeta: {}
resolvedEntryJsonId: 11
version: 1.0.0
displayText: '@rushstack/j 1.0.0 (@rushstack+n@2.0.0)'
Expand All @@ -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: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
peerDependencyMeta: {}
resolvedEntryJsonId: 9
version: 1.0.0_@rushstack+m@1.0.0
displayText: '@rushstack/k 1.0.0 (@rushstack+m@1.0.0)'
Expand All @@ -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: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
peerDependencyMeta: {}
resolvedEntryJsonId: 10
version: 1.0.0_wxpgugna4ivthu7yyu4fmciltu
displayText: '@rushstack/k 1.0.0 (wxpgugna4ivthu7yyu4fmciltu)'
Expand All @@ -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: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
peerDependencyMeta: {}
resolvedEntryJsonId: 11
version: 1.0.0
- dependencyType: peer
Expand Down Expand Up @@ -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: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
peerDependencyMeta: {}
resolvedEntryJsonId: 11
version: 1.0.0
- dependencyType: regular
entryId: /@rushstack/n/2.0.0
name: '@rushstack/n'
peerDependencyMeta:
name: !<tag:yaml.org,2002:js/undefined> ''
optional: !<tag:yaml.org,2002:js/undefined> ''
version: !<tag:yaml.org,2002:js/undefined> ''
peerDependencyMeta: {}
resolvedEntryJsonId: 12
version: 2.0.0
- dependencyType: peer
Expand Down
Loading