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

meta(nuxt): Require minimum Nuxt v3.7.0 #14473

Merged
merged 3 commits into from
Nov 26, 2024
Merged

Conversation

s1gr1d
Copy link
Member

@s1gr1d s1gr1d commented Nov 25, 2024

This PR adds a minimum required version for the Nuxt SDK. Version 3.7.0 was selected because this version adds the possibility to set client source maps to 'hidden' (PR here).

However, as the SDK relies on other versions as well (see below, at the bottom), those packages need to be manually bumped (in case the lock-file is not updated yet). Nuxt 3.7.0 at least supports the correct version range:
"nitropack": "^2.6.1"
"ofetch": "^1.3.3"

Above Nuxt v3.14.0, everything works out of the box, as the versions are already updated:
"nitropack": "^2.10.2"
"ofetch": "^1.4.1"

Minimum versions, the SDK relies on:

  • nitropack 2.10.0: for the correct peerDependency of @vercel/nft
  • ofetch 1.4.0: for being able to patch $fetch

Copy link

codecov bot commented Nov 25, 2024

❌ 1 Tests Failed:

Tests completed Failed Passed Skipped
244 1 243 9
View the top 1 failed tests by shortest run time
client-app-routing-instrumentation.test.ts Creates a navigation transaction for app router routes
Stack Traces | 30s run time
client-app-routing-instrumentation.test.ts:19:5 Creates a navigation transaction for app router routes

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Comment on lines 43 to 44
"nitropack": ">=2.10.0",
"ofetch": ">=1.4.0"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, can we do this? Does this not enforce users to specify this version in their own package.json, which they probably do not have? 🤔

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The user does not have to explicitly install it, it just makes sure the dependency tree has the correct version. But if there is a conflicting peer, users might have to install it before npm v6: https://docs.npmjs.com/cli/v10/configuring-npm/package-json#peerdependencies

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm...probably it's better to just not include those peer deps, just to be sure. I'll add them to the docs and list them as a requirement.

@s1gr1d s1gr1d merged commit 23e3783 into develop Nov 26, 2024
123 checks passed
@s1gr1d s1gr1d deleted the sig/minimum-nuxt-support branch November 26, 2024 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants