feat(nextjs): Document options for disabling webpack plugin #3826
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/sentry/sentry-docs/6uxe4Yor4iTGjDBukPwHbNhgAhWM |
lobsterkatie
added a commit
to getsentry/sentry-javascript
that referenced
this pull request
Jun 30, 2021
Despite our strong encouragement, not everyone wants to use the `SentryWebpackPlugin` to upload sourcemaps. This PR introduces two new options, `disableServerWebpackPlugin` and `disableClientWebpackPlugin`, which can be used in `next.config.js` like this:
```
const { withSentryConfig } = require("@sentry/nextjs");
const moduleExports = {
sentry: {
disableServerWebpackPlugin: true,
disableClientWebpackPlugin: true,
},
};
// unnecessary if the webpack plugin is disabled for both server and client (in that case, can also safely
// be omitted from the `withSentryConfig` call below)
const SentryWebpackPluginOptions = {
// ...
};
module.exports = withSentryConfig(moduleExports, SentryWebpackPluginOptions);
```
Setting either of these options does two things in the relevant (server or client) config:
- prevents the SDK from forcing `webpack.devtool` to be `source-map` in production, and
- prevents the SDK from adding an instance of `SentryWebpackPlugin` to the webpack config.
These changes are documented in getsentry/sentry-docs#3826.
Fixes #3674
lobsterkatie
requested review from
a team,
rhcarvalho,
AbhiPrasad and
iker-barriocanal
and removed request for
a team and
rhcarvalho
lobsterkatie
force-pushed
the
kmclb-document-disabling-webpack-plugin-in-nextjs
branch
from
643649a to
cb3eea2
Compare
HazAT
approved these changes
Jul 6, 2021
iker-barriocanal
approved these changes
Jul 6, 2021
lobsterkatie
deleted the
kmclb-document-disabling-webpack-plugin-in-nextjs
branch
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds docs for the options introduced in getsentry/sentry-javascript#3771, which allow the user to disable the addition of
SentryWebpackPluginto server and client builds.