search

nuxt-modules / leaflet

A Nuxt module to use Leaflet
https://leaflet.nuxtjs.org/
Apache License 2.0
119 stars 3 forks source link

chore: indicate compatibility with new v4 major #21

Closed danielroe closed 4 months ago

danielroe commented 4 months ago

With Nuxt 4 on the horizon, this updates the module compatibility definition to allow it to be installed on Nuxt v4. (Otherwise Nuxt will indicate the module might not be compatible.)

When Nuxt v4 comes out then you might decide or need to make breaking changes in this module and release a new major, but hopefully the migration should be smoother. 🙏

👉 You can follow this and other changes in https://github.com/nuxt/nuxt/issues/27613 - please feel free to provide feedback as well!

Gugustinette commented 4 months ago

I had v4 in my mind for a while, I'm concerned about a few things @danielroe :

Naming

As I couldn't get the name nuxt-leaflet, I poorly named it nuxt3-leaflet.

I think leaflet is the go-to open source library for maps, should we work on moving this module to the official repo to name it @nuxt/leaflet ? This implies some work on the module and its documentation, but I'm ready to take it to the next level with some advices from the Nuxt team.

As you can see on npm this is already a few thousand downloads per weeks (and growing). Maybe it's still time to move the module now and prevent moving too much people in the future ?

Testing Nuxt 4

I followed instructions here and made this test repo for testing on a blank nuxt project.

Everything seems to work fine following quick start instructions from my documentation (it's a very small and standard module so I'm not surprised it works out of the box).

But no compatibility warning was raised, I guess this will only appear on the real Nuxt 4 channel ? Or is it because the current ^3.0.0 compatibility setting is already taking v4 in consideration ?

About contribution

A single person getting pinged by the whole Nuxt ecosystem everywhere on Github might be overwhelming. Is there a way to ping a more general "Nuxt team" when needed ? Like does @Nuxt work ? Or is the Discord a better approach (but the dedicated channel are very community oriented, I don't see a way to clearly ask the Nuxt team specifically) ? I just think it would make sense to be able to ping Nuxt as an entity and prevent overpinging someone, specially when anyone from your team could give the answer. I might be dumb, just giving you an opportunity to share a better way to contribute 🧐.

Thanks for your time and consideration to the Nuxt ecosystem ! 💚

danielroe commented 4 months ago

Testing with compatibilityVersion: 4 on v3.12 unfortunately won't reproduce the issue this PR is meant to protect against.

I'd be very happy to chat a bit more about @nuxtjs/leaflet ❤️ - will message you on discord (which is generally a good place - see #contributing as a good channel). I'm also very happy to be pinged - don't feel bad!

Gugustinette commented 4 months ago

Sounds good to me ! Let's merge.