-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
ref(nuxt): Use addVitePlugin instead of deprecated vite:extendConfig
#19464
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
Merged
+435
−138
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
d89a5ff
clean up tests
s1gr1d b461991
add test: validateDifferentSourceMapSettings
s1gr1d a6bc448
ref(nuxt): Use `addVitePlugin` instead of deprecated `vite:extendConfig`
s1gr1d cc11b08
fix console spies
s1gr1d 4e12f13
fix overwrite object
s1gr1d File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| import type { Nuxt } from '@nuxt/schema'; | ||
| import { sentryVitePlugin } from '@sentry/vite-plugin'; | ||
| import type { ConfigEnv, Plugin, UserConfig } from 'vite'; | ||
| import type { SentryNuxtModuleOptions } from '../common/types'; | ||
| import { extractNuxtSourceMapSetting, getPluginOptions, validateDifferentSourceMapSettings } from './sourceMaps'; | ||
|
|
||
| /** | ||
| * Creates a Vite plugin that adds the Sentry Vite plugin and validates source map settings. | ||
| */ | ||
| export function createSentryViteConfigPlugin(options: { | ||
| nuxt: Nuxt; | ||
| moduleOptions: SentryNuxtModuleOptions; | ||
| sourceMapsEnabled: boolean; | ||
| shouldDeleteFilesFallback: { client: boolean; server: boolean }; | ||
| }): Plugin { | ||
| const { nuxt, moduleOptions, sourceMapsEnabled, shouldDeleteFilesFallback } = options; | ||
| const isDebug = moduleOptions.debug; | ||
|
|
||
| return { | ||
| name: 'sentry-nuxt-vite-config', | ||
| config(viteConfig: UserConfig, env: ConfigEnv) { | ||
| // Only run in production builds | ||
| if (!sourceMapsEnabled || env.mode === 'development' || nuxt.options?._prepare) { | ||
| return; | ||
| } | ||
|
|
||
| // Detect runtime from Vite config | ||
| // In Nuxt, SSR builds have build.ssr: true, client builds don't | ||
| const runtime = viteConfig.build?.ssr ? 'server' : 'client'; | ||
|
|
||
| const nuxtSourceMapSetting = extractNuxtSourceMapSetting(nuxt, runtime); | ||
|
|
||
| // Initialize build config if needed | ||
| viteConfig.build = viteConfig.build || {}; | ||
| const viteSourceMap = viteConfig.build.sourcemap; | ||
|
|
||
| // Vite source map options are the same as the Nuxt source map config options (unless overwritten) | ||
| validateDifferentSourceMapSettings({ | ||
| nuxtSettingKey: `sourcemap.${runtime}`, | ||
| nuxtSettingValue: nuxtSourceMapSetting, | ||
| otherSettingKey: 'viteConfig.build.sourcemap', | ||
| otherSettingValue: viteSourceMap, | ||
| }); | ||
|
|
||
| if (isDebug) { | ||
| // eslint-disable-next-line no-console | ||
| console.log(`[Sentry] Adding Sentry Vite plugin to the ${runtime} runtime.`); | ||
| } | ||
|
|
||
| // Add Sentry plugin by mutating the config | ||
| // Vite plugin is added on the client and server side (plugin runs for both builds) | ||
| // Nuxt client source map is 'false' by default. Warning about this will be shown already in an earlier step, and it's also documented that `nuxt.sourcemap.client` needs to be enabled. | ||
| viteConfig.plugins = viteConfig.plugins || []; | ||
| viteConfig.plugins.push(sentryVitePlugin(getPluginOptions(moduleOptions, shouldDeleteFilesFallback))); | ||
| }, | ||
| }; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.