Skip to content

Commit 3a65227

Browse files
committed
update documentation
1 parent 5374baa commit 3a65227

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

packages/babel-plugin-component-annotate/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,14 @@ Using pnpm:
4747
pnpm add @sentry/babel-plugin-component-annotate --save-dev
4848
```
4949

50+
## Options
51+
52+
### `ignoreComponents`
53+
54+
Type: `string[]`
55+
56+
A list of strings representing the names of components to ignore. The plugin will not perform apply `data-sentry` annotations on the DOM element for these components.
57+
5058
## Example
5159

5260
```js
@@ -57,7 +65,8 @@ pnpm add @sentry/babel-plugin-component-annotate --save-dev
5765

5866
plugins: [
5967
// Put this plugin before any other plugins you have that transform JSX code
60-
['@sentry/babel-plugin-component-annotate']
68+
// The options are set by providing an object as the second element in the array, but not required
69+
['@sentry/babel-plugin-component-annotate', {ignoreComponents: ['Foo', 'Bar']}]
6170
],
6271
}
6372
```

packages/dev-utils/src/generate-documentation-table.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ type IncludeEntry = {
363363
name: "ignoreComponents",
364364
type: "string[]",
365365
fullDescription:
366-
"A list of strings representing the names of components to ignore. The plugin will not perform apply `data-sentry` annotations on the DOM element for this component.",
366+
"A list of strings representing the names of components to ignore. The plugin will not perform apply `data-sentry` annotations on the DOM element for these components.",
367367
supportedBundlers: ["webpack", "vite", "rollup"],
368368
},
369369
// TODO: Support this option in the future

0 commit comments

Comments
 (0)