@sentry/webpack-plugin
Advanced tools
Comparing version
{ | ||
"name": "@sentry/webpack-plugin", | ||
"version": "4.0.2", | ||
"version": "4.1.0", | ||
"description": "Official Sentry Webpack plugin", | ||
@@ -56,3 +56,3 @@ "repository": "git://github.com/getsentry/sentry-javascript-bundler-plugins.git", | ||
"dependencies": { | ||
"@sentry/bundler-plugin-core": "4.0.2", | ||
"@sentry/bundler-plugin-core": "4.1.0", | ||
"unplugin": "1.0.1", | ||
@@ -67,4 +67,4 @@ "uuid": "^9.0.0" | ||
"@rollup/plugin-commonjs": "22.0.1", | ||
"@sentry-internal/eslint-config": "4.0.2", | ||
"@sentry-internal/sentry-bundler-plugin-tsconfig": "4.0.2", | ||
"@sentry-internal/eslint-config": "4.1.0", | ||
"@sentry-internal/sentry-bundler-plugin-tsconfig": "4.1.0", | ||
"@swc/core": "^1.2.205", | ||
@@ -71,0 +71,0 @@ "@swc/jest": "^0.2.21", |
@@ -123,6 +123,9 @@ <p align="center"> | ||
The authentication token to use for all communication with Sentry. Can be obtained from https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/. | ||
The authentication token to use for all communication with Sentry. | ||
Can be obtained from https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/. | ||
This value can also be specified via the `SENTRY_AUTH_TOKEN` environment variable. | ||
Check out the docs on organization tokens: https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens | ||
### `url` | ||
@@ -142,3 +145,3 @@ | ||
Headers added to every outgoing network request. | ||
Additional headers to send with every outgoing request to Sentry. | ||
@@ -149,3 +152,3 @@ ### `debug` | ||
Print useful debug information. Defaults to `false`. | ||
Enable debug information logs during build-time. Enabling this will give you, for example, logs about source maps. Defaults to `false`. | ||
@@ -156,3 +159,3 @@ ### `silent` | ||
Suppresses all logs. Defaults to `false`. | ||
Suppresses all build logs (all log levels, including errors). Defaults to `false`. | ||
@@ -180,5 +183,5 @@ ### `errorHandler` | ||
If set to true, internal plugin errors and performance data will be sent to Sentry. | ||
If this flag is `true`, internal plugin errors and performance data will be sent to Sentry. It will not collect any sensitive or user-specific data. | ||
At Sentry we like to use Sentry ourselves to deliver faster and more stable products. We're very careful of what we're sending. We won't collect anything other than error and high-level performance data. We will never collect your code or any details of the projects in which you're using this plugin. | ||
At Sentry, we like to use Sentry ourselves to deliver faster and more stable products. We're very careful of what we're sending. We won't collect anything other than error and high-level performance data. We will never collect your code or any details of the projects in which you're using this plugin. | ||
@@ -197,3 +200,3 @@ Defaults to `true`. | ||
Options for uploading source maps. | ||
Options related to source maps upload and processing. | ||
### `sourcemaps.assets` | ||
@@ -203,8 +206,8 @@ | ||
A glob or an array of globs that specifies the build artifacts that should be uploaded to Sentry. | ||
A glob or an array of globs that specify the build artifacts and source maps that will be uploaded to Sentry. | ||
The globbing patterns must follow the implementation of the `glob` package: https://www.npmjs.com/package/glob#glob-primer | ||
If this option is not specified, the plugin will try to upload all JavaScript files and source map files that are created during build. | ||
The globbing patterns follow the implementation of the `glob` package. (https://www.npmjs.com/package/glob) | ||
Use the `debug` option to print information about which files end up being uploaded. | ||
@@ -218,8 +221,8 @@ | ||
Default: `[]` | ||
The globbing patterns must follow the implementation of the `glob` package: https://www.npmjs.com/package/glob#glob-primer | ||
The globbing patterns follow the implementation of the `glob` package. (https://www.npmjs.com/package/glob) | ||
Use the `debug` option to print information about which files end up being uploaded. | ||
Default: `[]` | ||
### `sourcemaps.rewriteSources` | ||
@@ -262,4 +265,6 @@ | ||
The globbing patterns follow the implementation of the `glob` package. (https://www.npmjs.com/package/glob) | ||
Note: If you pass in a Promise that resolves to a string or array, the plugin will await the Promise and use the resolved value globs. This is useful if you need to dynamically determine the files to delete. Some higher-level Sentry SDKs or options use this feature (e.g., SvelteKit). | ||
The globbing patterns must follow the implementation of the `glob` package: https://www.npmjs.com/package/glob#glob-primer | ||
Use the `debug` option to print information about which files end up being deleted. | ||
@@ -271,3 +276,3 @@ | ||
Disables all functionality related to sourcemaps. | ||
If this flag is `true`, any functionality related to source maps will be disabled. | ||
@@ -291,5 +296,5 @@ Defaults to `false`. | ||
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) | ||
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. | ||
If no `name` is provided and the plugin can't automatically detect one, no release will be created. | ||
@@ -308,4 +313,6 @@ ### `release.inject` | ||
Whether the plugin should create a release on Sentry during the build. Note that a release may still appear in Sentry even if this is value is `false` because any Sentry event that has a release value attached will automatically create a release. (for example via the `inject` option) | ||
Whether the plugin should create a release on Sentry during the build. | ||
Note that a release may still appear in Sentry even if this is value is `false` because any Sentry event that has a release value attached will automatically create a release. (for example via the `inject` option) | ||
Defaults to `true`. | ||
@@ -317,3 +324,3 @@ | ||
Whether the Sentry release should be automatically finalized (meaning an end timestamp is added) after the build ends. | ||
Whether to automatically finalize the release. The release is finalized by adding an end timestamp after the build ends. | ||
@@ -326,4 +333,6 @@ Defaults to `true`. | ||
Unique identifier for the distribution, used to further segment your release. | ||
Unique distribution identifier for the release. Used to further segment the release. | ||
Usually your build number. | ||
### `release.vcsRemote` | ||
@@ -333,3 +342,3 @@ | ||
Version control system remote name. | ||
Version control system (VCS) remote name. | ||
@@ -344,3 +353,7 @@ This value can also be specified via the `SENTRY_VSC_REMOTE` environment variable. | ||
Option to associate the created release with its commits in Sentry. Defaults to `{ auto: true }`. Set to `false` to disable. | ||
Configuration for associating the release with its commits in Sentry. | ||
Set to `false` to disable commit association. | ||
Defaults to `{ auto: true }`. | ||
### `release.setCommits.previousCommit` | ||
@@ -400,3 +413,3 @@ | ||
Adds deployment information to the release in Sentry. | ||
Configuration for adding deployment information to the release in Sentry. | ||
### `release.deploy.env` | ||
@@ -554,3 +567,3 @@ | ||
Options related to bundle size optimizations. These options will allow you to optimize and reduce the bundle size of the Sentry SDK. | ||
Options for bundle size optimizations by excluding certain features. | ||
### `bundleSizeOptimizations.excludeDebugStatements` | ||
@@ -560,7 +573,9 @@ | ||
If set to `true`, the plugin will attempt to tree-shake (remove) any debugging code within the Sentry SDK. | ||
Note that the success of this depends on tree shaking being enabled in your build tooling. | ||
Exclude debug statements from the bundle, thus disabling features like the SDK's `debug` option. | ||
Setting this option to `true` will disable features like the SDK's `debug` option. | ||
If set to `true`, the plugin will attempt to tree-shake (remove) any debugging code within the Sentry SDK during the build. | ||
Note that the success of this depends on tree-shaking being enabled in your build tooling. | ||
Defaults to `false`. | ||
### `bundleSizeOptimizations.excludeTracing` | ||
@@ -570,7 +585,11 @@ | ||
Exclude tracing functionality from the bundle, thus disabling features like performance monitoring. | ||
If set to `true`, the plugin will attempt to tree-shake (remove) code within the Sentry SDK that is related to tracing and performance monitoring. | ||
Note that the success of this depends on tree shaking being enabled in your build tooling. | ||
Note that the success of this depends on tree-shaking being enabled in your build tooling. | ||
**Notice:** Do not enable this when you're using any performance monitoring-related SDK features (e.g. `Sentry.startTransaction()`). | ||
Defaults to `false`. | ||
### `bundleSizeOptimizations.excludeReplayShadowDom` | ||
@@ -580,7 +599,11 @@ | ||
Exclude Replay Shadow DOM functionality from the bundle. | ||
If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay Shadow DOM recording functionality. | ||
Note that the success of this depends on tree shaking being enabled in your build tooling. | ||
Note that the success of this depends on tree-shaking being enabled in your build tooling. | ||
This option is safe to be used when you do not want to capture any Shadow DOM activity via Sentry Session Replay. | ||
Defaults to `false`. | ||
### `bundleSizeOptimizations.excludeReplayIframe` | ||
@@ -590,7 +613,11 @@ | ||
Exclude Replay iFrame functionality from the bundle. | ||
If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay `iframe` recording functionality. | ||
Note that the success of this depends on tree shaking being enabled in your build tooling. | ||
Note that the success of this depends on tree-shaking being enabled in your build tooling. | ||
You can safely do this when you do not want to capture any `iframe` activity via Sentry Session Replay. | ||
Defaults to `false`. | ||
### `bundleSizeOptimizations.excludeReplayWorker` | ||
@@ -600,7 +627,11 @@ | ||
Exclude Replay worker functionality from the bundle. | ||
If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay's Compression Web Worker. | ||
Note that the success of this depends on tree shaking being enabled in your build tooling. | ||
Note that the success of this depends on tree-shaking being enabled in your build tooling. | ||
**Notice:** You should only use this option if you manually host a compression worker and configure it in your Sentry Session Replay integration config via the `workerUrl` option. | ||
Defaults to `false`. | ||
### `reactComponentAnnotation` | ||
@@ -607,0 +638,0 @@ |
95358
1.22%680
4.78%+ Added
+ Added
- Removed
- Removed