feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option#22875

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.

Sign up for GitHub

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
nicohrubec merged 4 commits into from
Aug 3, 2026
Merged

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option #22875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
769aa9a
ref(nuxt)!: Remove deprecated `sourceMapsUploadOptions` module option
nicohrubec Jul 30, 2026
ab62810
test(nuxt): Cover root-level option resolution and `sourcemaps.disable`
nicohrubec Jul 31, 2026
e5e5210
ref(nuxt): Preserve original filesToDeleteAfterUpload truthiness sema…
nicohrubec Jul 31, 2026
7957430
docs(nuxt): Clarify source map deletion comment and add migration entry
nicohrubec Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -502,6 +502,38 @@ Remove these options from your `next.config.js` / `next.config.ts`.

The deprecated `sourceMapsUploadOptions` and other deprecated Vite/build plugin options were removed from `@sentry/astro`, `@sentry/nuxt`, `@sentry/sveltekit`, and `@sentry/react-router`. Use the top-level equivalents (e.g. `sourcemaps`, `release`, `authToken`, `org`, `project`, `telemetry`) instead.

### `@sentry/nuxt`

The deprecated `sourceMapsUploadOptions` module option was removed. Move its fields to the root level of the `sentry` module options. Note that `url` was renamed to `sentryUrl`, and `enabled` was replaced by `sourcemaps.disable` (inverted: `enabled: false` becomes `sourcemaps: { disable: true }`).

```ts
// nuxt.config.ts
export default defineNuxtConfig({
modules: ['@sentry/nuxt/module'],
sentry: {
// before
sourceMapsUploadOptions: {
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
url: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},

// after
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
sentryUrl: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},
});
```

## 4. Package Removals

### `@sentry/types` is no longer published
Expand Down
161 changes: 0 additions & 161 deletions packages/nuxt/src/common/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,156 +22,6 @@ export type SentryNuxtServerOptions = Parameters<typeof initNode>[0] & {
enableNitroErrorHandler?: boolean;
};

type SourceMapsOptions = {
/**
* Suppresses all logs.
*
* @default false
* @deprecated Use option `silent` instead of `sourceMapsUploadOptions.silent`
*/
silent?: boolean;

/**
* When an error occurs during release creation or sourcemaps upload, the plugin will call this function.
*
* By default, the plugin will simply throw an error, thereby stopping the bundling process.
* If an `errorHandler` callback is provided, compilation will continue, unless an error is
* thrown in the provided callback.
*
* To allow compilation to continue but still emit a warning, set this option to the following:
*
* ```js
* (err) => {
* console.warn(err);
* }
* ```
*
* @deprecated Use option `errorHandler` instead of `sourceMapsUploadOptions.errorHandler`
*/
errorHandler?: (err: Error) => void;

/**
* Options related to managing the Sentry releases for a build.
*
* More info: https://docs.sentry.io/product/releases/
*
* @deprecated Use option `release` instead of `sourceMapsUploadOptions.release`
*/
release?: {
/**
* Unique identifier for the release you want to create.
*
* This value can also be specified via the `SENTRY_RELEASE` environment variable.
*
* Defaults to automatically detecting a value for your environment.
* This includes values for Cordova, Heroku, AWS CodeBuild, CircleCI, Xcode, and Gradle, and otherwise uses the git `HEAD`'s commit SHA.
* (the latter requires access to git CLI and for the root directory to be a valid repository)
*
* If you didn't provide a value and the plugin can't automatically detect one, no release will be created.
*
* @deprecated Use `release.name` instead of `sourceMapsUploadOptions.release.name`
*/
name?: string;
};

/**
* If this flag is `true`, and an auth token is detected, the Sentry SDK will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use option `sourcemaps.disable` instead of `sourceMapsUploadOptions.enabled`
*/
enabled?: boolean;

/**
* The auth token to use when uploading source maps to Sentry.
*
* Instead of specifying this option, you can also set the `SENTRY_AUTH_TOKEN` environment variable.
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
* @deprecated Use option `authToken` instead of `sourceMapsUploadOptions.authToken`
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
* @deprecated Use option `org` instead of `sourceMapsUploadOptions.org`
*/
org?: string;

/**
* The URL of your Sentry instance if you're using self-hosted Sentry.
*
* @default https://sentry.io by default the plugin will point towards the Sentry SaaS URL
* @deprecated Use `sentryUrl` instead of `sourceMapsUploadOptions.url`
*/
url?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use option `project` instead of `sourceMapsUploadOptions.project`
*/
project?: string;

/**
* If this flag is `true`, the Sentry plugin will collect some telemetry data and send it to Sentry.
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use option `telemetry` instead of `sourceMapsUploadOptions.telemetry`
*/
telemetry?: boolean;

/**
* Options related to sourcemaps
*
* @deprecated Use option `sourcemaps` instead of `sourceMapsUploadOptions.sourcemaps`
*/
sourcemaps?: {
/**
* A glob or an array of globs that specify the build artifacts and source maps that will be uploaded to Sentry.
*
* If this option is not specified, sensible defaults based on your adapter and nuxt.config.js
* setup will be used. Use this option to override these defaults, for instance if you have a
* customized build setup that diverges from Nuxt's defaults.
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use option `sourcemaps.assets` instead of `sourceMapsUploadOptions.sourcemaps.assets`
*/
assets?: string | Array<string>;

/**
* A glob or an array of globs that specifies which build artifacts should not be uploaded to Sentry.
*
* @default [] - By default no files are ignored. Thus, all files matching the `assets` glob
* or the default value for `assets` are uploaded.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.ignore` instead of `sourceMapsUploadOptions.sourcemaps.ignore`
*/
ignore?: string | Array<string>;

/**
* A glob or an array of globs that specifies the build artifacts that should be deleted after the artifact
* upload to Sentry has been completed.
*
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.filesToDeleteAfterUpload` instead of `sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload`
*/
filesToDeleteAfterUpload?: string | Array<string>;
};
};

/**
* Build options for the Sentry module. These options are used during build-time by the Sentry SDK.
*/
Expand DownExpand Up@@ -200,17 +50,6 @@ export type SentryNuxtModuleOptions = BuildTimeOptionsBase & {
useDiagnosticsChannelInjection?: boolean;
};

/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentry` module options in the `nuxt.config.(js|ts).
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*
* @deprecated This option was deprecated as it adds unnecessary nesting.
* Put the options one level higher to the root-level of the `sentry` module options.
*/
sourceMapsUploadOptions?: SourceMapsOptions;

/**
*
* Enables (partial) server tracing by automatically injecting Sentry for environments where modifying the node option `--import` is not possible.
Expand Down
126 changes: 53 additions & 73 deletions packages/nuxt/src/vite/sourceMaps.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,20 +22,9 @@ export function setupSourceMaps(
nuxt: Nuxt,
addVitePlugin: (plugin: Plugin[], options?: { dev?: boolean; build?: boolean }) => void,
): void {
// TODO(v11): remove deprecated options (also from SentryNuxtModuleOptions type)

const isDebug = moduleOptions.debug;

// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const sourceMapsEnabled =
moduleOptions.sourcemaps?.disable === true
? false
: moduleOptions.sourcemaps?.disable === false
? true
: // eslint-disable-next-line typescript/no-deprecated
(sourceMapsUploadOptions.enabled ?? true);
const sourceMapsEnabled = moduleOptions.sourcemaps?.disable !== true;

@chargomechargomeJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nicohrubecnicohrubecJul 31, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed hahaha


// In case we overwrite the source map settings, we default to deleting the files
const shouldDeleteFilesFallback = { client: true, server: true };
Expand All@@ -62,11 +51,7 @@ export function setupSourceMaps(
? 'server-side'
: 'client-side';

if (
!moduleOptions.sourcemaps?.filesToDeleteAfterUpload &&
// eslint-disable-next-line typescript/no-deprecated
!sourceMapsUploadOptions.sourcemaps?.filesToDeleteAfterUpload
) {
if (!moduleOptions.sourcemaps?.filesToDeleteAfterUpload) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] We enabled \`'hidden'\` source maps for your ${enabledDeleteFallbacks} build. Source map files will be automatically deleted after uploading them to Sentry.`,
Expand DownExpand Up@@ -131,65 +116,27 @@ function normalizePath(path: string): string {
*
* Only exported for Testing purposes.
*/
// todo(v11): This "eslint-disable" can be removed again once we remove deprecated options.
// eslint-disable-next-line complexity
export function getPluginOptions(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): SentryVitePluginOptions | SentryRollupPluginOptions {
// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

// Check for filesToDeleteAfterUpload in new location first, then deprecated location
const sourcemapsOptions = moduleOptions.sourcemaps || {};
// eslint-disable-next-line typescript/no-deprecated
const deprecatedSourcemapsOptions = sourceMapsUploadOptions.sourcemaps || {};

const filesToDeleteAfterUpload =
sourcemapsOptions.filesToDeleteAfterUpload ??
// eslint-disable-next-line typescript/no-deprecated
deprecatedSourcemapsOptions.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}
const filesToDeleteAfterUpload = resolveFilesToDeleteAfterUpload(moduleOptions, shouldDeleteFilesFallback);

return {
applicationKey: moduleOptions.applicationKey,
// eslint-disable-next-line typescript/no-deprecated
org: moduleOptions.org ?? sourceMapsUploadOptions.org ?? process.env.SENTRY_ORG,
// eslint-disable-next-line typescript/no-deprecated
project: moduleOptions.project ?? sourceMapsUploadOptions.project ?? process.env.SENTRY_PROJECT,
// eslint-disable-next-line typescript/no-deprecated
authToken: moduleOptions.authToken ?? sourceMapsUploadOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
// eslint-disable-next-line typescript/no-deprecated
telemetry: moduleOptions.telemetry ?? sourceMapsUploadOptions.telemetry ?? true,
// eslint-disable-next-line typescript/no-deprecated
url: moduleOptions.sentryUrl ?? sourceMapsUploadOptions.url ?? process.env.SENTRY_URL,
org: moduleOptions.org ?? process.env.SENTRY_ORG,
project: moduleOptions.project ?? process.env.SENTRY_PROJECT,
authToken: moduleOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
telemetry: moduleOptions.telemetry ?? true,
url: moduleOptions.sentryUrl ?? process.env.SENTRY_URL,
headers: moduleOptions.headers,
debug: moduleOptions.debug ?? false,
// eslint-disable-next-line typescript/no-deprecated
silent: moduleOptions.silent ?? sourceMapsUploadOptions.silent ?? false,
// eslint-disable-next-line typescript/no-deprecated
errorHandler: moduleOptions.errorHandler ?? sourceMapsUploadOptions.errorHandler,
silent: moduleOptions.silent ?? false,
errorHandler: moduleOptions.errorHandler,
bundleSizeOptimizations: moduleOptions.bundleSizeOptimizations, // todo: test if this can be overridden by the user
release: {
// eslint-disable-next-line typescript/no-deprecated
name: moduleOptions.release?.name ?? sourceMapsUploadOptions.release?.name,
name: moduleOptions.release?.name,
// Support all release options from BuildTimeOptionsBase
...moduleOptions.release,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.release,
Expand All@@ -206,21 +153,54 @@ export function getPluginOptions(
// The server/client files are in different places depending on the nitro preset (e.g. '.output/server' or '.netlify/functions-internal/server')
// We cannot determine automatically how the build folder looks like (depends on the preset), so we have to accept that source maps are uploaded multiple times (with the vitePlugin for Nuxt and the rollupPlugin for Nitro).
// If we could know where the server/client assets are located, we could do something like this (based on the Nitro preset): isNitro ? ['./.output/server/**/*'] : ['./.output/public/**/*'],
// eslint-disable-next-line typescript/no-deprecated
assets: sourcemapsOptions.assets ?? deprecatedSourcemapsOptions.assets ?? undefined,
// eslint-disable-next-line typescript/no-deprecated
ignore: sourcemapsOptions.ignore ?? deprecatedSourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload: filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesFallback?.server || shouldDeleteFilesFallback?.client
? fallbackFilesToDelete
: undefined,
assets: sourcemapsOptions.assets ?? undefined,
ignore: sourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload,
rewriteSources: sourcemapsOptions.rewriteSources ?? normalizePath,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.sourcemaps,
},
};
}

/**
* Determines which files to delete after upload. If the user set `filesToDeleteAfterUpload`, we use
* that. Otherwise we only delete the source maps Sentry generated itself — i.e. the sides
* (client/server) whose `sourcemap` setting resolved to `undefined`, where Sentry stepped in and
* enabled `'hidden'`. Given Nuxt's default of `{ server: true, client: false }`, this isn't the
* default case: it only kicks in when a side is left `undefined` (whole config or a single sub-key).
* @see https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap
*/
Comment on lines +165 to +172

@s1gr1ds1gr1dJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nuxt has no undefined default values for source maps so this "deleting by default" cannot happen in the default case. Only if users would set them to undefined.

Maybe that's worth pointing out here. Also a link to the docs: https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap

function resolveFilesToDeleteAfterUpload(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): string | Array<string> | undefined {
const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

const filesToDeleteAfterUpload = moduleOptions.sourcemaps?.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}

return filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesAfterUpload
? fallbackFilesToDelete
: undefined;
}

/* There are multiple ways to set up source maps (https://github.com/getsentry/sentry-javascript/issues/13993 and https://github.com/getsentry/sentry-javascript/pull/15859)
1. User explicitly disabled source maps
- keep this setting (emit a warning that errors won't be unminified in Sentry)
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option#22875

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.

Sign up for GitHub

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
nicohrubec merged 4 commits into from
Aug 3, 2026
Merged

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option #22875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
769aa9a
ref(nuxt)!: Remove deprecated `sourceMapsUploadOptions` module option
nicohrubec Jul 30, 2026
ab62810
test(nuxt): Cover root-level option resolution and `sourcemaps.disable`
nicohrubec Jul 31, 2026
e5e5210
ref(nuxt): Preserve original filesToDeleteAfterUpload truthiness sema…
nicohrubec Jul 31, 2026
7957430
docs(nuxt): Clarify source map deletion comment and add migration entry
nicohrubec Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -502,6 +502,38 @@ Remove these options from your `next.config.js` / `next.config.ts`.

The deprecated `sourceMapsUploadOptions` and other deprecated Vite/build plugin options were removed from `@sentry/astro`, `@sentry/nuxt`, `@sentry/sveltekit`, and `@sentry/react-router`. Use the top-level equivalents (e.g. `sourcemaps`, `release`, `authToken`, `org`, `project`, `telemetry`) instead.

### `@sentry/nuxt`

The deprecated `sourceMapsUploadOptions` module option was removed. Move its fields to the root level of the `sentry` module options. Note that `url` was renamed to `sentryUrl`, and `enabled` was replaced by `sourcemaps.disable` (inverted: `enabled: false` becomes `sourcemaps: { disable: true }`).

```ts
// nuxt.config.ts
export default defineNuxtConfig({
modules: ['@sentry/nuxt/module'],
sentry: {
// before
sourceMapsUploadOptions: {
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
url: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},

// after
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
sentryUrl: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},
});
```

## 4. Package Removals

### `@sentry/types` is no longer published
Expand Down
161 changes: 0 additions & 161 deletions packages/nuxt/src/common/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,156 +22,6 @@ export type SentryNuxtServerOptions = Parameters<typeof initNode>[0] & {
enableNitroErrorHandler?: boolean;
};

type SourceMapsOptions = {
/**
* Suppresses all logs.
*
* @default false
* @deprecated Use option `silent` instead of `sourceMapsUploadOptions.silent`
*/
silent?: boolean;

/**
* When an error occurs during release creation or sourcemaps upload, the plugin will call this function.
*
* By default, the plugin will simply throw an error, thereby stopping the bundling process.
* If an `errorHandler` callback is provided, compilation will continue, unless an error is
* thrown in the provided callback.
*
* To allow compilation to continue but still emit a warning, set this option to the following:
*
* ```js
* (err) => {
* console.warn(err);
* }
* ```
*
* @deprecated Use option `errorHandler` instead of `sourceMapsUploadOptions.errorHandler`
*/
errorHandler?: (err: Error) => void;

/**
* Options related to managing the Sentry releases for a build.
*
* More info: https://docs.sentry.io/product/releases/
*
* @deprecated Use option `release` instead of `sourceMapsUploadOptions.release`
*/
release?: {
/**
* Unique identifier for the release you want to create.
*
* This value can also be specified via the `SENTRY_RELEASE` environment variable.
*
* Defaults to automatically detecting a value for your environment.
* This includes values for Cordova, Heroku, AWS CodeBuild, CircleCI, Xcode, and Gradle, and otherwise uses the git `HEAD`'s commit SHA.
* (the latter requires access to git CLI and for the root directory to be a valid repository)
*
* If you didn't provide a value and the plugin can't automatically detect one, no release will be created.
*
* @deprecated Use `release.name` instead of `sourceMapsUploadOptions.release.name`
*/
name?: string;
};

/**
* If this flag is `true`, and an auth token is detected, the Sentry SDK will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use option `sourcemaps.disable` instead of `sourceMapsUploadOptions.enabled`
*/
enabled?: boolean;

/**
* The auth token to use when uploading source maps to Sentry.
*
* Instead of specifying this option, you can also set the `SENTRY_AUTH_TOKEN` environment variable.
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
* @deprecated Use option `authToken` instead of `sourceMapsUploadOptions.authToken`
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
* @deprecated Use option `org` instead of `sourceMapsUploadOptions.org`
*/
org?: string;

/**
* The URL of your Sentry instance if you're using self-hosted Sentry.
*
* @default https://sentry.io by default the plugin will point towards the Sentry SaaS URL
* @deprecated Use `sentryUrl` instead of `sourceMapsUploadOptions.url`
*/
url?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use option `project` instead of `sourceMapsUploadOptions.project`
*/
project?: string;

/**
* If this flag is `true`, the Sentry plugin will collect some telemetry data and send it to Sentry.
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use option `telemetry` instead of `sourceMapsUploadOptions.telemetry`
*/
telemetry?: boolean;

/**
* Options related to sourcemaps
*
* @deprecated Use option `sourcemaps` instead of `sourceMapsUploadOptions.sourcemaps`
*/
sourcemaps?: {
/**
* A glob or an array of globs that specify the build artifacts and source maps that will be uploaded to Sentry.
*
* If this option is not specified, sensible defaults based on your adapter and nuxt.config.js
* setup will be used. Use this option to override these defaults, for instance if you have a
* customized build setup that diverges from Nuxt's defaults.
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use option `sourcemaps.assets` instead of `sourceMapsUploadOptions.sourcemaps.assets`
*/
assets?: string | Array<string>;

/**
* A glob or an array of globs that specifies which build artifacts should not be uploaded to Sentry.
*
* @default [] - By default no files are ignored. Thus, all files matching the `assets` glob
* or the default value for `assets` are uploaded.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.ignore` instead of `sourceMapsUploadOptions.sourcemaps.ignore`
*/
ignore?: string | Array<string>;

/**
* A glob or an array of globs that specifies the build artifacts that should be deleted after the artifact
* upload to Sentry has been completed.
*
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.filesToDeleteAfterUpload` instead of `sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload`
*/
filesToDeleteAfterUpload?: string | Array<string>;
};
};

/**
* Build options for the Sentry module. These options are used during build-time by the Sentry SDK.
*/
Expand DownExpand Up@@ -200,17 +50,6 @@ export type SentryNuxtModuleOptions = BuildTimeOptionsBase & {
useDiagnosticsChannelInjection?: boolean;
};

/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentry` module options in the `nuxt.config.(js|ts).
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*
* @deprecated This option was deprecated as it adds unnecessary nesting.
* Put the options one level higher to the root-level of the `sentry` module options.
*/
sourceMapsUploadOptions?: SourceMapsOptions;

/**
*
* Enables (partial) server tracing by automatically injecting Sentry for environments where modifying the node option `--import` is not possible.
Expand Down
126 changes: 53 additions & 73 deletions packages/nuxt/src/vite/sourceMaps.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,20 +22,9 @@ export function setupSourceMaps(
nuxt: Nuxt,
addVitePlugin: (plugin: Plugin[], options?: { dev?: boolean; build?: boolean }) => void,
): void {
// TODO(v11): remove deprecated options (also from SentryNuxtModuleOptions type)

const isDebug = moduleOptions.debug;

// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const sourceMapsEnabled =
moduleOptions.sourcemaps?.disable === true
? false
: moduleOptions.sourcemaps?.disable === false
? true
: // eslint-disable-next-line typescript/no-deprecated
(sourceMapsUploadOptions.enabled ?? true);
const sourceMapsEnabled = moduleOptions.sourcemaps?.disable !== true;

@chargomechargomeJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nicohrubecnicohrubecJul 31, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed hahaha


// In case we overwrite the source map settings, we default to deleting the files
const shouldDeleteFilesFallback = { client: true, server: true };
Expand All@@ -62,11 +51,7 @@ export function setupSourceMaps(
? 'server-side'
: 'client-side';

if (
!moduleOptions.sourcemaps?.filesToDeleteAfterUpload &&
// eslint-disable-next-line typescript/no-deprecated
!sourceMapsUploadOptions.sourcemaps?.filesToDeleteAfterUpload
) {
if (!moduleOptions.sourcemaps?.filesToDeleteAfterUpload) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] We enabled \`'hidden'\` source maps for your ${enabledDeleteFallbacks} build. Source map files will be automatically deleted after uploading them to Sentry.`,
Expand DownExpand Up@@ -131,65 +116,27 @@ function normalizePath(path: string): string {
*
* Only exported for Testing purposes.
*/
// todo(v11): This "eslint-disable" can be removed again once we remove deprecated options.
// eslint-disable-next-line complexity
export function getPluginOptions(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): SentryVitePluginOptions | SentryRollupPluginOptions {
// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

// Check for filesToDeleteAfterUpload in new location first, then deprecated location
const sourcemapsOptions = moduleOptions.sourcemaps || {};
// eslint-disable-next-line typescript/no-deprecated
const deprecatedSourcemapsOptions = sourceMapsUploadOptions.sourcemaps || {};

const filesToDeleteAfterUpload =
sourcemapsOptions.filesToDeleteAfterUpload ??
// eslint-disable-next-line typescript/no-deprecated
deprecatedSourcemapsOptions.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}
const filesToDeleteAfterUpload = resolveFilesToDeleteAfterUpload(moduleOptions, shouldDeleteFilesFallback);

return {
applicationKey: moduleOptions.applicationKey,
// eslint-disable-next-line typescript/no-deprecated
org: moduleOptions.org ?? sourceMapsUploadOptions.org ?? process.env.SENTRY_ORG,
// eslint-disable-next-line typescript/no-deprecated
project: moduleOptions.project ?? sourceMapsUploadOptions.project ?? process.env.SENTRY_PROJECT,
// eslint-disable-next-line typescript/no-deprecated
authToken: moduleOptions.authToken ?? sourceMapsUploadOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
// eslint-disable-next-line typescript/no-deprecated
telemetry: moduleOptions.telemetry ?? sourceMapsUploadOptions.telemetry ?? true,
// eslint-disable-next-line typescript/no-deprecated
url: moduleOptions.sentryUrl ?? sourceMapsUploadOptions.url ?? process.env.SENTRY_URL,
org: moduleOptions.org ?? process.env.SENTRY_ORG,
project: moduleOptions.project ?? process.env.SENTRY_PROJECT,
authToken: moduleOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
telemetry: moduleOptions.telemetry ?? true,
url: moduleOptions.sentryUrl ?? process.env.SENTRY_URL,
headers: moduleOptions.headers,
debug: moduleOptions.debug ?? false,
// eslint-disable-next-line typescript/no-deprecated
silent: moduleOptions.silent ?? sourceMapsUploadOptions.silent ?? false,
// eslint-disable-next-line typescript/no-deprecated
errorHandler: moduleOptions.errorHandler ?? sourceMapsUploadOptions.errorHandler,
silent: moduleOptions.silent ?? false,
errorHandler: moduleOptions.errorHandler,
bundleSizeOptimizations: moduleOptions.bundleSizeOptimizations, // todo: test if this can be overridden by the user
release: {
// eslint-disable-next-line typescript/no-deprecated
name: moduleOptions.release?.name ?? sourceMapsUploadOptions.release?.name,
name: moduleOptions.release?.name,
// Support all release options from BuildTimeOptionsBase
...moduleOptions.release,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.release,
Expand All@@ -206,21 +153,54 @@ export function getPluginOptions(
// The server/client files are in different places depending on the nitro preset (e.g. '.output/server' or '.netlify/functions-internal/server')
// We cannot determine automatically how the build folder looks like (depends on the preset), so we have to accept that source maps are uploaded multiple times (with the vitePlugin for Nuxt and the rollupPlugin for Nitro).
// If we could know where the server/client assets are located, we could do something like this (based on the Nitro preset): isNitro ? ['./.output/server/**/*'] : ['./.output/public/**/*'],
// eslint-disable-next-line typescript/no-deprecated
assets: sourcemapsOptions.assets ?? deprecatedSourcemapsOptions.assets ?? undefined,
// eslint-disable-next-line typescript/no-deprecated
ignore: sourcemapsOptions.ignore ?? deprecatedSourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload: filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesFallback?.server || shouldDeleteFilesFallback?.client
? fallbackFilesToDelete
: undefined,
assets: sourcemapsOptions.assets ?? undefined,
ignore: sourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload,
rewriteSources: sourcemapsOptions.rewriteSources ?? normalizePath,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.sourcemaps,
},
};
}

/**
* Determines which files to delete after upload. If the user set `filesToDeleteAfterUpload`, we use
* that. Otherwise we only delete the source maps Sentry generated itself — i.e. the sides
* (client/server) whose `sourcemap` setting resolved to `undefined`, where Sentry stepped in and
* enabled `'hidden'`. Given Nuxt's default of `{ server: true, client: false }`, this isn't the
* default case: it only kicks in when a side is left `undefined` (whole config or a single sub-key).
* @see https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap
*/
Comment on lines +165 to +172

@s1gr1ds1gr1dJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nuxt has no undefined default values for source maps so this "deleting by default" cannot happen in the default case. Only if users would set them to undefined.

Maybe that's worth pointing out here. Also a link to the docs: https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap

function resolveFilesToDeleteAfterUpload(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): string | Array<string> | undefined {
const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

const filesToDeleteAfterUpload = moduleOptions.sourcemaps?.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}

return filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesAfterUpload
? fallbackFilesToDelete
: undefined;
}

/* There are multiple ways to set up source maps (https://github.com/getsentry/sentry-javascript/issues/13993 and https://github.com/getsentry/sentry-javascript/pull/15859)
1. User explicitly disabled source maps
- keep this setting (emit a warning that errors won't be unminified in Sentry)
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option#22875

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.

Sign up for GitHub

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
nicohrubec merged 4 commits into from
Aug 3, 2026
Merged

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option #22875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
769aa9a
ref(nuxt)!: Remove deprecated `sourceMapsUploadOptions` module option
nicohrubec Jul 30, 2026
ab62810
test(nuxt): Cover root-level option resolution and `sourcemaps.disable`
nicohrubec Jul 31, 2026
e5e5210
ref(nuxt): Preserve original filesToDeleteAfterUpload truthiness sema…
nicohrubec Jul 31, 2026
7957430
docs(nuxt): Clarify source map deletion comment and add migration entry
nicohrubec Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -502,6 +502,38 @@ Remove these options from your `next.config.js` / `next.config.ts`.

The deprecated `sourceMapsUploadOptions` and other deprecated Vite/build plugin options were removed from `@sentry/astro`, `@sentry/nuxt`, `@sentry/sveltekit`, and `@sentry/react-router`. Use the top-level equivalents (e.g. `sourcemaps`, `release`, `authToken`, `org`, `project`, `telemetry`) instead.

### `@sentry/nuxt`

The deprecated `sourceMapsUploadOptions` module option was removed. Move its fields to the root level of the `sentry` module options. Note that `url` was renamed to `sentryUrl`, and `enabled` was replaced by `sourcemaps.disable` (inverted: `enabled: false` becomes `sourcemaps: { disable: true }`).

```ts
// nuxt.config.ts
export default defineNuxtConfig({
modules: ['@sentry/nuxt/module'],
sentry: {
// before
sourceMapsUploadOptions: {
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
url: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},

// after
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
sentryUrl: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},
});
```

## 4. Package Removals

### `@sentry/types` is no longer published
Expand Down
161 changes: 0 additions & 161 deletions packages/nuxt/src/common/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,156 +22,6 @@ export type SentryNuxtServerOptions = Parameters<typeof initNode>[0] & {
enableNitroErrorHandler?: boolean;
};

type SourceMapsOptions = {
/**
* Suppresses all logs.
*
* @default false
* @deprecated Use option `silent` instead of `sourceMapsUploadOptions.silent`
*/
silent?: boolean;

/**
* When an error occurs during release creation or sourcemaps upload, the plugin will call this function.
*
* By default, the plugin will simply throw an error, thereby stopping the bundling process.
* If an `errorHandler` callback is provided, compilation will continue, unless an error is
* thrown in the provided callback.
*
* To allow compilation to continue but still emit a warning, set this option to the following:
*
* ```js
* (err) => {
* console.warn(err);
* }
* ```
*
* @deprecated Use option `errorHandler` instead of `sourceMapsUploadOptions.errorHandler`
*/
errorHandler?: (err: Error) => void;

/**
* Options related to managing the Sentry releases for a build.
*
* More info: https://docs.sentry.io/product/releases/
*
* @deprecated Use option `release` instead of `sourceMapsUploadOptions.release`
*/
release?: {
/**
* Unique identifier for the release you want to create.
*
* This value can also be specified via the `SENTRY_RELEASE` environment variable.
*
* Defaults to automatically detecting a value for your environment.
* This includes values for Cordova, Heroku, AWS CodeBuild, CircleCI, Xcode, and Gradle, and otherwise uses the git `HEAD`'s commit SHA.
* (the latter requires access to git CLI and for the root directory to be a valid repository)
*
* If you didn't provide a value and the plugin can't automatically detect one, no release will be created.
*
* @deprecated Use `release.name` instead of `sourceMapsUploadOptions.release.name`
*/
name?: string;
};

/**
* If this flag is `true`, and an auth token is detected, the Sentry SDK will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use option `sourcemaps.disable` instead of `sourceMapsUploadOptions.enabled`
*/
enabled?: boolean;

/**
* The auth token to use when uploading source maps to Sentry.
*
* Instead of specifying this option, you can also set the `SENTRY_AUTH_TOKEN` environment variable.
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
* @deprecated Use option `authToken` instead of `sourceMapsUploadOptions.authToken`
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
* @deprecated Use option `org` instead of `sourceMapsUploadOptions.org`
*/
org?: string;

/**
* The URL of your Sentry instance if you're using self-hosted Sentry.
*
* @default https://sentry.io by default the plugin will point towards the Sentry SaaS URL
* @deprecated Use `sentryUrl` instead of `sourceMapsUploadOptions.url`
*/
url?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use option `project` instead of `sourceMapsUploadOptions.project`
*/
project?: string;

/**
* If this flag is `true`, the Sentry plugin will collect some telemetry data and send it to Sentry.
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use option `telemetry` instead of `sourceMapsUploadOptions.telemetry`
*/
telemetry?: boolean;

/**
* Options related to sourcemaps
*
* @deprecated Use option `sourcemaps` instead of `sourceMapsUploadOptions.sourcemaps`
*/
sourcemaps?: {
/**
* A glob or an array of globs that specify the build artifacts and source maps that will be uploaded to Sentry.
*
* If this option is not specified, sensible defaults based on your adapter and nuxt.config.js
* setup will be used. Use this option to override these defaults, for instance if you have a
* customized build setup that diverges from Nuxt's defaults.
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use option `sourcemaps.assets` instead of `sourceMapsUploadOptions.sourcemaps.assets`
*/
assets?: string | Array<string>;

/**
* A glob or an array of globs that specifies which build artifacts should not be uploaded to Sentry.
*
* @default [] - By default no files are ignored. Thus, all files matching the `assets` glob
* or the default value for `assets` are uploaded.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.ignore` instead of `sourceMapsUploadOptions.sourcemaps.ignore`
*/
ignore?: string | Array<string>;

/**
* A glob or an array of globs that specifies the build artifacts that should be deleted after the artifact
* upload to Sentry has been completed.
*
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.filesToDeleteAfterUpload` instead of `sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload`
*/
filesToDeleteAfterUpload?: string | Array<string>;
};
};

/**
* Build options for the Sentry module. These options are used during build-time by the Sentry SDK.
*/
Expand DownExpand Up@@ -200,17 +50,6 @@ export type SentryNuxtModuleOptions = BuildTimeOptionsBase & {
useDiagnosticsChannelInjection?: boolean;
};

/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentry` module options in the `nuxt.config.(js|ts).
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*
* @deprecated This option was deprecated as it adds unnecessary nesting.
* Put the options one level higher to the root-level of the `sentry` module options.
*/
sourceMapsUploadOptions?: SourceMapsOptions;

/**
*
* Enables (partial) server tracing by automatically injecting Sentry for environments where modifying the node option `--import` is not possible.
Expand Down
126 changes: 53 additions & 73 deletions packages/nuxt/src/vite/sourceMaps.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,20 +22,9 @@ export function setupSourceMaps(
nuxt: Nuxt,
addVitePlugin: (plugin: Plugin[], options?: { dev?: boolean; build?: boolean }) => void,
): void {
// TODO(v11): remove deprecated options (also from SentryNuxtModuleOptions type)

const isDebug = moduleOptions.debug;

// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const sourceMapsEnabled =
moduleOptions.sourcemaps?.disable === true
? false
: moduleOptions.sourcemaps?.disable === false
? true
: // eslint-disable-next-line typescript/no-deprecated
(sourceMapsUploadOptions.enabled ?? true);
const sourceMapsEnabled = moduleOptions.sourcemaps?.disable !== true;

@chargomechargomeJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nicohrubecnicohrubecJul 31, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed hahaha


// In case we overwrite the source map settings, we default to deleting the files
const shouldDeleteFilesFallback = { client: true, server: true };
Expand All@@ -62,11 +51,7 @@ export function setupSourceMaps(
? 'server-side'
: 'client-side';

if (
!moduleOptions.sourcemaps?.filesToDeleteAfterUpload &&
// eslint-disable-next-line typescript/no-deprecated
!sourceMapsUploadOptions.sourcemaps?.filesToDeleteAfterUpload
) {
if (!moduleOptions.sourcemaps?.filesToDeleteAfterUpload) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] We enabled \`'hidden'\` source maps for your ${enabledDeleteFallbacks} build. Source map files will be automatically deleted after uploading them to Sentry.`,
Expand DownExpand Up@@ -131,65 +116,27 @@ function normalizePath(path: string): string {
*
* Only exported for Testing purposes.
*/
// todo(v11): This "eslint-disable" can be removed again once we remove deprecated options.
// eslint-disable-next-line complexity
export function getPluginOptions(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): SentryVitePluginOptions | SentryRollupPluginOptions {
// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

// Check for filesToDeleteAfterUpload in new location first, then deprecated location
const sourcemapsOptions = moduleOptions.sourcemaps || {};
// eslint-disable-next-line typescript/no-deprecated
const deprecatedSourcemapsOptions = sourceMapsUploadOptions.sourcemaps || {};

const filesToDeleteAfterUpload =
sourcemapsOptions.filesToDeleteAfterUpload ??
// eslint-disable-next-line typescript/no-deprecated
deprecatedSourcemapsOptions.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}
const filesToDeleteAfterUpload = resolveFilesToDeleteAfterUpload(moduleOptions, shouldDeleteFilesFallback);

return {
applicationKey: moduleOptions.applicationKey,
// eslint-disable-next-line typescript/no-deprecated
org: moduleOptions.org ?? sourceMapsUploadOptions.org ?? process.env.SENTRY_ORG,
// eslint-disable-next-line typescript/no-deprecated
project: moduleOptions.project ?? sourceMapsUploadOptions.project ?? process.env.SENTRY_PROJECT,
// eslint-disable-next-line typescript/no-deprecated
authToken: moduleOptions.authToken ?? sourceMapsUploadOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
// eslint-disable-next-line typescript/no-deprecated
telemetry: moduleOptions.telemetry ?? sourceMapsUploadOptions.telemetry ?? true,
// eslint-disable-next-line typescript/no-deprecated
url: moduleOptions.sentryUrl ?? sourceMapsUploadOptions.url ?? process.env.SENTRY_URL,
org: moduleOptions.org ?? process.env.SENTRY_ORG,
project: moduleOptions.project ?? process.env.SENTRY_PROJECT,
authToken: moduleOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
telemetry: moduleOptions.telemetry ?? true,
url: moduleOptions.sentryUrl ?? process.env.SENTRY_URL,
headers: moduleOptions.headers,
debug: moduleOptions.debug ?? false,
// eslint-disable-next-line typescript/no-deprecated
silent: moduleOptions.silent ?? sourceMapsUploadOptions.silent ?? false,
// eslint-disable-next-line typescript/no-deprecated
errorHandler: moduleOptions.errorHandler ?? sourceMapsUploadOptions.errorHandler,
silent: moduleOptions.silent ?? false,
errorHandler: moduleOptions.errorHandler,
bundleSizeOptimizations: moduleOptions.bundleSizeOptimizations, // todo: test if this can be overridden by the user
release: {
// eslint-disable-next-line typescript/no-deprecated
name: moduleOptions.release?.name ?? sourceMapsUploadOptions.release?.name,
name: moduleOptions.release?.name,
// Support all release options from BuildTimeOptionsBase
...moduleOptions.release,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.release,
Expand All@@ -206,21 +153,54 @@ export function getPluginOptions(
// The server/client files are in different places depending on the nitro preset (e.g. '.output/server' or '.netlify/functions-internal/server')
// We cannot determine automatically how the build folder looks like (depends on the preset), so we have to accept that source maps are uploaded multiple times (with the vitePlugin for Nuxt and the rollupPlugin for Nitro).
// If we could know where the server/client assets are located, we could do something like this (based on the Nitro preset): isNitro ? ['./.output/server/**/*'] : ['./.output/public/**/*'],
// eslint-disable-next-line typescript/no-deprecated
assets: sourcemapsOptions.assets ?? deprecatedSourcemapsOptions.assets ?? undefined,
// eslint-disable-next-line typescript/no-deprecated
ignore: sourcemapsOptions.ignore ?? deprecatedSourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload: filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesFallback?.server || shouldDeleteFilesFallback?.client
? fallbackFilesToDelete
: undefined,
assets: sourcemapsOptions.assets ?? undefined,
ignore: sourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload,
rewriteSources: sourcemapsOptions.rewriteSources ?? normalizePath,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.sourcemaps,
},
};
}

/**
* Determines which files to delete after upload. If the user set `filesToDeleteAfterUpload`, we use
* that. Otherwise we only delete the source maps Sentry generated itself — i.e. the sides
* (client/server) whose `sourcemap` setting resolved to `undefined`, where Sentry stepped in and
* enabled `'hidden'`. Given Nuxt's default of `{ server: true, client: false }`, this isn't the
* default case: it only kicks in when a side is left `undefined` (whole config or a single sub-key).
* @see https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap
*/
Comment on lines +165 to +172

@s1gr1ds1gr1dJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nuxt has no undefined default values for source maps so this "deleting by default" cannot happen in the default case. Only if users would set them to undefined.

Maybe that's worth pointing out here. Also a link to the docs: https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap

function resolveFilesToDeleteAfterUpload(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): string | Array<string> | undefined {
const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

const filesToDeleteAfterUpload = moduleOptions.sourcemaps?.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}

return filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesAfterUpload
? fallbackFilesToDelete
: undefined;
}

/* There are multiple ways to set up source maps (https://github.com/getsentry/sentry-javascript/issues/13993 and https://github.com/getsentry/sentry-javascript/pull/15859)
1. User explicitly disabled source maps
- keep this setting (emit a warning that errors won't be unminified in Sentry)
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option#22875

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.

Sign up for GitHub

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
nicohrubec merged 4 commits into from
Aug 3, 2026
Merged

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option #22875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
769aa9a
ref(nuxt)!: Remove deprecated `sourceMapsUploadOptions` module option
nicohrubec Jul 30, 2026
ab62810
test(nuxt): Cover root-level option resolution and `sourcemaps.disable`
nicohrubec Jul 31, 2026
e5e5210
ref(nuxt): Preserve original filesToDeleteAfterUpload truthiness sema…
nicohrubec Jul 31, 2026
7957430
docs(nuxt): Clarify source map deletion comment and add migration entry
nicohrubec Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -502,6 +502,38 @@ Remove these options from your `next.config.js` / `next.config.ts`.

The deprecated `sourceMapsUploadOptions` and other deprecated Vite/build plugin options were removed from `@sentry/astro`, `@sentry/nuxt`, `@sentry/sveltekit`, and `@sentry/react-router`. Use the top-level equivalents (e.g. `sourcemaps`, `release`, `authToken`, `org`, `project`, `telemetry`) instead.

### `@sentry/nuxt`

The deprecated `sourceMapsUploadOptions` module option was removed. Move its fields to the root level of the `sentry` module options. Note that `url` was renamed to `sentryUrl`, and `enabled` was replaced by `sourcemaps.disable` (inverted: `enabled: false` becomes `sourcemaps: { disable: true }`).

```ts
// nuxt.config.ts
export default defineNuxtConfig({
modules: ['@sentry/nuxt/module'],
sentry: {
// before
sourceMapsUploadOptions: {
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
url: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},

// after
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
sentryUrl: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},
});
```

## 4. Package Removals

### `@sentry/types` is no longer published
Expand Down
161 changes: 0 additions & 161 deletions packages/nuxt/src/common/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,156 +22,6 @@ export type SentryNuxtServerOptions = Parameters<typeof initNode>[0] & {
enableNitroErrorHandler?: boolean;
};

type SourceMapsOptions = {
/**
* Suppresses all logs.
*
* @default false
* @deprecated Use option `silent` instead of `sourceMapsUploadOptions.silent`
*/
silent?: boolean;

/**
* When an error occurs during release creation or sourcemaps upload, the plugin will call this function.
*
* By default, the plugin will simply throw an error, thereby stopping the bundling process.
* If an `errorHandler` callback is provided, compilation will continue, unless an error is
* thrown in the provided callback.
*
* To allow compilation to continue but still emit a warning, set this option to the following:
*
* ```js
* (err) => {
* console.warn(err);
* }
* ```
*
* @deprecated Use option `errorHandler` instead of `sourceMapsUploadOptions.errorHandler`
*/
errorHandler?: (err: Error) => void;

/**
* Options related to managing the Sentry releases for a build.
*
* More info: https://docs.sentry.io/product/releases/
*
* @deprecated Use option `release` instead of `sourceMapsUploadOptions.release`
*/
release?: {
/**
* Unique identifier for the release you want to create.
*
* This value can also be specified via the `SENTRY_RELEASE` environment variable.
*
* Defaults to automatically detecting a value for your environment.
* This includes values for Cordova, Heroku, AWS CodeBuild, CircleCI, Xcode, and Gradle, and otherwise uses the git `HEAD`'s commit SHA.
* (the latter requires access to git CLI and for the root directory to be a valid repository)
*
* If you didn't provide a value and the plugin can't automatically detect one, no release will be created.
*
* @deprecated Use `release.name` instead of `sourceMapsUploadOptions.release.name`
*/
name?: string;
};

/**
* If this flag is `true`, and an auth token is detected, the Sentry SDK will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use option `sourcemaps.disable` instead of `sourceMapsUploadOptions.enabled`
*/
enabled?: boolean;

/**
* The auth token to use when uploading source maps to Sentry.
*
* Instead of specifying this option, you can also set the `SENTRY_AUTH_TOKEN` environment variable.
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
* @deprecated Use option `authToken` instead of `sourceMapsUploadOptions.authToken`
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
* @deprecated Use option `org` instead of `sourceMapsUploadOptions.org`
*/
org?: string;

/**
* The URL of your Sentry instance if you're using self-hosted Sentry.
*
* @default https://sentry.io by default the plugin will point towards the Sentry SaaS URL
* @deprecated Use `sentryUrl` instead of `sourceMapsUploadOptions.url`
*/
url?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use option `project` instead of `sourceMapsUploadOptions.project`
*/
project?: string;

/**
* If this flag is `true`, the Sentry plugin will collect some telemetry data and send it to Sentry.
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use option `telemetry` instead of `sourceMapsUploadOptions.telemetry`
*/
telemetry?: boolean;

/**
* Options related to sourcemaps
*
* @deprecated Use option `sourcemaps` instead of `sourceMapsUploadOptions.sourcemaps`
*/
sourcemaps?: {
/**
* A glob or an array of globs that specify the build artifacts and source maps that will be uploaded to Sentry.
*
* If this option is not specified, sensible defaults based on your adapter and nuxt.config.js
* setup will be used. Use this option to override these defaults, for instance if you have a
* customized build setup that diverges from Nuxt's defaults.
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use option `sourcemaps.assets` instead of `sourceMapsUploadOptions.sourcemaps.assets`
*/
assets?: string | Array<string>;

/**
* A glob or an array of globs that specifies which build artifacts should not be uploaded to Sentry.
*
* @default [] - By default no files are ignored. Thus, all files matching the `assets` glob
* or the default value for `assets` are uploaded.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.ignore` instead of `sourceMapsUploadOptions.sourcemaps.ignore`
*/
ignore?: string | Array<string>;

/**
* A glob or an array of globs that specifies the build artifacts that should be deleted after the artifact
* upload to Sentry has been completed.
*
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.filesToDeleteAfterUpload` instead of `sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload`
*/
filesToDeleteAfterUpload?: string | Array<string>;
};
};

/**
* Build options for the Sentry module. These options are used during build-time by the Sentry SDK.
*/
Expand DownExpand Up@@ -200,17 +50,6 @@ export type SentryNuxtModuleOptions = BuildTimeOptionsBase & {
useDiagnosticsChannelInjection?: boolean;
};

/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentry` module options in the `nuxt.config.(js|ts).
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*
* @deprecated This option was deprecated as it adds unnecessary nesting.
* Put the options one level higher to the root-level of the `sentry` module options.
*/
sourceMapsUploadOptions?: SourceMapsOptions;

/**
*
* Enables (partial) server tracing by automatically injecting Sentry for environments where modifying the node option `--import` is not possible.
Expand Down
126 changes: 53 additions & 73 deletions packages/nuxt/src/vite/sourceMaps.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,20 +22,9 @@ export function setupSourceMaps(
nuxt: Nuxt,
addVitePlugin: (plugin: Plugin[], options?: { dev?: boolean; build?: boolean }) => void,
): void {
// TODO(v11): remove deprecated options (also from SentryNuxtModuleOptions type)

const isDebug = moduleOptions.debug;

// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const sourceMapsEnabled =
moduleOptions.sourcemaps?.disable === true
? false
: moduleOptions.sourcemaps?.disable === false
? true
: // eslint-disable-next-line typescript/no-deprecated
(sourceMapsUploadOptions.enabled ?? true);
const sourceMapsEnabled = moduleOptions.sourcemaps?.disable !== true;

@chargomechargomeJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nicohrubecnicohrubecJul 31, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed hahaha


// In case we overwrite the source map settings, we default to deleting the files
const shouldDeleteFilesFallback = { client: true, server: true };
Expand All@@ -62,11 +51,7 @@ export function setupSourceMaps(
? 'server-side'
: 'client-side';

if (
!moduleOptions.sourcemaps?.filesToDeleteAfterUpload &&
// eslint-disable-next-line typescript/no-deprecated
!sourceMapsUploadOptions.sourcemaps?.filesToDeleteAfterUpload
) {
if (!moduleOptions.sourcemaps?.filesToDeleteAfterUpload) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] We enabled \`'hidden'\` source maps for your ${enabledDeleteFallbacks} build. Source map files will be automatically deleted after uploading them to Sentry.`,
Expand DownExpand Up@@ -131,65 +116,27 @@ function normalizePath(path: string): string {
*
* Only exported for Testing purposes.
*/
// todo(v11): This "eslint-disable" can be removed again once we remove deprecated options.
// eslint-disable-next-line complexity
export function getPluginOptions(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): SentryVitePluginOptions | SentryRollupPluginOptions {
// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

// Check for filesToDeleteAfterUpload in new location first, then deprecated location
const sourcemapsOptions = moduleOptions.sourcemaps || {};
// eslint-disable-next-line typescript/no-deprecated
const deprecatedSourcemapsOptions = sourceMapsUploadOptions.sourcemaps || {};

const filesToDeleteAfterUpload =
sourcemapsOptions.filesToDeleteAfterUpload ??
// eslint-disable-next-line typescript/no-deprecated
deprecatedSourcemapsOptions.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}
const filesToDeleteAfterUpload = resolveFilesToDeleteAfterUpload(moduleOptions, shouldDeleteFilesFallback);

return {
applicationKey: moduleOptions.applicationKey,
// eslint-disable-next-line typescript/no-deprecated
org: moduleOptions.org ?? sourceMapsUploadOptions.org ?? process.env.SENTRY_ORG,
// eslint-disable-next-line typescript/no-deprecated
project: moduleOptions.project ?? sourceMapsUploadOptions.project ?? process.env.SENTRY_PROJECT,
// eslint-disable-next-line typescript/no-deprecated
authToken: moduleOptions.authToken ?? sourceMapsUploadOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
// eslint-disable-next-line typescript/no-deprecated
telemetry: moduleOptions.telemetry ?? sourceMapsUploadOptions.telemetry ?? true,
// eslint-disable-next-line typescript/no-deprecated
url: moduleOptions.sentryUrl ?? sourceMapsUploadOptions.url ?? process.env.SENTRY_URL,
org: moduleOptions.org ?? process.env.SENTRY_ORG,
project: moduleOptions.project ?? process.env.SENTRY_PROJECT,
authToken: moduleOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
telemetry: moduleOptions.telemetry ?? true,
url: moduleOptions.sentryUrl ?? process.env.SENTRY_URL,
headers: moduleOptions.headers,
debug: moduleOptions.debug ?? false,
// eslint-disable-next-line typescript/no-deprecated
silent: moduleOptions.silent ?? sourceMapsUploadOptions.silent ?? false,
// eslint-disable-next-line typescript/no-deprecated
errorHandler: moduleOptions.errorHandler ?? sourceMapsUploadOptions.errorHandler,
silent: moduleOptions.silent ?? false,
errorHandler: moduleOptions.errorHandler,
bundleSizeOptimizations: moduleOptions.bundleSizeOptimizations, // todo: test if this can be overridden by the user
release: {
// eslint-disable-next-line typescript/no-deprecated
name: moduleOptions.release?.name ?? sourceMapsUploadOptions.release?.name,
name: moduleOptions.release?.name,
// Support all release options from BuildTimeOptionsBase
...moduleOptions.release,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.release,
Expand All@@ -206,21 +153,54 @@ export function getPluginOptions(
// The server/client files are in different places depending on the nitro preset (e.g. '.output/server' or '.netlify/functions-internal/server')
// We cannot determine automatically how the build folder looks like (depends on the preset), so we have to accept that source maps are uploaded multiple times (with the vitePlugin for Nuxt and the rollupPlugin for Nitro).
// If we could know where the server/client assets are located, we could do something like this (based on the Nitro preset): isNitro ? ['./.output/server/**/*'] : ['./.output/public/**/*'],
// eslint-disable-next-line typescript/no-deprecated
assets: sourcemapsOptions.assets ?? deprecatedSourcemapsOptions.assets ?? undefined,
// eslint-disable-next-line typescript/no-deprecated
ignore: sourcemapsOptions.ignore ?? deprecatedSourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload: filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesFallback?.server || shouldDeleteFilesFallback?.client
? fallbackFilesToDelete
: undefined,
assets: sourcemapsOptions.assets ?? undefined,
ignore: sourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload,
rewriteSources: sourcemapsOptions.rewriteSources ?? normalizePath,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.sourcemaps,
},
};
}

/**
* Determines which files to delete after upload. If the user set `filesToDeleteAfterUpload`, we use
* that. Otherwise we only delete the source maps Sentry generated itself — i.e. the sides
* (client/server) whose `sourcemap` setting resolved to `undefined`, where Sentry stepped in and
* enabled `'hidden'`. Given Nuxt's default of `{ server: true, client: false }`, this isn't the
* default case: it only kicks in when a side is left `undefined` (whole config or a single sub-key).
* @see https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap
*/
Comment on lines +165 to +172

@s1gr1ds1gr1dJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nuxt has no undefined default values for source maps so this "deleting by default" cannot happen in the default case. Only if users would set them to undefined.

Maybe that's worth pointing out here. Also a link to the docs: https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap

function resolveFilesToDeleteAfterUpload(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): string | Array<string> | undefined {
const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

const filesToDeleteAfterUpload = moduleOptions.sourcemaps?.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}

return filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesAfterUpload
? fallbackFilesToDelete
: undefined;
}

/* There are multiple ways to set up source maps (https://github.com/getsentry/sentry-javascript/issues/13993 and https://github.com/getsentry/sentry-javascript/pull/15859)
1. User explicitly disabled source maps
- keep this setting (emit a warning that errors won't be unminified in Sentry)
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option#22875

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.

Sign up for GitHub

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
nicohrubec merged 4 commits into from
Aug 3, 2026
Merged

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option #22875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
769aa9a
ref(nuxt)!: Remove deprecated `sourceMapsUploadOptions` module option
nicohrubec Jul 30, 2026
ab62810
test(nuxt): Cover root-level option resolution and `sourcemaps.disable`
nicohrubec Jul 31, 2026
e5e5210
ref(nuxt): Preserve original filesToDeleteAfterUpload truthiness sema…
nicohrubec Jul 31, 2026
7957430
docs(nuxt): Clarify source map deletion comment and add migration entry
nicohrubec Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -502,6 +502,38 @@ Remove these options from your `next.config.js` / `next.config.ts`.

The deprecated `sourceMapsUploadOptions` and other deprecated Vite/build plugin options were removed from `@sentry/astro`, `@sentry/nuxt`, `@sentry/sveltekit`, and `@sentry/react-router`. Use the top-level equivalents (e.g. `sourcemaps`, `release`, `authToken`, `org`, `project`, `telemetry`) instead.

### `@sentry/nuxt`

The deprecated `sourceMapsUploadOptions` module option was removed. Move its fields to the root level of the `sentry` module options. Note that `url` was renamed to `sentryUrl`, and `enabled` was replaced by `sourcemaps.disable` (inverted: `enabled: false` becomes `sourcemaps: { disable: true }`).

```ts
// nuxt.config.ts
export default defineNuxtConfig({
modules: ['@sentry/nuxt/module'],
sentry: {
// before
sourceMapsUploadOptions: {
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
url: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},

// after
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
sentryUrl: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},
});
```

## 4. Package Removals

### `@sentry/types` is no longer published
Expand Down
161 changes: 0 additions & 161 deletions packages/nuxt/src/common/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,156 +22,6 @@ export type SentryNuxtServerOptions = Parameters<typeof initNode>[0] & {
enableNitroErrorHandler?: boolean;
};

type SourceMapsOptions = {
/**
* Suppresses all logs.
*
* @default false
* @deprecated Use option `silent` instead of `sourceMapsUploadOptions.silent`
*/
silent?: boolean;

/**
* When an error occurs during release creation or sourcemaps upload, the plugin will call this function.
*
* By default, the plugin will simply throw an error, thereby stopping the bundling process.
* If an `errorHandler` callback is provided, compilation will continue, unless an error is
* thrown in the provided callback.
*
* To allow compilation to continue but still emit a warning, set this option to the following:
*
* ```js
* (err) => {
* console.warn(err);
* }
* ```
*
* @deprecated Use option `errorHandler` instead of `sourceMapsUploadOptions.errorHandler`
*/
errorHandler?: (err: Error) => void;

/**
* Options related to managing the Sentry releases for a build.
*
* More info: https://docs.sentry.io/product/releases/
*
* @deprecated Use option `release` instead of `sourceMapsUploadOptions.release`
*/
release?: {
/**
* Unique identifier for the release you want to create.
*
* This value can also be specified via the `SENTRY_RELEASE` environment variable.
*
* Defaults to automatically detecting a value for your environment.
* This includes values for Cordova, Heroku, AWS CodeBuild, CircleCI, Xcode, and Gradle, and otherwise uses the git `HEAD`'s commit SHA.
* (the latter requires access to git CLI and for the root directory to be a valid repository)
*
* If you didn't provide a value and the plugin can't automatically detect one, no release will be created.
*
* @deprecated Use `release.name` instead of `sourceMapsUploadOptions.release.name`
*/
name?: string;
};

/**
* If this flag is `true`, and an auth token is detected, the Sentry SDK will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use option `sourcemaps.disable` instead of `sourceMapsUploadOptions.enabled`
*/
enabled?: boolean;

/**
* The auth token to use when uploading source maps to Sentry.
*
* Instead of specifying this option, you can also set the `SENTRY_AUTH_TOKEN` environment variable.
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
* @deprecated Use option `authToken` instead of `sourceMapsUploadOptions.authToken`
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
* @deprecated Use option `org` instead of `sourceMapsUploadOptions.org`
*/
org?: string;

/**
* The URL of your Sentry instance if you're using self-hosted Sentry.
*
* @default https://sentry.io by default the plugin will point towards the Sentry SaaS URL
* @deprecated Use `sentryUrl` instead of `sourceMapsUploadOptions.url`
*/
url?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use option `project` instead of `sourceMapsUploadOptions.project`
*/
project?: string;

/**
* If this flag is `true`, the Sentry plugin will collect some telemetry data and send it to Sentry.
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use option `telemetry` instead of `sourceMapsUploadOptions.telemetry`
*/
telemetry?: boolean;

/**
* Options related to sourcemaps
*
* @deprecated Use option `sourcemaps` instead of `sourceMapsUploadOptions.sourcemaps`
*/
sourcemaps?: {
/**
* A glob or an array of globs that specify the build artifacts and source maps that will be uploaded to Sentry.
*
* If this option is not specified, sensible defaults based on your adapter and nuxt.config.js
* setup will be used. Use this option to override these defaults, for instance if you have a
* customized build setup that diverges from Nuxt's defaults.
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use option `sourcemaps.assets` instead of `sourceMapsUploadOptions.sourcemaps.assets`
*/
assets?: string | Array<string>;

/**
* A glob or an array of globs that specifies which build artifacts should not be uploaded to Sentry.
*
* @default [] - By default no files are ignored. Thus, all files matching the `assets` glob
* or the default value for `assets` are uploaded.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.ignore` instead of `sourceMapsUploadOptions.sourcemaps.ignore`
*/
ignore?: string | Array<string>;

/**
* A glob or an array of globs that specifies the build artifacts that should be deleted after the artifact
* upload to Sentry has been completed.
*
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.filesToDeleteAfterUpload` instead of `sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload`
*/
filesToDeleteAfterUpload?: string | Array<string>;
};
};

/**
* Build options for the Sentry module. These options are used during build-time by the Sentry SDK.
*/
Expand DownExpand Up@@ -200,17 +50,6 @@ export type SentryNuxtModuleOptions = BuildTimeOptionsBase & {
useDiagnosticsChannelInjection?: boolean;
};

/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentry` module options in the `nuxt.config.(js|ts).
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*
* @deprecated This option was deprecated as it adds unnecessary nesting.
* Put the options one level higher to the root-level of the `sentry` module options.
*/
sourceMapsUploadOptions?: SourceMapsOptions;

/**
*
* Enables (partial) server tracing by automatically injecting Sentry for environments where modifying the node option `--import` is not possible.
Expand Down
126 changes: 53 additions & 73 deletions packages/nuxt/src/vite/sourceMaps.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,20 +22,9 @@ export function setupSourceMaps(
nuxt: Nuxt,
addVitePlugin: (plugin: Plugin[], options?: { dev?: boolean; build?: boolean }) => void,
): void {
// TODO(v11): remove deprecated options (also from SentryNuxtModuleOptions type)

const isDebug = moduleOptions.debug;

// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const sourceMapsEnabled =
moduleOptions.sourcemaps?.disable === true
? false
: moduleOptions.sourcemaps?.disable === false
? true
: // eslint-disable-next-line typescript/no-deprecated
(sourceMapsUploadOptions.enabled ?? true);
const sourceMapsEnabled = moduleOptions.sourcemaps?.disable !== true;

@chargomechargomeJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nicohrubecnicohrubecJul 31, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed hahaha


// In case we overwrite the source map settings, we default to deleting the files
const shouldDeleteFilesFallback = { client: true, server: true };
Expand All@@ -62,11 +51,7 @@ export function setupSourceMaps(
? 'server-side'
: 'client-side';

if (
!moduleOptions.sourcemaps?.filesToDeleteAfterUpload &&
// eslint-disable-next-line typescript/no-deprecated
!sourceMapsUploadOptions.sourcemaps?.filesToDeleteAfterUpload
) {
if (!moduleOptions.sourcemaps?.filesToDeleteAfterUpload) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] We enabled \`'hidden'\` source maps for your ${enabledDeleteFallbacks} build. Source map files will be automatically deleted after uploading them to Sentry.`,
Expand DownExpand Up@@ -131,65 +116,27 @@ function normalizePath(path: string): string {
*
* Only exported for Testing purposes.
*/
// todo(v11): This "eslint-disable" can be removed again once we remove deprecated options.
// eslint-disable-next-line complexity
export function getPluginOptions(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): SentryVitePluginOptions | SentryRollupPluginOptions {
// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

// Check for filesToDeleteAfterUpload in new location first, then deprecated location
const sourcemapsOptions = moduleOptions.sourcemaps || {};
// eslint-disable-next-line typescript/no-deprecated
const deprecatedSourcemapsOptions = sourceMapsUploadOptions.sourcemaps || {};

const filesToDeleteAfterUpload =
sourcemapsOptions.filesToDeleteAfterUpload ??
// eslint-disable-next-line typescript/no-deprecated
deprecatedSourcemapsOptions.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}
const filesToDeleteAfterUpload = resolveFilesToDeleteAfterUpload(moduleOptions, shouldDeleteFilesFallback);

return {
applicationKey: moduleOptions.applicationKey,
// eslint-disable-next-line typescript/no-deprecated
org: moduleOptions.org ?? sourceMapsUploadOptions.org ?? process.env.SENTRY_ORG,
// eslint-disable-next-line typescript/no-deprecated
project: moduleOptions.project ?? sourceMapsUploadOptions.project ?? process.env.SENTRY_PROJECT,
// eslint-disable-next-line typescript/no-deprecated
authToken: moduleOptions.authToken ?? sourceMapsUploadOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
// eslint-disable-next-line typescript/no-deprecated
telemetry: moduleOptions.telemetry ?? sourceMapsUploadOptions.telemetry ?? true,
// eslint-disable-next-line typescript/no-deprecated
url: moduleOptions.sentryUrl ?? sourceMapsUploadOptions.url ?? process.env.SENTRY_URL,
org: moduleOptions.org ?? process.env.SENTRY_ORG,
project: moduleOptions.project ?? process.env.SENTRY_PROJECT,
authToken: moduleOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
telemetry: moduleOptions.telemetry ?? true,
url: moduleOptions.sentryUrl ?? process.env.SENTRY_URL,
headers: moduleOptions.headers,
debug: moduleOptions.debug ?? false,
// eslint-disable-next-line typescript/no-deprecated
silent: moduleOptions.silent ?? sourceMapsUploadOptions.silent ?? false,
// eslint-disable-next-line typescript/no-deprecated
errorHandler: moduleOptions.errorHandler ?? sourceMapsUploadOptions.errorHandler,
silent: moduleOptions.silent ?? false,
errorHandler: moduleOptions.errorHandler,
bundleSizeOptimizations: moduleOptions.bundleSizeOptimizations, // todo: test if this can be overridden by the user
release: {
// eslint-disable-next-line typescript/no-deprecated
name: moduleOptions.release?.name ?? sourceMapsUploadOptions.release?.name,
name: moduleOptions.release?.name,
// Support all release options from BuildTimeOptionsBase
...moduleOptions.release,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.release,
Expand All@@ -206,21 +153,54 @@ export function getPluginOptions(
// The server/client files are in different places depending on the nitro preset (e.g. '.output/server' or '.netlify/functions-internal/server')
// We cannot determine automatically how the build folder looks like (depends on the preset), so we have to accept that source maps are uploaded multiple times (with the vitePlugin for Nuxt and the rollupPlugin for Nitro).
// If we could know where the server/client assets are located, we could do something like this (based on the Nitro preset): isNitro ? ['./.output/server/**/*'] : ['./.output/public/**/*'],
// eslint-disable-next-line typescript/no-deprecated
assets: sourcemapsOptions.assets ?? deprecatedSourcemapsOptions.assets ?? undefined,
// eslint-disable-next-line typescript/no-deprecated
ignore: sourcemapsOptions.ignore ?? deprecatedSourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload: filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesFallback?.server || shouldDeleteFilesFallback?.client
? fallbackFilesToDelete
: undefined,
assets: sourcemapsOptions.assets ?? undefined,
ignore: sourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload,
rewriteSources: sourcemapsOptions.rewriteSources ?? normalizePath,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.sourcemaps,
},
};
}

/**
* Determines which files to delete after upload. If the user set `filesToDeleteAfterUpload`, we use
* that. Otherwise we only delete the source maps Sentry generated itself — i.e. the sides
* (client/server) whose `sourcemap` setting resolved to `undefined`, where Sentry stepped in and
* enabled `'hidden'`. Given Nuxt's default of `{ server: true, client: false }`, this isn't the
* default case: it only kicks in when a side is left `undefined` (whole config or a single sub-key).
* @see https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap
*/
Comment on lines +165 to +172

@s1gr1ds1gr1dJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nuxt has no undefined default values for source maps so this "deleting by default" cannot happen in the default case. Only if users would set them to undefined.

Maybe that's worth pointing out here. Also a link to the docs: https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap

function resolveFilesToDeleteAfterUpload(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): string | Array<string> | undefined {
const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

const filesToDeleteAfterUpload = moduleOptions.sourcemaps?.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}

return filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesAfterUpload
? fallbackFilesToDelete
: undefined;
}

/* There are multiple ways to set up source maps (https://github.com/getsentry/sentry-javascript/issues/13993 and https://github.com/getsentry/sentry-javascript/pull/15859)
1. User explicitly disabled source maps
- keep this setting (emit a warning that errors won't be unminified in Sentry)
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option#22875

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.

Sign up for GitHub

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
nicohrubec merged 4 commits into from
Aug 3, 2026
Merged

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option #22875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
769aa9a
ref(nuxt)!: Remove deprecated `sourceMapsUploadOptions` module option
nicohrubec Jul 30, 2026
ab62810
test(nuxt): Cover root-level option resolution and `sourcemaps.disable`
nicohrubec Jul 31, 2026
e5e5210
ref(nuxt): Preserve original filesToDeleteAfterUpload truthiness sema…
nicohrubec Jul 31, 2026
7957430
docs(nuxt): Clarify source map deletion comment and add migration entry
nicohrubec Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -502,6 +502,38 @@ Remove these options from your `next.config.js` / `next.config.ts`.

The deprecated `sourceMapsUploadOptions` and other deprecated Vite/build plugin options were removed from `@sentry/astro`, `@sentry/nuxt`, `@sentry/sveltekit`, and `@sentry/react-router`. Use the top-level equivalents (e.g. `sourcemaps`, `release`, `authToken`, `org`, `project`, `telemetry`) instead.

### `@sentry/nuxt`

The deprecated `sourceMapsUploadOptions` module option was removed. Move its fields to the root level of the `sentry` module options. Note that `url` was renamed to `sentryUrl`, and `enabled` was replaced by `sourcemaps.disable` (inverted: `enabled: false` becomes `sourcemaps: { disable: true }`).

```ts
// nuxt.config.ts
export default defineNuxtConfig({
modules: ['@sentry/nuxt/module'],
sentry: {
// before
sourceMapsUploadOptions: {
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
url: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},

// after
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
sentryUrl: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},
});
```

## 4. Package Removals

### `@sentry/types` is no longer published
Expand Down
161 changes: 0 additions & 161 deletions packages/nuxt/src/common/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,156 +22,6 @@ export type SentryNuxtServerOptions = Parameters<typeof initNode>[0] & {
enableNitroErrorHandler?: boolean;
};

type SourceMapsOptions = {
/**
* Suppresses all logs.
*
* @default false
* @deprecated Use option `silent` instead of `sourceMapsUploadOptions.silent`
*/
silent?: boolean;

/**
* When an error occurs during release creation or sourcemaps upload, the plugin will call this function.
*
* By default, the plugin will simply throw an error, thereby stopping the bundling process.
* If an `errorHandler` callback is provided, compilation will continue, unless an error is
* thrown in the provided callback.
*
* To allow compilation to continue but still emit a warning, set this option to the following:
*
* ```js
* (err) => {
* console.warn(err);
* }
* ```
*
* @deprecated Use option `errorHandler` instead of `sourceMapsUploadOptions.errorHandler`
*/
errorHandler?: (err: Error) => void;

/**
* Options related to managing the Sentry releases for a build.
*
* More info: https://docs.sentry.io/product/releases/
*
* @deprecated Use option `release` instead of `sourceMapsUploadOptions.release`
*/
release?: {
/**
* Unique identifier for the release you want to create.
*
* This value can also be specified via the `SENTRY_RELEASE` environment variable.
*
* Defaults to automatically detecting a value for your environment.
* This includes values for Cordova, Heroku, AWS CodeBuild, CircleCI, Xcode, and Gradle, and otherwise uses the git `HEAD`'s commit SHA.
* (the latter requires access to git CLI and for the root directory to be a valid repository)
*
* If you didn't provide a value and the plugin can't automatically detect one, no release will be created.
*
* @deprecated Use `release.name` instead of `sourceMapsUploadOptions.release.name`
*/
name?: string;
};

/**
* If this flag is `true`, and an auth token is detected, the Sentry SDK will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use option `sourcemaps.disable` instead of `sourceMapsUploadOptions.enabled`
*/
enabled?: boolean;

/**
* The auth token to use when uploading source maps to Sentry.
*
* Instead of specifying this option, you can also set the `SENTRY_AUTH_TOKEN` environment variable.
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
* @deprecated Use option `authToken` instead of `sourceMapsUploadOptions.authToken`
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
* @deprecated Use option `org` instead of `sourceMapsUploadOptions.org`
*/
org?: string;

/**
* The URL of your Sentry instance if you're using self-hosted Sentry.
*
* @default https://sentry.io by default the plugin will point towards the Sentry SaaS URL
* @deprecated Use `sentryUrl` instead of `sourceMapsUploadOptions.url`
*/
url?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use option `project` instead of `sourceMapsUploadOptions.project`
*/
project?: string;

/**
* If this flag is `true`, the Sentry plugin will collect some telemetry data and send it to Sentry.
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use option `telemetry` instead of `sourceMapsUploadOptions.telemetry`
*/
telemetry?: boolean;

/**
* Options related to sourcemaps
*
* @deprecated Use option `sourcemaps` instead of `sourceMapsUploadOptions.sourcemaps`
*/
sourcemaps?: {
/**
* A glob or an array of globs that specify the build artifacts and source maps that will be uploaded to Sentry.
*
* If this option is not specified, sensible defaults based on your adapter and nuxt.config.js
* setup will be used. Use this option to override these defaults, for instance if you have a
* customized build setup that diverges from Nuxt's defaults.
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use option `sourcemaps.assets` instead of `sourceMapsUploadOptions.sourcemaps.assets`
*/
assets?: string | Array<string>;

/**
* A glob or an array of globs that specifies which build artifacts should not be uploaded to Sentry.
*
* @default [] - By default no files are ignored. Thus, all files matching the `assets` glob
* or the default value for `assets` are uploaded.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.ignore` instead of `sourceMapsUploadOptions.sourcemaps.ignore`
*/
ignore?: string | Array<string>;

/**
* A glob or an array of globs that specifies the build artifacts that should be deleted after the artifact
* upload to Sentry has been completed.
*
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.filesToDeleteAfterUpload` instead of `sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload`
*/
filesToDeleteAfterUpload?: string | Array<string>;
};
};

/**
* Build options for the Sentry module. These options are used during build-time by the Sentry SDK.
*/
Expand DownExpand Up@@ -200,17 +50,6 @@ export type SentryNuxtModuleOptions = BuildTimeOptionsBase & {
useDiagnosticsChannelInjection?: boolean;
};

/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentry` module options in the `nuxt.config.(js|ts).
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*
* @deprecated This option was deprecated as it adds unnecessary nesting.
* Put the options one level higher to the root-level of the `sentry` module options.
*/
sourceMapsUploadOptions?: SourceMapsOptions;

/**
*
* Enables (partial) server tracing by automatically injecting Sentry for environments where modifying the node option `--import` is not possible.
Expand Down
126 changes: 53 additions & 73 deletions packages/nuxt/src/vite/sourceMaps.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,20 +22,9 @@ export function setupSourceMaps(
nuxt: Nuxt,
addVitePlugin: (plugin: Plugin[], options?: { dev?: boolean; build?: boolean }) => void,
): void {
// TODO(v11): remove deprecated options (also from SentryNuxtModuleOptions type)

const isDebug = moduleOptions.debug;

// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const sourceMapsEnabled =
moduleOptions.sourcemaps?.disable === true
? false
: moduleOptions.sourcemaps?.disable === false
? true
: // eslint-disable-next-line typescript/no-deprecated
(sourceMapsUploadOptions.enabled ?? true);
const sourceMapsEnabled = moduleOptions.sourcemaps?.disable !== true;

@chargomechargomeJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nicohrubecnicohrubecJul 31, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed hahaha


// In case we overwrite the source map settings, we default to deleting the files
const shouldDeleteFilesFallback = { client: true, server: true };
Expand All@@ -62,11 +51,7 @@ export function setupSourceMaps(
? 'server-side'
: 'client-side';

if (
!moduleOptions.sourcemaps?.filesToDeleteAfterUpload &&
// eslint-disable-next-line typescript/no-deprecated
!sourceMapsUploadOptions.sourcemaps?.filesToDeleteAfterUpload
) {
if (!moduleOptions.sourcemaps?.filesToDeleteAfterUpload) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] We enabled \`'hidden'\` source maps for your ${enabledDeleteFallbacks} build. Source map files will be automatically deleted after uploading them to Sentry.`,
Expand DownExpand Up@@ -131,65 +116,27 @@ function normalizePath(path: string): string {
*
* Only exported for Testing purposes.
*/
// todo(v11): This "eslint-disable" can be removed again once we remove deprecated options.
// eslint-disable-next-line complexity
export function getPluginOptions(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): SentryVitePluginOptions | SentryRollupPluginOptions {
// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

// Check for filesToDeleteAfterUpload in new location first, then deprecated location
const sourcemapsOptions = moduleOptions.sourcemaps || {};
// eslint-disable-next-line typescript/no-deprecated
const deprecatedSourcemapsOptions = sourceMapsUploadOptions.sourcemaps || {};

const filesToDeleteAfterUpload =
sourcemapsOptions.filesToDeleteAfterUpload ??
// eslint-disable-next-line typescript/no-deprecated
deprecatedSourcemapsOptions.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}
const filesToDeleteAfterUpload = resolveFilesToDeleteAfterUpload(moduleOptions, shouldDeleteFilesFallback);

return {
applicationKey: moduleOptions.applicationKey,
// eslint-disable-next-line typescript/no-deprecated
org: moduleOptions.org ?? sourceMapsUploadOptions.org ?? process.env.SENTRY_ORG,
// eslint-disable-next-line typescript/no-deprecated
project: moduleOptions.project ?? sourceMapsUploadOptions.project ?? process.env.SENTRY_PROJECT,
// eslint-disable-next-line typescript/no-deprecated
authToken: moduleOptions.authToken ?? sourceMapsUploadOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
// eslint-disable-next-line typescript/no-deprecated
telemetry: moduleOptions.telemetry ?? sourceMapsUploadOptions.telemetry ?? true,
// eslint-disable-next-line typescript/no-deprecated
url: moduleOptions.sentryUrl ?? sourceMapsUploadOptions.url ?? process.env.SENTRY_URL,
org: moduleOptions.org ?? process.env.SENTRY_ORG,
project: moduleOptions.project ?? process.env.SENTRY_PROJECT,
authToken: moduleOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
telemetry: moduleOptions.telemetry ?? true,
url: moduleOptions.sentryUrl ?? process.env.SENTRY_URL,
headers: moduleOptions.headers,
debug: moduleOptions.debug ?? false,
// eslint-disable-next-line typescript/no-deprecated
silent: moduleOptions.silent ?? sourceMapsUploadOptions.silent ?? false,
// eslint-disable-next-line typescript/no-deprecated
errorHandler: moduleOptions.errorHandler ?? sourceMapsUploadOptions.errorHandler,
silent: moduleOptions.silent ?? false,
errorHandler: moduleOptions.errorHandler,
bundleSizeOptimizations: moduleOptions.bundleSizeOptimizations, // todo: test if this can be overridden by the user
release: {
// eslint-disable-next-line typescript/no-deprecated
name: moduleOptions.release?.name ?? sourceMapsUploadOptions.release?.name,
name: moduleOptions.release?.name,
// Support all release options from BuildTimeOptionsBase
...moduleOptions.release,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.release,
Expand All@@ -206,21 +153,54 @@ export function getPluginOptions(
// The server/client files are in different places depending on the nitro preset (e.g. '.output/server' or '.netlify/functions-internal/server')
// We cannot determine automatically how the build folder looks like (depends on the preset), so we have to accept that source maps are uploaded multiple times (with the vitePlugin for Nuxt and the rollupPlugin for Nitro).
// If we could know where the server/client assets are located, we could do something like this (based on the Nitro preset): isNitro ? ['./.output/server/**/*'] : ['./.output/public/**/*'],
// eslint-disable-next-line typescript/no-deprecated
assets: sourcemapsOptions.assets ?? deprecatedSourcemapsOptions.assets ?? undefined,
// eslint-disable-next-line typescript/no-deprecated
ignore: sourcemapsOptions.ignore ?? deprecatedSourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload: filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesFallback?.server || shouldDeleteFilesFallback?.client
? fallbackFilesToDelete
: undefined,
assets: sourcemapsOptions.assets ?? undefined,
ignore: sourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload,
rewriteSources: sourcemapsOptions.rewriteSources ?? normalizePath,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.sourcemaps,
},
};
}

/**
* Determines which files to delete after upload. If the user set `filesToDeleteAfterUpload`, we use
* that. Otherwise we only delete the source maps Sentry generated itself — i.e. the sides
* (client/server) whose `sourcemap` setting resolved to `undefined`, where Sentry stepped in and
* enabled `'hidden'`. Given Nuxt's default of `{ server: true, client: false }`, this isn't the
* default case: it only kicks in when a side is left `undefined` (whole config or a single sub-key).
* @see https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap
*/
Comment on lines +165 to +172

@s1gr1ds1gr1dJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nuxt has no undefined default values for source maps so this "deleting by default" cannot happen in the default case. Only if users would set them to undefined.

Maybe that's worth pointing out here. Also a link to the docs: https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap

function resolveFilesToDeleteAfterUpload(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): string | Array<string> | undefined {
const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

const filesToDeleteAfterUpload = moduleOptions.sourcemaps?.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}

return filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesAfterUpload
? fallbackFilesToDelete
: undefined;
}

/* There are multiple ways to set up source maps (https://github.com/getsentry/sentry-javascript/issues/13993 and https://github.com/getsentry/sentry-javascript/pull/15859)
1. User explicitly disabled source maps
- keep this setting (emit a warning that errors won't be unminified in Sentry)
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option#22875

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.

Sign up for GitHub

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
nicohrubec merged 4 commits into from
Aug 3, 2026
Merged

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option #22875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
769aa9a
ref(nuxt)!: Remove deprecated `sourceMapsUploadOptions` module option
nicohrubec Jul 30, 2026
ab62810
test(nuxt): Cover root-level option resolution and `sourcemaps.disable`
nicohrubec Jul 31, 2026
e5e5210
ref(nuxt): Preserve original filesToDeleteAfterUpload truthiness sema…
nicohrubec Jul 31, 2026
7957430
docs(nuxt): Clarify source map deletion comment and add migration entry
nicohrubec Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -502,6 +502,38 @@ Remove these options from your `next.config.js` / `next.config.ts`.

The deprecated `sourceMapsUploadOptions` and other deprecated Vite/build plugin options were removed from `@sentry/astro`, `@sentry/nuxt`, `@sentry/sveltekit`, and `@sentry/react-router`. Use the top-level equivalents (e.g. `sourcemaps`, `release`, `authToken`, `org`, `project`, `telemetry`) instead.

### `@sentry/nuxt`

The deprecated `sourceMapsUploadOptions` module option was removed. Move its fields to the root level of the `sentry` module options. Note that `url` was renamed to `sentryUrl`, and `enabled` was replaced by `sourcemaps.disable` (inverted: `enabled: false` becomes `sourcemaps: { disable: true }`).

```ts
// nuxt.config.ts
export default defineNuxtConfig({
modules: ['@sentry/nuxt/module'],
sentry: {
// before
sourceMapsUploadOptions: {
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
url: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},

// after
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
sentryUrl: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},
});
```

## 4. Package Removals

### `@sentry/types` is no longer published
Expand Down
161 changes: 0 additions & 161 deletions packages/nuxt/src/common/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,156 +22,6 @@ export type SentryNuxtServerOptions = Parameters<typeof initNode>[0] & {
enableNitroErrorHandler?: boolean;
};

type SourceMapsOptions = {
/**
* Suppresses all logs.
*
* @default false
* @deprecated Use option `silent` instead of `sourceMapsUploadOptions.silent`
*/
silent?: boolean;

/**
* When an error occurs during release creation or sourcemaps upload, the plugin will call this function.
*
* By default, the plugin will simply throw an error, thereby stopping the bundling process.
* If an `errorHandler` callback is provided, compilation will continue, unless an error is
* thrown in the provided callback.
*
* To allow compilation to continue but still emit a warning, set this option to the following:
*
* ```js
* (err) => {
* console.warn(err);
* }
* ```
*
* @deprecated Use option `errorHandler` instead of `sourceMapsUploadOptions.errorHandler`
*/
errorHandler?: (err: Error) => void;

/**
* Options related to managing the Sentry releases for a build.
*
* More info: https://docs.sentry.io/product/releases/
*
* @deprecated Use option `release` instead of `sourceMapsUploadOptions.release`
*/
release?: {
/**
* Unique identifier for the release you want to create.
*
* This value can also be specified via the `SENTRY_RELEASE` environment variable.
*
* Defaults to automatically detecting a value for your environment.
* This includes values for Cordova, Heroku, AWS CodeBuild, CircleCI, Xcode, and Gradle, and otherwise uses the git `HEAD`'s commit SHA.
* (the latter requires access to git CLI and for the root directory to be a valid repository)
*
* If you didn't provide a value and the plugin can't automatically detect one, no release will be created.
*
* @deprecated Use `release.name` instead of `sourceMapsUploadOptions.release.name`
*/
name?: string;
};

/**
* If this flag is `true`, and an auth token is detected, the Sentry SDK will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use option `sourcemaps.disable` instead of `sourceMapsUploadOptions.enabled`
*/
enabled?: boolean;

/**
* The auth token to use when uploading source maps to Sentry.
*
* Instead of specifying this option, you can also set the `SENTRY_AUTH_TOKEN` environment variable.
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
* @deprecated Use option `authToken` instead of `sourceMapsUploadOptions.authToken`
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
* @deprecated Use option `org` instead of `sourceMapsUploadOptions.org`
*/
org?: string;

/**
* The URL of your Sentry instance if you're using self-hosted Sentry.
*
* @default https://sentry.io by default the plugin will point towards the Sentry SaaS URL
* @deprecated Use `sentryUrl` instead of `sourceMapsUploadOptions.url`
*/
url?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use option `project` instead of `sourceMapsUploadOptions.project`
*/
project?: string;

/**
* If this flag is `true`, the Sentry plugin will collect some telemetry data and send it to Sentry.
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use option `telemetry` instead of `sourceMapsUploadOptions.telemetry`
*/
telemetry?: boolean;

/**
* Options related to sourcemaps
*
* @deprecated Use option `sourcemaps` instead of `sourceMapsUploadOptions.sourcemaps`
*/
sourcemaps?: {
/**
* A glob or an array of globs that specify the build artifacts and source maps that will be uploaded to Sentry.
*
* If this option is not specified, sensible defaults based on your adapter and nuxt.config.js
* setup will be used. Use this option to override these defaults, for instance if you have a
* customized build setup that diverges from Nuxt's defaults.
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use option `sourcemaps.assets` instead of `sourceMapsUploadOptions.sourcemaps.assets`
*/
assets?: string | Array<string>;

/**
* A glob or an array of globs that specifies which build artifacts should not be uploaded to Sentry.
*
* @default [] - By default no files are ignored. Thus, all files matching the `assets` glob
* or the default value for `assets` are uploaded.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.ignore` instead of `sourceMapsUploadOptions.sourcemaps.ignore`
*/
ignore?: string | Array<string>;

/**
* A glob or an array of globs that specifies the build artifacts that should be deleted after the artifact
* upload to Sentry has been completed.
*
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.filesToDeleteAfterUpload` instead of `sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload`
*/
filesToDeleteAfterUpload?: string | Array<string>;
};
};

/**
* Build options for the Sentry module. These options are used during build-time by the Sentry SDK.
*/
Expand DownExpand Up@@ -200,17 +50,6 @@ export type SentryNuxtModuleOptions = BuildTimeOptionsBase & {
useDiagnosticsChannelInjection?: boolean;
};

/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentry` module options in the `nuxt.config.(js|ts).
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*
* @deprecated This option was deprecated as it adds unnecessary nesting.
* Put the options one level higher to the root-level of the `sentry` module options.
*/
sourceMapsUploadOptions?: SourceMapsOptions;

/**
*
* Enables (partial) server tracing by automatically injecting Sentry for environments where modifying the node option `--import` is not possible.
Expand Down
126 changes: 53 additions & 73 deletions packages/nuxt/src/vite/sourceMaps.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,20 +22,9 @@ export function setupSourceMaps(
nuxt: Nuxt,
addVitePlugin: (plugin: Plugin[], options?: { dev?: boolean; build?: boolean }) => void,
): void {
// TODO(v11): remove deprecated options (also from SentryNuxtModuleOptions type)

const isDebug = moduleOptions.debug;

// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const sourceMapsEnabled =
moduleOptions.sourcemaps?.disable === true
? false
: moduleOptions.sourcemaps?.disable === false
? true
: // eslint-disable-next-line typescript/no-deprecated
(sourceMapsUploadOptions.enabled ?? true);
const sourceMapsEnabled = moduleOptions.sourcemaps?.disable !== true;

@chargomechargomeJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nicohrubecnicohrubecJul 31, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed hahaha


// In case we overwrite the source map settings, we default to deleting the files
const shouldDeleteFilesFallback = { client: true, server: true };
Expand All@@ -62,11 +51,7 @@ export function setupSourceMaps(
? 'server-side'
: 'client-side';

if (
!moduleOptions.sourcemaps?.filesToDeleteAfterUpload &&
// eslint-disable-next-line typescript/no-deprecated
!sourceMapsUploadOptions.sourcemaps?.filesToDeleteAfterUpload
) {
if (!moduleOptions.sourcemaps?.filesToDeleteAfterUpload) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] We enabled \`'hidden'\` source maps for your ${enabledDeleteFallbacks} build. Source map files will be automatically deleted after uploading them to Sentry.`,
Expand DownExpand Up@@ -131,65 +116,27 @@ function normalizePath(path: string): string {
*
* Only exported for Testing purposes.
*/
// todo(v11): This "eslint-disable" can be removed again once we remove deprecated options.
// eslint-disable-next-line complexity
export function getPluginOptions(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): SentryVitePluginOptions | SentryRollupPluginOptions {
// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

// Check for filesToDeleteAfterUpload in new location first, then deprecated location
const sourcemapsOptions = moduleOptions.sourcemaps || {};
// eslint-disable-next-line typescript/no-deprecated
const deprecatedSourcemapsOptions = sourceMapsUploadOptions.sourcemaps || {};

const filesToDeleteAfterUpload =
sourcemapsOptions.filesToDeleteAfterUpload ??
// eslint-disable-next-line typescript/no-deprecated
deprecatedSourcemapsOptions.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}
const filesToDeleteAfterUpload = resolveFilesToDeleteAfterUpload(moduleOptions, shouldDeleteFilesFallback);

return {
applicationKey: moduleOptions.applicationKey,
// eslint-disable-next-line typescript/no-deprecated
org: moduleOptions.org ?? sourceMapsUploadOptions.org ?? process.env.SENTRY_ORG,
// eslint-disable-next-line typescript/no-deprecated
project: moduleOptions.project ?? sourceMapsUploadOptions.project ?? process.env.SENTRY_PROJECT,
// eslint-disable-next-line typescript/no-deprecated
authToken: moduleOptions.authToken ?? sourceMapsUploadOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
// eslint-disable-next-line typescript/no-deprecated
telemetry: moduleOptions.telemetry ?? sourceMapsUploadOptions.telemetry ?? true,
// eslint-disable-next-line typescript/no-deprecated
url: moduleOptions.sentryUrl ?? sourceMapsUploadOptions.url ?? process.env.SENTRY_URL,
org: moduleOptions.org ?? process.env.SENTRY_ORG,
project: moduleOptions.project ?? process.env.SENTRY_PROJECT,
authToken: moduleOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
telemetry: moduleOptions.telemetry ?? true,
url: moduleOptions.sentryUrl ?? process.env.SENTRY_URL,
headers: moduleOptions.headers,
debug: moduleOptions.debug ?? false,
// eslint-disable-next-line typescript/no-deprecated
silent: moduleOptions.silent ?? sourceMapsUploadOptions.silent ?? false,
// eslint-disable-next-line typescript/no-deprecated
errorHandler: moduleOptions.errorHandler ?? sourceMapsUploadOptions.errorHandler,
silent: moduleOptions.silent ?? false,
errorHandler: moduleOptions.errorHandler,
bundleSizeOptimizations: moduleOptions.bundleSizeOptimizations, // todo: test if this can be overridden by the user
release: {
// eslint-disable-next-line typescript/no-deprecated
name: moduleOptions.release?.name ?? sourceMapsUploadOptions.release?.name,
name: moduleOptions.release?.name,
// Support all release options from BuildTimeOptionsBase
...moduleOptions.release,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.release,
Expand All@@ -206,21 +153,54 @@ export function getPluginOptions(
// The server/client files are in different places depending on the nitro preset (e.g. '.output/server' or '.netlify/functions-internal/server')
// We cannot determine automatically how the build folder looks like (depends on the preset), so we have to accept that source maps are uploaded multiple times (with the vitePlugin for Nuxt and the rollupPlugin for Nitro).
// If we could know where the server/client assets are located, we could do something like this (based on the Nitro preset): isNitro ? ['./.output/server/**/*'] : ['./.output/public/**/*'],
// eslint-disable-next-line typescript/no-deprecated
assets: sourcemapsOptions.assets ?? deprecatedSourcemapsOptions.assets ?? undefined,
// eslint-disable-next-line typescript/no-deprecated
ignore: sourcemapsOptions.ignore ?? deprecatedSourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload: filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesFallback?.server || shouldDeleteFilesFallback?.client
? fallbackFilesToDelete
: undefined,
assets: sourcemapsOptions.assets ?? undefined,
ignore: sourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload,
rewriteSources: sourcemapsOptions.rewriteSources ?? normalizePath,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.sourcemaps,
},
};
}

/**
* Determines which files to delete after upload. If the user set `filesToDeleteAfterUpload`, we use
* that. Otherwise we only delete the source maps Sentry generated itself — i.e. the sides
* (client/server) whose `sourcemap` setting resolved to `undefined`, where Sentry stepped in and
* enabled `'hidden'`. Given Nuxt's default of `{ server: true, client: false }`, this isn't the
* default case: it only kicks in when a side is left `undefined` (whole config or a single sub-key).
* @see https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap
*/
Comment on lines +165 to +172

@s1gr1ds1gr1dJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nuxt has no undefined default values for source maps so this "deleting by default" cannot happen in the default case. Only if users would set them to undefined.

Maybe that's worth pointing out here. Also a link to the docs: https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap

function resolveFilesToDeleteAfterUpload(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): string | Array<string> | undefined {
const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

const filesToDeleteAfterUpload = moduleOptions.sourcemaps?.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}

return filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesAfterUpload
? fallbackFilesToDelete
: undefined;
}

/* There are multiple ways to set up source maps (https://github.com/getsentry/sentry-javascript/issues/13993 and https://github.com/getsentry/sentry-javascript/pull/15859)
1. User explicitly disabled source maps
- keep this setting (emit a warning that errors won't be unminified in Sentry)
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option#22875

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.

Sign up for GitHub

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
nicohrubec merged 4 commits into from
Aug 3, 2026
Merged

feat(nuxt)!: Remove deprecated sourceMapsUploadOptions module option #22875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
769aa9a
ref(nuxt)!: Remove deprecated `sourceMapsUploadOptions` module option
nicohrubec Jul 30, 2026
ab62810
test(nuxt): Cover root-level option resolution and `sourcemaps.disable`
nicohrubec Jul 31, 2026
e5e5210
ref(nuxt): Preserve original filesToDeleteAfterUpload truthiness sema…
nicohrubec Jul 31, 2026
7957430
docs(nuxt): Clarify source map deletion comment and add migration entry
nicohrubec Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -502,6 +502,38 @@ Remove these options from your `next.config.js` / `next.config.ts`.

The deprecated `sourceMapsUploadOptions` and other deprecated Vite/build plugin options were removed from `@sentry/astro`, `@sentry/nuxt`, `@sentry/sveltekit`, and `@sentry/react-router`. Use the top-level equivalents (e.g. `sourcemaps`, `release`, `authToken`, `org`, `project`, `telemetry`) instead.

### `@sentry/nuxt`

The deprecated `sourceMapsUploadOptions` module option was removed. Move its fields to the root level of the `sentry` module options. Note that `url` was renamed to `sentryUrl`, and `enabled` was replaced by `sourcemaps.disable` (inverted: `enabled: false` becomes `sourcemaps: { disable: true }`).

```ts
// nuxt.config.ts
export default defineNuxtConfig({
modules: ['@sentry/nuxt/module'],
sentry: {
// before
sourceMapsUploadOptions: {
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
url: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},

// after
org: 'my-org',
project: 'my-project',
authToken: process.env.SENTRY_AUTH_TOKEN,
sentryUrl: 'https://my-sentry.example.com',
sourcemaps: {
assets: ['./dist/**/*'],
},
},
});
```

## 4. Package Removals

### `@sentry/types` is no longer published
Expand Down
161 changes: 0 additions & 161 deletions packages/nuxt/src/common/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,156 +22,6 @@ export type SentryNuxtServerOptions = Parameters<typeof initNode>[0] & {
enableNitroErrorHandler?: boolean;
};

type SourceMapsOptions = {
/**
* Suppresses all logs.
*
* @default false
* @deprecated Use option `silent` instead of `sourceMapsUploadOptions.silent`
*/
silent?: boolean;

/**
* When an error occurs during release creation or sourcemaps upload, the plugin will call this function.
*
* By default, the plugin will simply throw an error, thereby stopping the bundling process.
* If an `errorHandler` callback is provided, compilation will continue, unless an error is
* thrown in the provided callback.
*
* To allow compilation to continue but still emit a warning, set this option to the following:
*
* ```js
* (err) => {
* console.warn(err);
* }
* ```
*
* @deprecated Use option `errorHandler` instead of `sourceMapsUploadOptions.errorHandler`
*/
errorHandler?: (err: Error) => void;

/**
* Options related to managing the Sentry releases for a build.
*
* More info: https://docs.sentry.io/product/releases/
*
* @deprecated Use option `release` instead of `sourceMapsUploadOptions.release`
*/
release?: {
/**
* Unique identifier for the release you want to create.
*
* This value can also be specified via the `SENTRY_RELEASE` environment variable.
*
* Defaults to automatically detecting a value for your environment.
* This includes values for Cordova, Heroku, AWS CodeBuild, CircleCI, Xcode, and Gradle, and otherwise uses the git `HEAD`'s commit SHA.
* (the latter requires access to git CLI and for the root directory to be a valid repository)
*
* If you didn't provide a value and the plugin can't automatically detect one, no release will be created.
*
* @deprecated Use `release.name` instead of `sourceMapsUploadOptions.release.name`
*/
name?: string;
};

/**
* If this flag is `true`, and an auth token is detected, the Sentry SDK will
* automatically generate and upload source maps to Sentry during a production build.
*
* @default true
* @deprecated Use option `sourcemaps.disable` instead of `sourceMapsUploadOptions.enabled`
*/
enabled?: boolean;

/**
* The auth token to use when uploading source maps to Sentry.
*
* Instead of specifying this option, you can also set the `SENTRY_AUTH_TOKEN` environment variable.
*
* To create an auth token, follow this guide:
* @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens
* @deprecated Use option `authToken` instead of `sourceMapsUploadOptions.authToken`
*/
authToken?: string;

/**
* The organization slug of your Sentry organization.
* Instead of specifying this option, you can also set the `SENTRY_ORG` environment variable.
* @deprecated Use option `org` instead of `sourceMapsUploadOptions.org`
*/
org?: string;

/**
* The URL of your Sentry instance if you're using self-hosted Sentry.
*
* @default https://sentry.io by default the plugin will point towards the Sentry SaaS URL
* @deprecated Use `sentryUrl` instead of `sourceMapsUploadOptions.url`
*/
url?: string;

/**
* The project slug of your Sentry project.
* Instead of specifying this option, you can also set the `SENTRY_PROJECT` environment variable.
*
* @deprecated Use option `project` instead of `sourceMapsUploadOptions.project`
*/
project?: string;

/**
* If this flag is `true`, the Sentry plugin will collect some telemetry data and send it to Sentry.
* It will not collect any sensitive or user-specific data.
*
* @default true
* @deprecated Use option `telemetry` instead of `sourceMapsUploadOptions.telemetry`
*/
telemetry?: boolean;

/**
* Options related to sourcemaps
*
* @deprecated Use option `sourcemaps` instead of `sourceMapsUploadOptions.sourcemaps`
*/
sourcemaps?: {
/**
* A glob or an array of globs that specify the build artifacts and source maps that will be uploaded to Sentry.
*
* If this option is not specified, sensible defaults based on your adapter and nuxt.config.js
* setup will be used. Use this option to override these defaults, for instance if you have a
* customized build setup that diverges from Nuxt's defaults.
*
* The globbing patterns must follow the implementation of the `glob` package.
* @see https://www.npmjs.com/package/glob#glob-primer
*
* @deprecated Use option `sourcemaps.assets` instead of `sourceMapsUploadOptions.sourcemaps.assets`
*/
assets?: string | Array<string>;

/**
* A glob or an array of globs that specifies which build artifacts should not be uploaded to Sentry.
*
* @default [] - By default no files are ignored. Thus, all files matching the `assets` glob
* or the default value for `assets` are uploaded.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.ignore` instead of `sourceMapsUploadOptions.sourcemaps.ignore`
*/
ignore?: string | Array<string>;

/**
* A glob or an array of globs that specifies the build artifacts that should be deleted after the artifact
* upload to Sentry has been completed.
*
* @default [] - By default no files are deleted.
*
* The globbing patterns follow the implementation of the glob package. (https://www.npmjs.com/package/glob)
*
* @deprecated Use option `sourcemaps.filesToDeleteAfterUpload` instead of `sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload`
*/
filesToDeleteAfterUpload?: string | Array<string>;
};
};

/**
* Build options for the Sentry module. These options are used during build-time by the Sentry SDK.
*/
Expand DownExpand Up@@ -200,17 +50,6 @@ export type SentryNuxtModuleOptions = BuildTimeOptionsBase & {
useDiagnosticsChannelInjection?: boolean;
};

/**
* Options for the Sentry Vite plugin to customize the source maps upload process.
*
* These options are always read from the `sentry` module options in the `nuxt.config.(js|ts).
* Do not define them in the `sentry.client.config.(js|ts)` or `sentry.server.config.(js|ts)` files.
*
* @deprecated This option was deprecated as it adds unnecessary nesting.
* Put the options one level higher to the root-level of the `sentry` module options.
*/
sourceMapsUploadOptions?: SourceMapsOptions;

/**
*
* Enables (partial) server tracing by automatically injecting Sentry for environments where modifying the node option `--import` is not possible.
Expand Down
126 changes: 53 additions & 73 deletions packages/nuxt/src/vite/sourceMaps.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,20 +22,9 @@ export function setupSourceMaps(
nuxt: Nuxt,
addVitePlugin: (plugin: Plugin[], options?: { dev?: boolean; build?: boolean }) => void,
): void {
// TODO(v11): remove deprecated options (also from SentryNuxtModuleOptions type)

const isDebug = moduleOptions.debug;

// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const sourceMapsEnabled =
moduleOptions.sourcemaps?.disable === true
? false
: moduleOptions.sourcemaps?.disable === false
? true
: // eslint-disable-next-line typescript/no-deprecated
(sourceMapsUploadOptions.enabled ?? true);
const sourceMapsEnabled = moduleOptions.sourcemaps?.disable !== true;

@chargomechargomeJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nicohrubecnicohrubecJul 31, 2026

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed hahaha


// In case we overwrite the source map settings, we default to deleting the files
const shouldDeleteFilesFallback = { client: true, server: true };
Expand All@@ -62,11 +51,7 @@ export function setupSourceMaps(
? 'server-side'
: 'client-side';

if (
!moduleOptions.sourcemaps?.filesToDeleteAfterUpload &&
// eslint-disable-next-line typescript/no-deprecated
!sourceMapsUploadOptions.sourcemaps?.filesToDeleteAfterUpload
) {
if (!moduleOptions.sourcemaps?.filesToDeleteAfterUpload) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] We enabled \`'hidden'\` source maps for your ${enabledDeleteFallbacks} build. Source map files will be automatically deleted after uploading them to Sentry.`,
Expand DownExpand Up@@ -131,65 +116,27 @@ function normalizePath(path: string): string {
*
* Only exported for Testing purposes.
*/
// todo(v11): This "eslint-disable" can be removed again once we remove deprecated options.
// eslint-disable-next-line complexity
export function getPluginOptions(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): SentryVitePluginOptions | SentryRollupPluginOptions {
// eslint-disable-next-line typescript/no-deprecated
const sourceMapsUploadOptions = moduleOptions.sourceMapsUploadOptions || {};

const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

// Check for filesToDeleteAfterUpload in new location first, then deprecated location
const sourcemapsOptions = moduleOptions.sourcemaps || {};
// eslint-disable-next-line typescript/no-deprecated
const deprecatedSourcemapsOptions = sourceMapsUploadOptions.sourcemaps || {};

const filesToDeleteAfterUpload =
sourcemapsOptions.filesToDeleteAfterUpload ??
// eslint-disable-next-line typescript/no-deprecated
deprecatedSourcemapsOptions.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourceMapsUploadOptions.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}
const filesToDeleteAfterUpload = resolveFilesToDeleteAfterUpload(moduleOptions, shouldDeleteFilesFallback);

return {
applicationKey: moduleOptions.applicationKey,
// eslint-disable-next-line typescript/no-deprecated
org: moduleOptions.org ?? sourceMapsUploadOptions.org ?? process.env.SENTRY_ORG,
// eslint-disable-next-line typescript/no-deprecated
project: moduleOptions.project ?? sourceMapsUploadOptions.project ?? process.env.SENTRY_PROJECT,
// eslint-disable-next-line typescript/no-deprecated
authToken: moduleOptions.authToken ?? sourceMapsUploadOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
// eslint-disable-next-line typescript/no-deprecated
telemetry: moduleOptions.telemetry ?? sourceMapsUploadOptions.telemetry ?? true,
// eslint-disable-next-line typescript/no-deprecated
url: moduleOptions.sentryUrl ?? sourceMapsUploadOptions.url ?? process.env.SENTRY_URL,
org: moduleOptions.org ?? process.env.SENTRY_ORG,
project: moduleOptions.project ?? process.env.SENTRY_PROJECT,
authToken: moduleOptions.authToken ?? process.env.SENTRY_AUTH_TOKEN,
telemetry: moduleOptions.telemetry ?? true,
url: moduleOptions.sentryUrl ?? process.env.SENTRY_URL,
headers: moduleOptions.headers,
debug: moduleOptions.debug ?? false,
// eslint-disable-next-line typescript/no-deprecated
silent: moduleOptions.silent ?? sourceMapsUploadOptions.silent ?? false,
// eslint-disable-next-line typescript/no-deprecated
errorHandler: moduleOptions.errorHandler ?? sourceMapsUploadOptions.errorHandler,
silent: moduleOptions.silent ?? false,
errorHandler: moduleOptions.errorHandler,
bundleSizeOptimizations: moduleOptions.bundleSizeOptimizations, // todo: test if this can be overridden by the user
release: {
// eslint-disable-next-line typescript/no-deprecated
name: moduleOptions.release?.name ?? sourceMapsUploadOptions.release?.name,
name: moduleOptions.release?.name,
// Support all release options from BuildTimeOptionsBase
...moduleOptions.release,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.release,
Expand All@@ -206,21 +153,54 @@ export function getPluginOptions(
// The server/client files are in different places depending on the nitro preset (e.g. '.output/server' or '.netlify/functions-internal/server')
// We cannot determine automatically how the build folder looks like (depends on the preset), so we have to accept that source maps are uploaded multiple times (with the vitePlugin for Nuxt and the rollupPlugin for Nitro).
// If we could know where the server/client assets are located, we could do something like this (based on the Nitro preset): isNitro ? ['./.output/server/**/*'] : ['./.output/public/**/*'],
// eslint-disable-next-line typescript/no-deprecated
assets: sourcemapsOptions.assets ?? deprecatedSourcemapsOptions.assets ?? undefined,
// eslint-disable-next-line typescript/no-deprecated
ignore: sourcemapsOptions.ignore ?? deprecatedSourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload: filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesFallback?.server || shouldDeleteFilesFallback?.client
? fallbackFilesToDelete
: undefined,
assets: sourcemapsOptions.assets ?? undefined,
ignore: sourcemapsOptions.ignore ?? undefined,
filesToDeleteAfterUpload,
rewriteSources: sourcemapsOptions.rewriteSources ?? normalizePath,
...moduleOptions?.unstable_sentryBundlerPluginOptions?.sourcemaps,
},
};
}

/**
* Determines which files to delete after upload. If the user set `filesToDeleteAfterUpload`, we use
* that. Otherwise we only delete the source maps Sentry generated itself — i.e. the sides
* (client/server) whose `sourcemap` setting resolved to `undefined`, where Sentry stepped in and
* enabled `'hidden'`. Given Nuxt's default of `{ server: true, client: false }`, this isn't the
* default case: it only kicks in when a side is left `undefined` (whole config or a single sub-key).
* @see https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap
*/
Comment on lines +165 to +172

@s1gr1ds1gr1dJul 31, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nuxt has no undefined default values for source maps so this "deleting by default" cannot happen in the default case. Only if users would set them to undefined.

Maybe that's worth pointing out here. Also a link to the docs: https://nuxt.com/docs/4.x/api/nuxt-config#sourcemap

function resolveFilesToDeleteAfterUpload(
moduleOptions: SentryNuxtModuleOptions,
shouldDeleteFilesFallback?: { client: boolean; server: boolean },
): string | Array<string> | undefined {
const shouldDeleteFilesAfterUpload = shouldDeleteFilesFallback?.client || shouldDeleteFilesFallback?.server;
const fallbackFilesToDelete = [
...(shouldDeleteFilesFallback?.client ? ['.*/**/public/**/*.map'] : []),
...(shouldDeleteFilesFallback?.server
? ['.*/**/server/**/*.map', '.*/**/output/**/*.map', '.*/**/function/**/*.map']
: []),
];

const filesToDeleteAfterUpload = moduleOptions.sourcemaps?.filesToDeleteAfterUpload;

if (typeof filesToDeleteAfterUpload === 'undefined' && shouldDeleteFilesAfterUpload && moduleOptions.debug) {
// eslint-disable-next-line no-console
console.log(
`[Sentry] Setting \`sentry.sourcemaps.filesToDeleteAfterUpload: [${fallbackFilesToDelete
// Logging it as strings in the array
.map(path => `"${path}"`)
.join(', ')}]\` to delete generated source maps after they were uploaded to Sentry.`,
);
}

return filesToDeleteAfterUpload
? filesToDeleteAfterUpload
: shouldDeleteFilesAfterUpload
? fallbackFilesToDelete
: undefined;
}

/* There are multiple ways to set up source maps (https://github.com/getsentry/sentry-javascript/issues/13993 and https://github.com/getsentry/sentry-javascript/pull/15859)
1. User explicitly disabled source maps
- keep this setting (emit a warning that errors won't be unminified in Sentry)
Expand Down
Loading
Loading