Skip to content

docs: Warn about risks of reactComponentAnnotation #699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 17, 2025
Merged

docs: Warn about risks of reactComponentAnnotation #699

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions packages/dev-utils/src/generate-documentation-table.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,12 +377,8 @@ type IncludeEntry = {
},
{
name: "reactComponentAnnotation",
fullDescription: `Options related to react component name annotations.
Disabled by default, unless a value is set for this option.
When enabled, your app's DOM will automatically be annotated during build-time with their respective component names.
This will unlock the capability to search for Replays in Sentry by component name, as well as see component names in breadcrumbs and performance monitoring.
Please note that this feature is not currently supported by the esbuild bundler plugins, and will only annotate React components
`,
fullDescription: `(NOTICE: Use the react component annotation feature with caution. The option will pass additional properties to your React components which may lead to errors if libraries or your own code iterate through component props without checking for the additional Sentry props.)\n\nOptions related to react component name annotations.
Disabled by default, unless a value is set for this option.\nWhen enabled, your app's DOM will automatically be annotated during build-time with their respective component names.\nThis will unlock the capability to search for Replays in Sentry by component name, as well as see component names in breadcrumbs and performance monitoring.`,
supportedBundlers: ["webpack", "vite", "rollup"],
children: [
{
Expand Down
Loading