fix(nuxt): remove the module as breaking change#107
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
|
Caution Review the following alerts detected in dependencies. According to your organization's Security Policy, you must resolve all "Block" alerts before proceeding. Learn more about Socket for GitHub.
|
feugy
left a comment
There was a problem hiding this comment.
Could you change the version number in packages/web/package.json to 1.3.1 please?
So I won't need a new PR to release this package.
CI and deployments are failing because of an outdated pnpm-lock.json file. Try running pnpm i please.
|
@feugy Done |
There was a problem hiding this comment.
Additional Suggestion:
The README shows the wrong import path. It imports from '@vercel/speed-insights/vue' but should import from '@vercel/speed-insights/nuxt' to match the actual code in the app.
View Details
📝 Patch Details
diff --git a/apps/nuxt/README.md b/apps/nuxt/README.md
index 6890059..9e597c3 100644
--- a/apps/nuxt/README.md
+++ b/apps/nuxt/README.md
@@ -16,7 +16,7 @@ We also imported and used `<SpeedInsights />` component in `layouts/default.vue`
```vue
<script setup>
-import { SpeedInsights } from '@vercel/speed-insights/vue';
+import { SpeedInsights } from '@vercel/speed-insights/nuxt';
</script>
<template>
Analysis
Incorrect import path in Nuxt README causes wrong telemetry framework reporting
What fails: The apps/nuxt/README.md shows an example importing SpeedInsights from '@vercel/speed-insights/vue' instead of '@vercel/speed-insights/nuxt', causing the Speed Insights component to report the wrong framework in telemetry.
How to reproduce:
- Follow the README example in
apps/nuxt/README.md(line 19) - Use
import { SpeedInsights } from '@vercel/speed-insights/vue' - Check the telemetry data sent to Vercel - it will report
framework: 'vue'
Result: Telemetry incorrectly identifies the framework as Vue instead of Nuxt
Expected: Should import from '@vercel/speed-insights/nuxt' to match the actual implementation in apps/nuxt/layouts/default.vue (line 2) and correctly report framework: 'nuxt' in telemetry. Both imports are valid exports (per packages/web/package.json exports), but they produce different telemetry results - the Nuxt version passes framework: 'nuxt' while the Vue version passes framework: 'vue' to the Speed Insights service.
This reverts commit #104 as the Nuxt module should be a breaking change.
I will open another PR for 2.0 with the Nuxt module + runtime usage, the only breaking change will be:
But the advantage will be that most people will only have to do: