@sentry/esbuild-plugin 2.0.0-alpha.7 → 2.1.0

package/README.md

@@ -49,27 +49,6 @@ require("esbuild").build({
       // Auth tokens can be obtained from https://sentry.io/settings/account/api/auth-tokens/
       // and need `project:releases` and `org:read` scopes
       authToken: process.env.SENTRY_AUTH_TOKEN,
-
-      sourcemaps: {
-        // Specify the directory containing build artifacts
-        assets: "./**",
-        // Don't upload the source maps of dependencies
-        ignore: ["./node_modules/**"],
-      },
-
-      // Helps troubleshooting - set to false to make plugin less noisy
-      debug: true,
-
-      // Use the following option if you're on an SDK version lower than 7.47.0:
-      // release: {
-      //   uploadLegacySourcemaps: {
-      //     include: ".",
-      //     ignore: ["node_modules"],
-      //   },
-      // },
-
-      // Optionally uncomment the line below to override automatic release name detection
-      // release: process.env.RELEASE,
     }),
   ],
 });
@@ -106,17 +85,13 @@ require("esbuild").build({
 -   [`_experiments`](#option-_experiments)
     -   [`injectBuildInformation`](#option-_experiments-injectbuildinformation)
 
-### `org`
-
-<a name="option-org"></a>
+### <a name="option-org"></a>`org`
 
 Type: `string`
 
 The slug of the Sentry organization associated with the app.
 
-### `project`
-
-<a name="option-project"></a>
+### <a name="option-project"></a>`project`
 
 
 
@@ -124,9 +99,7 @@ The slug of the Sentry project associated with the app.
 
 This value can also be specified via the `SENTRY_PROJECT` environment variable.
 
-### `authToken`
-
-<a name="option-authtoken"></a>
+### <a name="option-authtoken"></a>`authToken`
 
 Type: `string`
 
@@ -134,9 +107,7 @@ The authentication token to use for all communication with Sentry. Can be obtain
 
 This value can also be specified via the `SENTRY_AUTH_TOKEN` environment variable.
 
-### `url`
-
-<a name="option-url"></a>
+### <a name="option-url"></a>`url`
 
 Type: `string`
 
@@ -146,33 +117,25 @@ This value can also be set via the SENTRY_URL environment variable.
 
 Defaults to https://sentry.io/, which is the correct value for SaaS customers.
 
-### `headers`
-
-<a name="option-headers"></a>
+### <a name="option-headers"></a>`headers`
 
 Type: `Record<string, string>`
 
 Headers added to every outgoing network request.
 
-### `debug`
-
-<a name="option-debug"></a>
+### <a name="option-debug"></a>`debug`
 
 Type: `boolean`
 
 Print useful debug information. Defaults to `false`.
 
-### `silent`
-
-<a name="option-silent"></a>
+### <a name="option-silent"></a>`silent`
 
 Type: `boolean`
 
 Suppresses all logs. Defaults to `false`.
 
-### `errorHandler`
-
-<a name="option-errorhandler"></a>
+### <a name="option-errorhandler"></a>`errorHandler`
 
 Type: `(err: Error) => void`
 
@@ -189,9 +152,7 @@ errorHandler: (err) => {
 ```
 
 
-### `telemetry`
-
-<a name="option-telemetry"></a>
+### <a name="option-telemetry"></a>`telemetry`
 
 Type: `boolean`
 
@@ -201,36 +162,30 @@ At Sentry we like to use Sentry ourselves to deliver faster and more stable prod
 
 Defaults to `true`.
 
-### `disable`
-
-<a name="option-disable"></a>
+### <a name="option-disable"></a>`disable`
 
 Type: `boolean`
 
 Completely disables all functionality of the plugin. Defaults to `false`.
 
-### `sourcemaps`
-
-<a name="option-sourcemaps"></a>
+### <a name="option-sourcemaps"></a>`sourcemaps`
 
 
 
 Options for source maps uploading. Leave this option undefined if you do not want to upload source maps to Sentry.
-### `sourcemaps.assets`
-
-<a name="option-sourcemaps-assets"></a>
+### <a name="option-sourcemaps-assets"></a>`sourcemaps.assets`
 
 Type: `string | string[]`
 
 A glob or an array of globs that specifies the build artifacts that should 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 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.
 
-### `sourcemaps.ignore`
-
-<a name="option-sourcemaps-ignore"></a>
+### <a name="option-sourcemaps-ignore"></a>`sourcemaps.ignore`
 
 Type: `string | string[]`
 
@@ -242,9 +197,7 @@ The globbing patterns follow the implementation of the `glob` package. (https://
 
 Use the `debug` option to print information about which files end up being uploaded.
 
-### `sourcemaps.rewriteSources`
-
-<a name="option-sourcemaps-rewritesources"></a>
+### <a name="option-sourcemaps-rewritesources"></a>`sourcemaps.rewriteSources`
 
 Type: `(source: string, map: any) => string`
 
@@ -252,9 +205,7 @@ Hook to rewrite the `sources` field inside the source map before being uploaded
 
 Defaults to making all sources relative to `process.cwd()` while building.
 
-### `sourcemaps.deleteFilesAfterUpload`
-
-<a name="option-sourcemaps-deletefilesafterupload"></a>
+### <a name="option-sourcemaps-deletefilesafterupload"></a>`sourcemaps.deleteFilesAfterUpload`
 
 Type: `string | string[]`
 
@@ -264,18 +215,14 @@ The globbing patterns follow the implementation of the `glob` package. (https://
 
 Use the `debug` option to print information about which files end up being deleted.
 
-### `release`
-
-<a name="option-release"></a>
+### <a name="option-release"></a>`release`
 
 
 
 Options related to managing the Sentry releases for a build.
 
 More info: https://docs.sentry.io/product/releases/
-### `release.name`
-
-<a name="option-release-name"></a>
+### <a name="option-release-name"></a>`release.name`
 
 Type: `string`
 
@@ -287,9 +234,7 @@ Defaults to automatically detecting a value for your environment. This includes
 
 If you didn't provide a value and the plugin can't automatically detect one, no release will be created.
 
-### `release.inject`
-
-<a name="option-release-inject"></a>
+### <a name="option-release-inject"></a>`release.inject`
 
 Type: `boolean`
 
@@ -297,9 +242,7 @@ Whether the plugin should inject release information into the build for the SDK
 
 Defaults to `true`.
 
-### `release.create`
-
-<a name="option-release-create"></a>
+### <a name="option-release-create"></a>`release.create`
 
 Type: `boolean`
 
@@ -307,9 +250,7 @@ Whether the plugin should create a release on Sentry during the build. Note that
 
 Defaults to `true`.
 
-### `release.finalize`
-
-<a name="option-release-finalize"></a>
+### <a name="option-release-finalize"></a>`release.finalize`
 
 Type: `boolean`
 
@@ -317,17 +258,13 @@ Whether the Sentry release should be automatically finalized (meaning an end tim
 
 Defaults to `true`.
 
-### `release.dist`
-
-<a name="option-release-dist"></a>
+### <a name="option-release-dist"></a>`release.dist`
 
 Type: `string`
 
 Unique identifier for the distribution, used to further segment your release.
 
-### `release.vcsRemote`
-
-<a name="option-release-vcsremote"></a>
+### <a name="option-release-vcsremote"></a>`release.vcsRemote`
 
 Type: `string`
 
@@ -337,16 +274,12 @@ This value can also be specified via the `SENTRY_VSC_REMOTE` environment variabl
 
 Defaults to 'origin'.
 
-### `release.setCommits`
-
-<a name="option-release-setcommits"></a>
+### <a name="option-release-setcommits"></a>`release.setCommits`
 
 
 
 Option to associate the created release with its commits in Sentry.
-### `release.setCommits.previousCommit`
-
-<a name="option-release-setcommits-previouscommit"></a>
+### <a name="option-release-setcommits-previouscommit"></a>`release.setCommits.previousCommit`
 
 Type: `string`
 
@@ -356,9 +289,7 @@ Defaults to the last commit of the previous release in Sentry.
 
 If there was no previous release, the last 10 commits will be used.
 
-### `release.setCommits.ignoreMissing`
-
-<a name="option-release-setcommits-ignoremissing"></a>
+### <a name="option-release-setcommits-ignoremissing"></a>`release.setCommits.ignoreMissing`
 
 Type: `boolean`
 
@@ -366,9 +297,7 @@ If the flag is to `true` and the previous release commit was not found in the re
 
 Defaults to `false`.
 
-### `release.setCommits.ignoreEmpty`
-
-<a name="option-release-setcommits-ignoreempty"></a>
+### <a name="option-release-setcommits-ignoreempty"></a>`release.setCommits.ignoreEmpty`
 
 Type: `boolean`
 
@@ -376,9 +305,7 @@ If this flag is set, the setCommits step will not fail and just exit silently if
 
 Defaults to `false`.
 
-### `release.setCommits.auto`
-
-<a name="option-release-setcommits-auto"></a>
+### <a name="option-release-setcommits-auto"></a>`release.setCommits.auto`
 
 Type: `boolean`
 
@@ -386,9 +313,7 @@ Automatically sets `commit` and `previousCommit`. Sets `commit` to `HEAD` and `p
 
 If you set this to `true`, manually specified `commit` and `previousCommit` options will be overridden. It is best to not specify them at all if you set this option to `true`.
 
-### `release.setCommits.repo`
-
-<a name="option-release-setcommits-repo"></a>
+### <a name="option-release-setcommits-repo"></a>`release.setCommits.repo`
 
 Type: `string`
 
@@ -396,9 +321,7 @@ The full repo name as defined in Sentry.
 
 Required if the `auto` option is not set to `true`.
 
-### `release.setCommits.commit`
-
-<a name="option-release-setcommits-commit"></a>
+### <a name="option-release-setcommits-commit"></a>`release.setCommits.commit`
 
 Type: `string`
 
@@ -406,64 +329,48 @@ The current (last) commit in the release.
 
 Required if the `auto` option is not set to `true`.
 
-### `release.deploy`
-
-<a name="option-release-deploy"></a>
+### <a name="option-release-deploy"></a>`release.deploy`
 
 
 
 Adds deployment information to the release in Sentry.
-### `release.deploy.env`
-
-<a name="option-release-deploy-env"></a>
+### <a name="option-release-deploy-env"></a>`release.deploy.env`
 
 Type: `string`
 
 Environment for this release. Values that make sense here would be `production` or `staging`.
 
-### `release.deploy.started`
-
-<a name="option-release-deploy-started"></a>
+### <a name="option-release-deploy-started"></a>`release.deploy.started`
 
 Type: `number | string`
 
 Deployment start time in Unix timestamp (in seconds) or ISO 8601 format.
 
-### `release.deploy.finished`
-
-<a name="option-release-deploy-finished"></a>
+### <a name="option-release-deploy-finished"></a>`release.deploy.finished`
 
 Type: `number | string`
 
 Deployment finish time in Unix timestamp (in seconds) or ISO 8601 format.
 
-### `release.deploy.time`
-
-<a name="option-release-deploy-time"></a>
+### <a name="option-release-deploy-time"></a>`release.deploy.time`
 
 Type: `number`
 
 Deployment duration (in seconds). Can be used instead of started and finished.
 
-### `release.deploy.name`
-
-<a name="option-release-deploy-name"></a>
+### <a name="option-release-deploy-name"></a>`release.deploy.name`
 
 Type: `string`
 
 Human readable name for the deployment.
 
-### `release.deploy.url`
-
-<a name="option-release-deploy-url"></a>
+### <a name="option-release-deploy-url"></a>`release.deploy.url`
 
 Type: `string`
 
 URL that points to the deployment.
 
-### `release.cleanArtifacts`
-
-<a name="option-release-cleanartifacts"></a>
+### <a name="option-release-cleanartifacts"></a>`release.cleanArtifacts`
 
 Type: `boolean`
 
@@ -471,9 +378,7 @@ Remove all previously uploaded artifacts for this release on Sentry before the u
 
 Defaults to `false`.
 
-### `release.uploadLegacySourcemaps`
-
-<a name="option-release-uploadlegacysourcemaps"></a>
+### <a name="option-release-uploadlegacysourcemaps"></a>`release.uploadLegacySourcemaps`
 
 Type: `string | IncludeEntry | Array<string | IncludeEntry>`
 
@@ -573,16 +478,12 @@ type IncludeEntry = {
 
 
 
-### `_experiments`
-
-<a name="option-_experiments"></a>
+### <a name="option-_experiments"></a>`_experiments`
 
 Type: `string`
 
 Options that are considered experimental and subject to change. This option does not follow semantic versioning and may change in any release.
-### `_experiments.injectBuildInformation`
-
-<a name="option-_experiments-injectbuildinformation"></a>
+### <a name="option-_experiments-injectbuildinformation"></a>`_experiments.injectBuildInformation`
 
 Type: `boolean`