@sentry/esbuild-plugin 4.0.1 → 4.1.0

package/README.md

@@ -115,10 +115,13 @@ This value can also be specified via the `SENTRY_PROJECT` environment variable.
 
 Type: `string`
 
-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`
 
 Type: `string`
@@ -133,19 +136,19 @@ Defaults to https://sentry.io/, which is the correct value for SaaS customers.
 
 Type: `Record<string, string>`
 
-Headers added to every outgoing network request.
+Additional headers to send with every outgoing request to Sentry.
 
 ### `debug`
 
 Type: `boolean`
 
-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`.
 
 ### `silent`
 
 Type: `boolean`
 
-Suppresses all logs. Defaults to `false`.
+Suppresses all build logs (all log levels, including errors). Defaults to `false`.
 
 ### `errorHandler`
 
@@ -168,9 +171,9 @@ errorHandler: (err) => {
 
 Type: `boolean`
 
-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.
 
 Defaults to `true`.
 
@@ -184,16 +187,16 @@ Completely disables all functionality of the plugin. Defaults to `false`.
 
 
 
-Options for uploading source maps.
+Options related to source maps upload and processing.
 ### `sourcemaps.assets`
 
 Type: `string | string[]`
 
-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.
 
-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 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)
+If this option is not specified, the plugin will try to upload all JavaScript files and source map files that are created during build.
 
 Use the `debug` option to print information about which files end up being uploaded.
 
@@ -203,12 +206,12 @@ Type: `string | string[]`
 
 A glob or an array of globs that specifies which build artifacts should not be uploaded to Sentry.
 
-Default: `[]`
-
-The globbing patterns follow the implementation of the `glob` package. (https://www.npmjs.com/package/glob)
+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 uploaded.
 
+Default: `[]`
+
 ### `sourcemaps.rewriteSources`
 
 Type: `(source: string, map: any) => string`
@@ -246,7 +249,9 @@ Type: `string | string[] | Promise<string | string[]>`
 
 A glob, an array of globs or a promise resolving a glob or array of globs that specifies the build artifacts that should be deleted after the artifact upload to Sentry has been completed.
 
-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.
 
@@ -254,7 +259,7 @@ Use the `debug` option to print information about which files end up being delet
 
 Type: `boolean`
 
-Disables all functionality related to sourcemaps.
+If this flag is `true`, any functionality related to source maps will be disabled.
 
 Defaults to `false`.
 
@@ -273,9 +278,9 @@ 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)
+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.
 
 ### `release.inject`
 
@@ -289,7 +294,9 @@ Defaults to `true`.
 
 Type: `boolean`
 
-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`.
 
@@ -297,7 +304,7 @@ Defaults to `true`.
 
 Type: `boolean`
 
-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.
 
 Defaults to `true`.
 
@@ -305,13 +312,15 @@ Defaults to `true`.
 
 Type: `string`
 
-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`
 
 Type: `string`
 
-Version control system remote name.
+Version control system (VCS) remote name.
 
 This value can also be specified via the `SENTRY_VSC_REMOTE` environment variable.
 
@@ -321,7 +330,11 @@ Defaults to 'origin'.
 
 
 
-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`
 
 Type: `string`
@@ -376,7 +389,7 @@ Required if the `auto` option is not set to `true`.
 
 
 
-Adds deployment information to the release in Sentry.
+Configuration for adding deployment information to the release in Sentry.
 ### `release.deploy.env`
 
 Type: `string`
@@ -529,52 +542,70 @@ type IncludeEntry = {
 
 
 
-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`
 
 Type: `boolean`
 
-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.
+
+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.
 
-Setting this option to `true` will disable features like the SDK's `debug` option.
+Defaults to `false`.
 
 ### `bundleSizeOptimizations.excludeTracing`
 
 Type: `boolean`
 
+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`
 
 Type: `boolean`
 
+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`
 
 Type: `boolean`
 
+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`
 
 Type: `boolean`
 
+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`.
+
 
 ### `moduleMetadata`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/esbuild-plugin",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "Official Sentry esbuild plugin",
   "repository": "git@github.com:getsentry/sentry-javascript-bundler-plugins.git",
   "homepage": "https://github.com/getsentry/sentry-javascript-bundler-plugins/tree/main/packages/esbuild-plugin",
@@ -48,7 +48,7 @@
     "prepack": "ts-node ./src/prepack.ts"
   },
   "dependencies": {
-    "@sentry/bundler-plugin-core": "4.0.1",
+    "@sentry/bundler-plugin-core": "4.1.0",
     "unplugin": "1.0.1",
     "uuid": "^9.0.0"
   },
@@ -58,8 +58,8 @@
     "@babel/preset-typescript": "7.17.12",
     "@rollup/plugin-babel": "5.3.1",
     "@rollup/plugin-node-resolve": "13.3.0",
-    "@sentry-internal/eslint-config": "4.0.1",
-    "@sentry-internal/sentry-bundler-plugin-tsconfig": "4.0.1",
+    "@sentry-internal/eslint-config": "4.1.0",
+    "@sentry-internal/sentry-bundler-plugin-tsconfig": "4.1.0",
     "@swc/core": "^1.2.205",
     "@swc/jest": "^0.2.21",
     "@types/jest": "^28.1.3",