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

Update dependency superstruct to v2 #21324

Merged
merged 1 commit into from
Jul 10, 2024
Merged

Update dependency superstruct to v2 #21324

merged 1 commit into from
Jul 10, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jul 6, 2024

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
superstruct 1.0.4 -> 2.0.2 age adoption passing confidence

Release Notes

ianstormtaylor/superstruct (superstruct)

v2.0.2

Compare Source

v2.0.1

Compare Source

v2.0.0

Compare Source

Some changes in Superstruct v2.0 are potentially breaking if you were using the library in unusual and/or undocumented ways. Since it has been almost 2 years since the last significant release, we want to make sure that we don't ruin someone's day by surprising them with a fix that changes buggy behavior they were relying on. For this reason, some changes that would ordinarily be considered a fix are marked as breaking.

🚀 For the absolute majority of users, this should be a smooth upgrade that will not require any changes.

Breaking
  • Validation now correctly fails when arrays are passed to object(), type(), and record() structs.
  • When coercing an object() (via mask(), create() or validate() with the coerce: true option), arrays will no longer be automatically converted to objects with indexes as keys. See this PR comment.
New
  • The library and its TypeScript typings are now compatible with NodeNext/Node16 module resolution. This means that if you are using the library with TypeScript and ECMAScript modules at the same time, you should no longer run into issues!
Fixed
  • Using mask() with union() now correctly masks union members instead of incorrectly failing validation.
Deprecations
  • Use with Node.js v14 is now deprecated. Due to incompatible tooling, we are no longer able to test Superstruct on this version of Node.js. Use at your own risk.
New Maintainers & Next Steps

Project maintenance has moved to a new volunteer team: @​arturmuller and @​yeoffrey. Hello there! 👋 We are currently going through the existing issues and PRs, trying to resolve or close the backlog. This might take a little while so please bear with us.

If you are interested in contributing — or helping us process the backlog — we would love your help. Don't hesitate to help us triage, open an issue, or submit a PR. You can also join our Superstruct maintainers Discord: https://discord.gg/pdHrQBjQ96.

If you have questions, suggestions, or are just not sure about something related to Superstruct, head over to GitHub Discussions! We have recently enabled this feature to help us differentiate between actual issues/bugs and everything else. We hope this will be a great new place where Superstruct users can get quick help from us — the maintainers — but also from the community as a whole.

See you at the next release! ✌️


Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot added the Dependencies Pull requests that update a dependency file label Jul 6, 2024
@silamon
Copy link
Contributor

silamon commented Jul 8, 2024

I guess it's OK to merge this in when bugfixes are added to the PR (so wait for v2.0.2) and then be sure to watch for schema validation errors during beta since the superstruct package is used in many places against user input.

@renovate renovate bot force-pushed the renovate/superstruct-2.x branch from 333ce9b to b306fd1 Compare July 9, 2024 12:18
@silamon silamon merged commit f299360 into dev Jul 10, 2024
14 checks passed
@silamon silamon deleted the renovate/superstruct-2.x branch July 10, 2024 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant