Skip to content

fix: replace js-yaml with yaml package #6469

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
merged 5 commits into from
Jun 18, 2025
Merged

fix: replace js-yaml with yaml package #6469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
38a8889
fix: replace js-yaml with yaml package
mrstork Jun 13, 2025
1f10139
test: update build snapshots
mrstork Jun 13, 2025
d3e100c
fix: replace yaml library in manifest parsing
mrstork Jun 13, 2025
3de19bf
chore: fix import path
mrstork Jun 13, 2025
22c9a83
Merge branch 'main' into swap-yaml-package
mrstork Jun 18, 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
6 changes: 4 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions packages/build/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@
"hot-shots": "10.2.1",
"indent-string": "^5.0.0",
"is-plain-obj": "^4.0.0",
"js-yaml": "^4.0.0",
"keep-func-props": "^6.0.0",
"locate-path": "^7.0.0",
"log-process-errors": "^11.0.0",
Expand All @@ -103,9 +102,9 @@
"p-locate": "^6.0.0",
"p-map": "^7.0.0",
"p-reduce": "^3.0.0",
"package-directory": "^8.0.0",
"path-exists": "^5.0.0",
"path-type": "^6.0.0",
"package-directory": "^8.0.0",
"pretty-ms": "^9.0.0",
"ps-list": "^8.0.0",
"read-package-up": "^11.0.0",
Expand All @@ -121,6 +120,7 @@
"ts-node": "^10.9.1",
"typescript": "^5.0.0",
"uuid": "^11.0.0",
"yaml": "^2.8.0",
"yargs": "^17.6.0"
},
"devDependencies": {
Expand Down
13 changes: 0 additions & 13 deletions packages/build/src/log/serialize.js
View file
Open in desktop

This file was deleted.

13 changes: 13 additions & 0 deletions packages/build/src/log/serialize.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { stringify } from 'yaml'

export const serializeObject = function (object: object): string {
return stringify(object, { sortMapEntries: true }).trimEnd()
}

export const serializeArray = function (array: string[]) {
return array.map(addDash).join('\n')
}

const addDash = function (string: string) {
return ` - ${string}`
}
8 changes: 4 additions & 4 deletions packages/build/src/plugins/manifest/load.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { promises as fs } from 'fs'

import { load as loadYaml, JSON_SCHEMA } from 'js-yaml'
import { parse } from 'yaml'

import { addErrorInfo } from '../../error/info.js'

Expand All @@ -10,7 +10,7 @@ import { validateManifest } from './validate.js'
export const loadManifest = async function ({ manifestPath, packageName, pluginPackageJson, loadedFrom, origin }) {
try {
const rawManifest = await loadRawManifest(manifestPath)
const manifest = await parseManifest(rawManifest)
const manifest = parseManifest(rawManifest)
validateManifest(manifest, rawManifest)
return manifest
} catch (error) {
Expand All @@ -32,9 +32,9 @@ const loadRawManifest = async function (manifestPath) {
}
}

const parseManifest = async function (rawManifest) {
const parseManifest = function (rawManifest) {
try {
return await loadYaml(rawManifest, { schema: JSON_SCHEMA, json: true })
return parse(rawManifest, { logLevel: 'error' })
} catch (error) {
throw new Error(`Could not parse plugin's "manifest.yml"\n${error.message}`)
}
Expand Down
46 changes: 23 additions & 23 deletions packages/build/tests/core/snapshots/tests.js.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ Generated by [AVA](https://avajs.dev).
repositoryRoot: packages/build/tests/core/fixtures/empty␊
testOpts:␊
pluginsListUrl: test␊
silentLingeringProcesses: 'true'␊
silentLingeringProcesses: "true"␊
␊
> Current directory␊
packages/build/tests/core/fixtures/empty␊
Expand Down Expand Up @@ -393,7 +393,7 @@ Generated by [AVA](https://avajs.dev).
repositoryRoot: packages/build/tests/core/fixtures/cached_config␊
testOpts:␊
pluginsListUrl: test␊
silentLingeringProcesses: 'true'␊
silentLingeringProcesses: "true"␊
␊
> Current directory␊
packages/build/tests/core/fixtures/cached_config␊
Expand Down Expand Up @@ -444,7 +444,7 @@ Generated by [AVA](https://avajs.dev).
repositoryRoot: packages/build/tests/core/fixtures/cached_config␊
testOpts:␊
pluginsListUrl: test␊
silentLingeringProcesses: 'true'␊
silentLingeringProcesses: "true"␊
␊
> Current directory␊
packages/build/tests/core/fixtures/cached_config␊
Expand Down Expand Up @@ -1005,7 +1005,7 @@ Generated by [AVA](https://avajs.dev).
repositoryRoot: packages/build/tests/core/fixtures/single␊
testOpts:␊
pluginsListUrl: test␊
silentLingeringProcesses: 'true'␊
silentLingeringProcesses: "true"␊
␊
> Current directory␊
packages/build/tests/core/fixtures/single␊
Expand Down Expand Up @@ -1355,7 +1355,7 @@ Generated by [AVA](https://avajs.dev).
repositoryRoot: packages/build/tests/core/fixtures/empty␊
testOpts:␊
pluginsListUrl: test␊
silentLingeringProcesses: 'true'␊
silentLingeringProcesses: "true"␊
␊
> Current directory␊
packages/build/tests/core/fixtures/empty␊
Expand Down Expand Up @@ -1738,11 +1738,11 @@ Generated by [AVA](https://avajs.dev).
publish: packages/build/tests/core/fixtures/functions_config_1␊
publishOrigin: default␊
functions:␊
'*':␊
"*":␊
external_node_modules:␊
- '@netlify/imaginary-module-one'␊
- '@netlify/imaginary-module-two'␊
- '@netlify/imaginary-module-three'␊
- "@netlify/imaginary-module-one"␊
- "@netlify/imaginary-module-two"␊
- "@netlify/imaginary-module-three"␊
included_files:␊
- directory-1␊
- directory-2/file-1␊
Expand Down Expand Up @@ -1799,20 +1799,20 @@ Generated by [AVA](https://avajs.dev).
publish: packages/build/tests/core/fixtures/functions_config_2␊
publishOrigin: default␊
functions:␊
'*':␊
"*":␊
ignored_node_modules:␊
- '@netlify/imaginary-module-one'␊
- "@netlify/imaginary-module-one"␊
included_files:␊
- directory-1␊
node_bundler: esbuild␊
function_*:␊
external_node_modules:␊
- '@netlify/imaginary-module-three'␊
- "@netlify/imaginary-module-three"␊
included_files:␊
- directory-3/**/*.jpg␊
function_one:␊
external_node_modules:␊
- '@netlify/imaginary-module-two'␊
- "@netlify/imaginary-module-two"␊
included_files:␊
- directory-2/file-1␊
functionsDirectory: packages/build/tests/core/fixtures/functions_config_2/functions␊
Expand Down Expand Up @@ -1865,17 +1865,17 @@ Generated by [AVA](https://avajs.dev).
publish: packages/build/tests/core/fixtures/functions_config_3␊
publishOrigin: default␊
functions:␊
'*':␊
"*":␊
external_node_modules:␊
- '@netlify/imaginary-module-one'␊
- "@netlify/imaginary-module-one"␊
included_files:␊
- directory-1␊
node_bundler: esbuild␊
function_one:␊
external_node_modules:␊
- '@netlify/imaginary-module-two'␊
- "@netlify/imaginary-module-two"␊
included_files:␊
- '!directory-1/file-1'␊
- "!directory-1/file-1"␊
functionsDirectory: packages/build/tests/core/fixtures/functions_config_3/functions␊
␊
> Context␊
Expand Down Expand Up @@ -1904,17 +1904,17 @@ Generated by [AVA](https://avajs.dev).
publish: packages/build/tests/core/fixtures/functions_config_3␊
publishOrigin: default␊
functions:␊
'*':␊
"*":␊
external_node_modules:␊
- '@netlify/imaginary-module-one'␊
- "@netlify/imaginary-module-one"␊
included_files:␊
- directory-1␊
node_bundler: esbuild␊
function_one:␊
external_node_modules:␊
- '@netlify/imaginary-module-two'␊
- "@netlify/imaginary-module-two"␊
included_files:␊
- '!directory-1/file-1'␊
- "!directory-1/file-1"␊
functionsDirectory: packages/build/tests/core/fixtures/functions_config_3/functions`

## Shows notice about bundling errors and warnings coming from esbuild
Expand Down Expand Up @@ -1946,7 +1946,7 @@ Generated by [AVA](https://avajs.dev).
publish: packages/build/tests/core/fixtures/esbuild_errors_1␊
publishOrigin: default␊
functions:␊
'*':␊
"*":␊
node_bundler: esbuild␊
functionsDirectory: packages/build/tests/core/fixtures/esbuild_errors_1/functions␊
␊
Expand Down Expand Up @@ -2004,7 +2004,7 @@ Generated by [AVA](https://avajs.dev).
publish: packages/build/tests/core/fixtures/esbuild_errors_2␊
publishOrigin: default␊
functions:␊
'*':␊
"*":␊
node_bundler: esbuild␊
functionsDirectory: packages/build/tests/core/fixtures/esbuild_errors_2/functions␊
␊
Expand Down
Binary file modified packages/build/tests/core/snapshots/tests.js.snap
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion packages/build/tests/edge_functions/snapshots/tests.js.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,7 @@ Generated by [AVA](https://avajs.dev).
publish: packages/build/tests/edge_functions/fixtures/functions_user␊
publishOrigin: default␊
functions:␊
'*':␊
"*":␊
deno_import_map: packages/build/tests/edge_functions/fixtures/functions_user/netlify/edge-functions/import-map.json␊
␊
> Context␊
Expand Down
Binary file modified packages/build/tests/edge_functions/snapshots/tests.js.snap
View file
Open in desktop
Binary file not shown.
Loading
Loading