BREAKING(yaml): rename ParseOptions.json to ParseOptions.allowDuplicateKeys

[iuioiua]

What's changed

ParseOptions.json has been renamed ParseOptions.allowDuplicateKeys. This change only affects those that previously set ParseOptions.json to true. No changes in behavior have been made.

Motivation

This name more clearly describes how the option affects the behavior of parse().

Migration guide

To migrate, use the allowDuplicateKeys option instead of the json option for parse().

import { parse } from "@std/yaml/parse";

const yamlString = `name: John Doe
age: 30
name: Jane Doe`;

- parse(yamlString, { json: true });
+ parse(yamlString, { allowDuplicateKeys: true });

Related

Towards #5195

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.76%. Comparing base (fc2975b) to head (7cc1684).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5282   +/-   ##
=======================================
  Coverage   95.76%   95.76%           
=======================================
  Files         457      457           
  Lines       37955    37955           
  Branches     5569     5569           
=======================================
  Hits        36346    36346           
  Misses       1568     1568           
  Partials       41       41           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[kt3k]

I'm in favor of this change. The option name json doesn't describe what it changes.

I slightly feel allowDuplicatedKeys is a bit more natural. What do you think?

[iuioiua]

I slightly feel allowDuplicatedKeys is a bit more natural. What do you think?

I don't think it's any more natural than what it is now.

[iuioiua]

I did a quick search - "duplicate keys" seems more correct.

[kt3k]

Let's also change the description

[iuioiua]

I'll be reworking docs for all of @std/yaml once the breaking changes are made.

[kt3k]

LGTM