Skip to content
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.

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

Breaking changes for yaml v3 #601

Open
eemeli opened this issue Jan 30, 2025 · 0 comments
Open

Breaking changes for yaml v3 #601

eemeli opened this issue Jan 30, 2025 · 0 comments
Labels
help wanted Extra attention is needed need more info More information is required in order to replicate and identify the reported issue
Milestone

Comments

@eemeli
Copy link
Owner

eemeli commented Jan 30, 2025

I'm considering releasing a new major release of the library once an even-numbered version of Node.js becomes available with require(esm) support, probably at latest sometime around April or May when Node.js 24 is expected to be released.

The major breaking change here would be dropping the separate CJS and ESM builds, and only releasing an ESM bundle, and relying on require(esm) to keep the library usable in CJS environments.

It should be relatively easy to keep the current (v2) version updated with backports, with any security issues getting fixes at least until Node.js 22 goes out of support (or if changes are backported to v22, until Node.js v20 goes out of support).

Are there other changes you'd like to see? Are there config options that you think should have different defaults? Are there API endpoints that you think should work differently? Other breaking changes to consider?

One that comes to my mind is reducing the current flexibility of accepting non-Node contents within the Document. Being more strict about it would clarify the types of values within Document contents quite a bit.

@eemeli eemeli added help wanted Extra attention is needed need more info More information is required in order to replicate and identify the reported issue labels Jan 30, 2025
@eemeli eemeli added this to the v3 milestone Jan 30, 2025
@eemeli eemeli pinned this issue Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed need more info More information is required in order to replicate and identify the reported issue
Projects
None yet
Development

No branches or pull requests

1 participant