From 53b10ec2a878d15088aad73d26d1047e835f1306 Mon Sep 17 00:00:00 2001 From: s1gr1d Date: Tue, 5 Aug 2025 11:13:09 +0200 Subject: [PATCH 1/3] docs(options): Improve JSDoc for options --- packages/bundler-plugin-core/src/types.ts | 125 +++++++++++------- .../src/generate-documentation-table.ts | 46 +++---- 2 files changed, 99 insertions(+), 72 deletions(-) diff --git a/packages/bundler-plugin-core/src/types.ts b/packages/bundler-plugin-core/src/types.ts index 1c088a4d..2b53393f 100644 --- a/packages/bundler-plugin-core/src/types.ts +++ b/packages/bundler-plugin-core/src/types.ts @@ -18,6 +18,8 @@ export interface Options { * 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. + * + * @see https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens */ authToken?: string; @@ -27,26 +29,27 @@ export interface Options { * * 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. + * @default "https://sentry.io" */ url?: string; /** - * Headers added to every outgoing network request. + * Additional headers to send with every outgoing request to Sentry. */ headers?: Record; /** - * Print useful debug information. + * Enable debug information logs during build-time. + * Enabling this will give you, for example, logs about source maps. * - * Defaults to `false`. + * @default false */ debug?: boolean; /** - * Suppresses all logs. + * Suppresses all build logs (all log levels, including errors). * - * Defaults to `false`. + * @default false */ silent?: boolean; @@ -68,14 +71,15 @@ export interface Options { errorHandler?: (err: Error) => void; /** - * 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. + * 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`. + * @default true */ telemetry?: boolean; @@ -87,35 +91,36 @@ export interface Options { disable?: boolean; /** - * Options for source maps uploading. + * Options related to source maps upload and processing. */ sourcemaps?: { /** - * Disables all functionality related to sourcemaps. + * If this flag is `true`, any functionality related to source maps will be disabled. * - * Defaults to `false`. + * @default false */ disable?: boolean; /** - * 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. + * */ assets?: 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 [] */ ignore?: string | string[]; @@ -150,11 +155,11 @@ export interface Options { /** * 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. * - * 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 + * 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). + * 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. */ @@ -173,10 +178,10 @@ export interface Options { * 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) + * 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. */ name?: string; @@ -188,45 +193,49 @@ export interface Options { inject?: 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 to create a new release. * - * Defaults to `true`. + * Note that a release may still appear in Sentry even if this value is `false`. Any Sentry event that has a release value attached + * will automatically create a release (for example, via the `inject` option). + * + * @default true */ create?: 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`. + * @default true */ finalize?: boolean; /** - * 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. */ dist?: 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. * - * Defaults to 'origin'. + * @default "origin" */ vcsRemote?: string; /** - * Associates the release with its commits in Sentry. + * Configuration for associating the release with its commits in Sentry. + * + * Set to `false` to disable commit association. * - * Defaults to `{ auto: true }`. Set to `false` to disable commit association. + * @default { auto: true } */ setCommits?: SetCommitsOptions | false; /** - * Adds deployment information to the release in Sentry. + * Configuration for adding deployment information to the release in Sentry. */ deploy?: DeployOptions; @@ -244,28 +253,34 @@ export interface Options { }; /** - * Options related to bundle size optimizations. + * Options for bundle size optimizations by excluding certain features. */ bundleSizeOptimizations?: { /** - * 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. + * + * @default false */ excludeDebugStatements?: 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()`). + + * @default false */ excludeTracing?: boolean; /** * If set to `true`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay Canvas 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 Canvas activity via Sentry Session Replay. * @@ -274,26 +289,38 @@ export interface Options { excludeReplayCanvas?: 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. + * + * @default false */ excludeReplayShadowDom?: boolean; /** - * 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. + * Exclude Replay iFrame functionality from the bundle. + * + * If set to `true`, the Sentry SDK 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. * * You can safely do this when you do not want to capture any `iframe` activity via Sentry Session Replay. + * + * @default false */ excludeReplayIframe?: boolean; /** - * 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. + * Exclude Replay worker functionality from the bundle. + * + * If set to `true`, the Sentry SDK 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. * * **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. + * + * @default false */ excludeReplayWorker?: boolean; }; @@ -573,7 +600,7 @@ type DeployOptions = { time?: number; /** - * Human readable name for the deployment. + * Human-readable name for the deployment. */ name?: string; diff --git a/packages/dev-utils/src/generate-documentation-table.ts b/packages/dev-utils/src/generate-documentation-table.ts index 3719d760..18058c57 100644 --- a/packages/dev-utils/src/generate-documentation-table.ts +++ b/packages/dev-utils/src/generate-documentation-table.ts @@ -24,7 +24,7 @@ const options: OptionDocumentation[] = [ name: "authToken", type: "string", fullDescription: - "The authentication token to use for all communication with Sentry. Can be obtained from https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/.\n\nThis value can also be specified via the `SENTRY_AUTH_TOKEN` environment variable.", + "The authentication token to use for all communication with Sentry.\nCan be obtained from https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/.\n\nThis value can also be specified via the `SENTRY_AUTH_TOKEN` environment variable.\n\nCheck out the docs on organization tokens: https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens", }, { name: "url", @@ -35,17 +35,17 @@ const options: OptionDocumentation[] = [ { name: "headers", type: "Record", - fullDescription: "Headers added to every outgoing network request.", + fullDescription: "Additional headers to send with every outgoing request to Sentry.", }, { name: "debug", type: "boolean", - fullDescription: "Print useful debug information. Defaults to `false`.", + fullDescription: "Enable debug information logs during build-time. Enabling this will give you, for example, logs about source maps. Defaults to `false`.", }, { name: "silent", type: "boolean", - fullDescription: "Suppresses all logs. Defaults to `false`.", + fullDescription: "Suppresses all build logs (all log levels, including errors). Defaults to `false`.", }, { name: "errorHandler", @@ -67,7 +67,7 @@ errorHandler: (err) => { name: "telemetry", type: "boolean", fullDescription: - "If set to true, internal plugin errors and performance data will be sent to Sentry.\n\nAt 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.\n\nDefaults to `true`.", + "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.\n\nAt 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.\n\nDefaults to `true`.", }, { name: "disable", @@ -76,19 +76,19 @@ errorHandler: (err) => { }, { name: "sourcemaps", - fullDescription: "Options for uploading source maps.", + fullDescription: "Options related to source maps upload and processing.", children: [ { name: "assets", type: "string | string[]", fullDescription: - "A glob or an array of globs that specifies the build artifacts that should be uploaded to Sentry.\n\nIf this option is not specified, the plugin will try to upload all JavaScript files and source map files that are created during build.\n\nThe globbing patterns follow the implementation of the `glob` package. (https://www.npmjs.com/package/glob)\n\nUse the `debug` option to print information about which files end up being uploaded.", + "A glob or an array of globs that specify the build artifacts and source maps that will be uploaded to Sentry.\n\nThe globbing patterns must follow the implementation of the `glob` package: https://www.npmjs.com/package/glob#glob-primer\n\nIf this option is not specified, the plugin will try to upload all JavaScript files and source map files that are created during build.\n\nUse the `debug` option to print information about which files end up being uploaded.", }, { name: "ignore", type: "string | string[]", fullDescription: - "A glob or an array of globs that specifies which build artifacts should not be uploaded to Sentry.\n\nDefault: `[]`\n\nThe globbing patterns follow the implementation of the `glob` package. (https://www.npmjs.com/package/glob)\n\nUse the `debug` option to print information about which files end up being uploaded.", + "A glob or an array of globs that specifies which build artifacts should not be uploaded to Sentry.\n\nThe globbing patterns must follow the implementation of the `glob` package: https://www.npmjs.com/package/glob#glob-primer\n\nUse the `debug` option to print information about which files end up being uploaded.\n\nDefault: `[]`", }, { name: "rewriteSources", @@ -122,13 +122,13 @@ Use the \`debug\` option to print information about source map resolution. name: "filesToDeleteAfterUpload", type: "string | string[] | Promise", fullDescription: - "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.\n\nThe globbing patterns follow the implementation of the `glob` package. (https://www.npmjs.com/package/glob)\n\nUse the `debug` option to print information about which files end up being deleted.", + "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.\n\nNote: 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).\n\nThe globbing patterns must follow the implementation of the `glob` package: https://www.npmjs.com/package/glob#glob-primer\n\nUse the `debug` option to print information about which files end up being deleted.", }, { name: "disable", type: "boolean", fullDescription: - "Disables all functionality related to sourcemaps.\n\nDefaults to `false`.", + "If this flag is `true`, any functionality related to source maps will be disabled.\n\nDefaults to `false`.", }, ], }, @@ -142,7 +142,7 @@ Use the \`debug\` option to print information about source map resolution. name: "name", type: "string", fullDescription: - "Unique identifier for the release you want to create.\n\nThis value can also be specified via the `SENTRY_RELEASE` environment variable.\n\nDefaults 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)\n\nIf you didn't provide a value and the plugin can't automatically detect one, no release will be created.", + "Unique identifier for the release you want to create.\n\nThis value can also be specified via the `SENTRY_RELEASE` environment variable.\n\nDefaults 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).\n\nIf no `name` is provided and the plugin can't automatically detect one, no release will be created.", }, { name: "inject", @@ -154,30 +154,30 @@ Use the \`debug\` option to print information about source map resolution. name: "create", type: "boolean", fullDescription: - "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)\n\nDefaults to `true`.", + "Whether to create a new release.\n\nNote 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)\n\nDefaults to `true`.", }, { name: "finalize", type: "boolean", fullDescription: - "Whether the Sentry release should be automatically finalized (meaning an end timestamp is added) after the build ends.\n\nDefaults to `true`.", + "Whether to automatically finalize the release. The release is finalized by adding an end timestamp after the build ends.\n\nDefaults to `true`.", }, { name: "dist", type: "string", fullDescription: - "Unique identifier for the distribution, used to further segment your release.", + "Unique distribution identifier for the release. Used to further segment the release.\n\nUsually your build number.", }, { name: "vcsRemote", type: "string", fullDescription: - "Version control system remote name.\n\nThis value can also be specified via the `SENTRY_VSC_REMOTE` environment variable.\n\nDefaults to 'origin'.", + "Version control system (VCS) remote name.\n\nThis value can also be specified via the `SENTRY_VSC_REMOTE` environment variable.\n\nDefaults to 'origin'.", }, { name: "setCommits", fullDescription: - "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.\n\nSet to `false` to disable commit association.\n\nDefaults to `{ auto: true }`.", children: [ { name: "previousCommit", @@ -219,7 +219,7 @@ Use the \`debug\` option to print information about source map resolution. }, { name: "deploy", - fullDescription: "Adds deployment information to the release in Sentry.", + fullDescription: "Configuration for adding deployment information to the release in Sentry.", children: [ { name: "env", @@ -368,32 +368,32 @@ type IncludeEntry = { }, { name: "bundleSizeOptimizations", - fullDescription: `Options related to bundle size optimizations. These options will allow you to optimize and reduce the bundle size of the Sentry SDK.`, + fullDescription: `Options for bundle size optimizations by excluding certain features.`, children: [ { name: "excludeDebugStatements", type: "boolean", - fullDescription: `If set to \`true\`, the plugin will attempt to tree-shake (remove) any debugging code within the Sentry SDK.\nNote that the success of this depends on tree shaking being enabled in your build tooling.\n\nSetting this option to \`true\` will disable features like the SDK's \`debug\` option.`, + fullDescription: `Exclude debug statements from the bundle, thus disabling features like the SDK's \`debug\` option.\n\nIf set to \`true\`, the plugin will attempt to tree-shake (remove) any debugging code within the Sentry SDK during the build.\nNote that the success of this depends on tree-shaking being enabled in your build tooling.\n\nDefaults to \`false\`.`, }, { name: "excludeTracing", type: "boolean", - fullDescription: `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.\nNote that the success of this depends on tree shaking being enabled in your build tooling.\n\n**Notice:** Do not enable this when you're using any performance monitoring-related SDK features (e.g. \`Sentry.startTransaction()\`).`, + fullDescription: `Exclude tracing functionality from the bundle, thus disabling features like performance monitoring.\n\nIf set to \`true\`, the plugin will attempt to tree-shake (remove) code within the Sentry SDK that is related to tracing and performance monitoring.\nNote that the success of this depends on tree-shaking being enabled in your build tooling.\n\n**Notice:** Do not enable this when you're using any performance monitoring-related SDK features (e.g. \`Sentry.startTransaction()\`).\n\nDefaults to \`false\`.`, }, { name: "excludeReplayShadowDom", type: "boolean", - fullDescription: `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.\nNote that the success of this depends on tree shaking being enabled in your build tooling.\n\nThis option is safe to be used when you do not want to capture any Shadow DOM activity via Sentry Session Replay.`, + fullDescription: `Exclude Replay Shadow DOM functionality from the bundle.\n\nIf set to \`true\`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay Shadow DOM recording functionality.\nNote that the success of this depends on tree-shaking being enabled in your build tooling.\n\nThis option is safe to be used when you do not want to capture any Shadow DOM activity via Sentry Session Replay.\n\nDefaults to \`false\`.`, }, { name: "excludeReplayIframe", type: "boolean", - fullDescription: `If set to \`true\`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay \`iframe\` recording functionality.\nNote that the success of this depends on tree shaking being enabled in your build tooling.\n\nYou can safely do this when you do not want to capture any \`iframe\` activity via Sentry Session Replay.`, + fullDescription: `Exclude Replay iFrame functionality from the bundle.\n\nIf set to \`true\`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay \`iframe\` recording functionality.\nNote that the success of this depends on tree-shaking being enabled in your build tooling.\n\nYou can safely do this when you do not want to capture any \`iframe\` activity via Sentry Session Replay.\n\nDefaults to \`false\`.`, }, { name: "excludeReplayWorker", type: "boolean", - fullDescription: `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.\nNote that the success of this depends on tree shaking being enabled in your build tooling.\n\n**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.`, + fullDescription: `Exclude Replay worker functionality from the bundle.\n\nIf set to \`true\`, the plugin will attempt to tree-shake (remove) code related to the Sentry SDK's Session Replay's Compression Web Worker.\nNote that the success of this depends on tree-shaking being enabled in your build tooling.\n\n**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.\n\nDefaults to \`false\`.`, }, ], }, From c115e1373cf846eec8cff79ccffa3bbf4a3a973c Mon Sep 17 00:00:00 2001 From: s1gr1d Date: Tue, 5 Aug 2025 11:19:00 +0200 Subject: [PATCH 2/3] small doc change --- packages/bundler-plugin-core/src/types.ts | 4 ++-- packages/dev-utils/src/generate-documentation-table.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/bundler-plugin-core/src/types.ts b/packages/bundler-plugin-core/src/types.ts index 2b53393f..92a5e1c8 100644 --- a/packages/bundler-plugin-core/src/types.ts +++ b/packages/bundler-plugin-core/src/types.ts @@ -29,7 +29,7 @@ export interface Options { * * This value can also be set via the `SENTRY_URL` environment variable. * - * @default "https://sentry.io" + * @default "https://sentry.io" (correct value for SaaS customers) */ url?: string; @@ -193,7 +193,7 @@ export interface Options { inject?: boolean; /** - * Whether to create a new release. + * Whether the plugin should create a release on Sentry during the build. * * Note that a release may still appear in Sentry even if this value is `false`. Any Sentry event that has a release value attached * will automatically create a release (for example, via the `inject` option). diff --git a/packages/dev-utils/src/generate-documentation-table.ts b/packages/dev-utils/src/generate-documentation-table.ts index 18058c57..ae05f985 100644 --- a/packages/dev-utils/src/generate-documentation-table.ts +++ b/packages/dev-utils/src/generate-documentation-table.ts @@ -154,7 +154,7 @@ Use the \`debug\` option to print information about source map resolution. name: "create", type: "boolean", fullDescription: - "Whether to create a new release.\n\nNote 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)\n\nDefaults to `true`.", + "Whether the plugin should create a release on Sentry during the build.\n\nNote 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)\n\nDefaults to `true`.", }, { name: "finalize", From be5fb041b2b121fa7cb6ac5106a637b8c27b0d11 Mon Sep 17 00:00:00 2001 From: s1gr1d Date: Tue, 5 Aug 2025 12:04:52 +0200 Subject: [PATCH 3/3] fix formatting --- packages/dev-utils/src/generate-documentation-table.ts | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/packages/dev-utils/src/generate-documentation-table.ts b/packages/dev-utils/src/generate-documentation-table.ts index ae05f985..3a4529c4 100644 --- a/packages/dev-utils/src/generate-documentation-table.ts +++ b/packages/dev-utils/src/generate-documentation-table.ts @@ -40,12 +40,14 @@ const options: OptionDocumentation[] = [ { name: "debug", type: "boolean", - fullDescription: "Enable debug information logs during build-time. Enabling this will give you, for example, logs about source maps. Defaults to `false`.", + fullDescription: + "Enable debug information logs during build-time. Enabling this will give you, for example, logs about source maps. Defaults to `false`.", }, { name: "silent", type: "boolean", - fullDescription: "Suppresses all build logs (all log levels, including errors). Defaults to `false`.", + fullDescription: + "Suppresses all build logs (all log levels, including errors). Defaults to `false`.", }, { name: "errorHandler", @@ -219,7 +221,8 @@ Use the \`debug\` option to print information about source map resolution. }, { name: "deploy", - fullDescription: "Configuration for adding deployment information to the release in Sentry.", + fullDescription: + "Configuration for adding deployment information to the release in Sentry.", children: [ { name: "env",