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

fix: opt in to import.meta.* properties #719

Merged
merged 2 commits into from
May 16, 2024

Conversation

danielroe
Copy link
Contributor

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

This is a very early PR to make this module compatible with changes we expect to release in Nuxt v5.

In Nuxt v3.7.0 we added support for import.meta.* (see original PR) and we've been gradually updating docs and moving across from the old process.* patterned variables.

As I'm sure you're aware, these variables are replaced at build-time and enable tree-shaking in bundled code.
This change affects runtime code (that is, that is processed by the Nuxt bundler, like vite or webpack) rather than code running in Node. So it really doesn't matter what the string is, but it makes more sense in an ESM-world to use import.meta rather than process.

(It might be worth updating the module compatibility as well to indicate it needs to have Nuxt v3.7.0+, but I'll leave that with you if you think this is a good approach.)

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have added tests (if possible).
  • I have updated the documentation accordingly.

@phoenix-ru
Copy link
Collaborator

@zoey-kaiser Let's re-schedule this to 0.8 to hint on possible breaking changes.

Would also be great to update our Getting started -> Installation docs to suggest a more concrete version than

`nuxt-auth` only needs Nuxt 3 to run. In the future Nuxt 2 or Nuxt Bridge may be supported.

and also to make this more visible

phoenix-ru
phoenix-ru previously approved these changes Apr 4, 2024
zoey-kaiser
zoey-kaiser previously approved these changes Apr 5, 2024
@zoey-kaiser zoey-kaiser added the enhancement An improvement that needs to be added label May 9, 2024
@phoenix-ru phoenix-ru dismissed stale reviews from zoey-kaiser and themself via 79f0438 May 16, 2024 08:08
@phoenix-ru phoenix-ru merged commit 4dfe9eb into sidebase:main May 16, 2024
4 checks passed
@danielroe danielroe deleted the process-client branch May 16, 2024 11:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An improvement that needs to be added
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants