Skip to content

Breaking changes for yaml v3 #601

Open
@eemeli

Description

@eemeli

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedExtra attention is neededneed more infoMore information is required in order to replicate and identify the reported issue

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions