Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Support js-yaml v5

Open
#2,015 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
javascript, yaml

Research direction

Start in the @rollup/plugin-yaml package and read the linked js-yaml v4-to-v5 migration guide and changelog. Confirm how the plugin currently calls YAML.load and YAML.loadAll, then define the versioning and parser-options approach described in the proposal. Done means js-yaml v5 support, empty-input handling, and the agreed schema and options behavior are covered.

Written by the indexing model from the issue text.

Description

  • Rollup Plugin Name: yaml
  • Rollup Plugin Version: 5.0.0
Feature Use Case

Support new js-yaml@5.x parser and its new features

Feature Proposal

Not sure how you want to handle this version wise, but could be two releases or just one

v5.1.0
  • upgrades js-yaml to v5, internally defaults YAML 1.1 schema. Everything stays the same besides the internal parser
  • a small wrapper around load/loadAll functions will needs to be made so it doesn't throw on empty (new behaviour, compared to v4).
v6.0.0

Breaking change

  • defaults to new YAML 1.2 schema if not specified
  • allow consumers to pass loadOptions/parserOptions via the plugin config, which will be forward them to the internal YAML.load/YAML.loadAll calls.
    1. Move js-yaml as peerDependency instead of devDependency requiring explicit install, ensures that schemas can be imported from js-yaml at consumers and forward via parserOptions
    2. Or re-export the schemas and forward them through @rollup/plugin-yaml package.

Cheers ✌️

Dominant language
JavaScript
Stars
3.8k
Forks
635
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rollup/plugins

All issues in rollup/plugins

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.