Documentation is unclear about the installation of @mapbox/mapbox-gl-geocoder

[michaelklopf]

I get the following error, when I install the package without the @mapbox/mapbox-gl-geocoder.

✘ [ERROR] Could not resolve "@mapbox/mapbox-gl-geocoder"

    ../../node_modules/@studiometa/vue-mapbox-gl/index.js:580:27:
      580 │ import MapboxGeocoder from "@mapbox/mapbox-gl-geocoder";
          ╵                            ~~~~~~~~~~~~~~~~~~~~~~~~~~

  You can mark the path "@mapbox/mapbox-gl-geocoder" as external to exclude it from the bundle,
  which will remove this error.

The documentation suggests the installation is optional, see here https://vue-mapbox-gl.studiometa.dev/guide/installation/

# The geocoder package is only required if you use the `MapboxGeocoder` component
npm install @mapbox/mapbox-gl-geocoder

The code does require the package though. So who is correct?

[titouanmathis]

The package is indeed always imported, this was a mistake. I am not sure how to fix this without introducing a breaking change.

We could either pass the MapboxGeocoder as a prop of the component, letting the user decide which version of the package to use, or move the component to a dedicated import path like @studiometa/vue-mapbox-gl/geocoder.

I'll think about it.

In the meantime, you could mark the package as external as your bundler is suggesting.