renamed ignoreComponents to ignoredComponents

Author: 0Calories

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

@@ -49,7 +49,7 @@ pnpm add @sentry/babel-plugin-component-annotate --save-dev
 
 ## Options
 
-### `ignoreComponents`
+### `ignoredComponents`
 
 Type: `string[]`
 
@@ -66,7 +66,7 @@ A list of strings representing the names of components to ignore. The plugin wil
   plugins: [
     // Put this plugin before any other plugins you have that transform JSX code
     // The options are set by providing an object as the second element in the array, but not required
-    ['@sentry/babel-plugin-component-annotate', {ignoreComponents: ['Foo', 'Bar']}]
+    ['@sentry/babel-plugin-component-annotate', {ignoredComponents: ['Foo', 'Bar']}]
   ],
 }
 ```

packages/babel-plugin-component-annotate/src/index.ts

@@ -48,7 +48,7 @@ const nativeSourceFileName = "dataSentrySourceFile";
 interface AnnotationOpts {
   native?: boolean;
   "annotate-fragments"?: boolean;
-  ignoreComponents?: string[];
+  ignoredComponents?: string[];
 }
 
 interface AnnotationPluginPass extends PluginPass {
@@ -76,7 +76,7 @@ export default function componentNameAnnotatePlugin({ types: t }: typeof Babel):
           path.node.id.name,
           sourceFileNameFromState(state),
           attributeNamesFromState(state),
-          state.opts.ignoreComponents ?? []
+          state.opts.ignoredComponents ?? []
         );
       },
       ArrowFunctionExpression(path, state) {
@@ -104,7 +104,7 @@ export default function componentNameAnnotatePlugin({ types: t }: typeof Babel):
           parent.id.name,
           sourceFileNameFromState(state),
           attributeNamesFromState(state),
-          state.opts.ignoreComponents ?? []
+          state.opts.ignoredComponents ?? []
         );
       },
       ClassDeclaration(path, state) {
@@ -118,7 +118,7 @@ export default function componentNameAnnotatePlugin({ types: t }: typeof Babel):
           return;
         }
 
-        const ignoredComponents = state.opts.ignoreComponents ?? [];
+        const ignoredComponents = state.opts.ignoredComponents ?? [];
 
         render.traverse({
           ReturnStatement(returnStatement) {

packages/babel-plugin-component-annotate/test/test-plugin.test.ts

@@ -1079,11 +1079,11 @@ it("Bananas incompatible plugin @react-navigation source snapshot matches", () =
   `);
 });
 
-it("skips components marked in ignoreComponents", () => {
+it("skips components marked in ignoredComponents", () => {
   const result = transform(BananasPizzaAppStandardInput, {
     filename: "/filename-test.js",
     presets: ["@babel/preset-react"],
-    plugins: [[plugin, { native: true, ignoreComponents: ["Bananas"] }]],
+    plugins: [[plugin, { native: true, ignoredComponents: ["Bananas"] }]],
   });
   expect(result?.code).toMatchInlineSnapshot(`
     "import React, { Component } from 'react';

packages/bundler-plugin-core/src/index.ts

@@ -30,7 +30,7 @@ import { closeSession, DEFAULT_ENVIRONMENT, makeSession } from "@sentry/core";
 
 interface SentryUnpluginFactoryOptions {
   releaseInjectionPlugin: (injectionCode: string) => UnpluginOptions;
-  componentNameAnnotatePlugin?: (ignoreComponents?: string[]) => UnpluginOptions;
+  componentNameAnnotatePlugin?: (ignoredComponents?: string[]) => UnpluginOptions;
   moduleMetadataInjectionPlugin: (injectionCode: string) => UnpluginOptions;
   debugIdInjectionPlugin: (logger: Logger) => UnpluginOptions;
   debugIdUploadPlugin: (upload: (buildArtifacts: string[]) => Promise<void>) => UnpluginOptions;
@@ -425,7 +425,7 @@ export function sentryUnpluginFactory({
       } else {
         componentNameAnnotatePlugin &&
           plugins.push(
-            componentNameAnnotatePlugin(options.reactComponentAnnotation.ignoreComponents)
+            componentNameAnnotatePlugin(options.reactComponentAnnotation.ignoredComponents)
           );
       }
     }
@@ -648,7 +648,7 @@ export function createRollupDebugIdUploadHooks(
   };
 }
 
-export function createComponentNameAnnotateHooks(ignoreComponents?: string[]) {
+export function createComponentNameAnnotateHooks(ignoredComponents?: string[]) {
   type ParserPlugins = NonNullable<
     NonNullable<Parameters<typeof transformAsync>[1]>["parserOpts"]
   >["plugins"];
@@ -676,7 +676,7 @@ export function createComponentNameAnnotateHooks(ignoreComponents?: string[]) {
 
       try {
         const result = await transformAsync(code, {
-          plugins: [[componentNameAnnotatePlugin, { ignoreComponents }]],
+          plugins: [[componentNameAnnotatePlugin, { ignoredComponents }]],
           filename: id,
           parserOpts: {
             sourceType: "module",

packages/bundler-plugin-core/src/types.ts

@@ -322,7 +322,7 @@ export interface Options {
     /**
      * A list of strings representing the names of components to ignore. The plugin will not apply `data-sentry` annotations on the DOM element for these components.
      */
-    ignoreComponents?: string[];
+    ignoredComponents?: string[];
     // TODO: Support this option in the future
     /**
      * A list of strings representing local paths to files to ignore. The plugin will not apply `data-sentry` annotations on components in these files

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

@@ -391,7 +391,7 @@ type IncludeEntry = {
         supportedBundlers: ["webpack", "vite", "rollup"],
       },
       {
-        name: "ignoreComponents",
+        name: "ignoredComponents",
         type: "string[]",
         fullDescription:
           "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.",

packages/rollup-plugin/src/index.ts

@@ -18,10 +18,10 @@ function rollupReleaseInjectionPlugin(injectionCode: string): UnpluginOptions {
   };
 }
 
-function rollupComponentNameAnnotatePlugin(ignoreComponents?: string[]): UnpluginOptions {
+function rollupComponentNameAnnotatePlugin(ignoredComponents?: string[]): UnpluginOptions {
   return {
     name: "sentry-rollup-component-name-annotate-plugin",
-    rollup: createComponentNameAnnotateHooks(ignoreComponents),
+    rollup: createComponentNameAnnotateHooks(ignoredComponents),
   };
 }
 

packages/vite-plugin/src/index.ts

@@ -21,11 +21,11 @@ function viteReleaseInjectionPlugin(injectionCode: string): UnpluginOptions {
   };
 }
 
-function viteComponentNameAnnotatePlugin(ignoreComponents?: string[]): UnpluginOptions {
+function viteComponentNameAnnotatePlugin(ignoredComponents?: string[]): UnpluginOptions {
   return {
     name: "sentry-vite-component-name-annotate-plugin",
     enforce: "pre" as const,
-    vite: createComponentNameAnnotateHooks(ignoreComponents),
+    vite: createComponentNameAnnotateHooks(ignoredComponents),
   };
 }
 

packages/webpack-plugin/src/index.ts

@@ -47,15 +47,15 @@ function webpackReleaseInjectionPlugin(injectionCode: string): UnpluginOptions {
   };
 }
 
-function webpackComponentNameAnnotatePlugin(ignoreComponents?: string[]): UnpluginOptions {
+function webpackComponentNameAnnotatePlugin(ignoredComponents?: string[]): UnpluginOptions {
   return {
     name: "sentry-webpack-component-name-annotate-plugin",
     enforce: "pre",
     // Webpack needs this hook for loader logic, so the plugin is not run on unsupported file types
     transformInclude(id) {
       return id.endsWith(".tsx") || id.endsWith(".jsx");
     },
-    transform: createComponentNameAnnotateHooks(ignoreComponents).transform,
+    transform: createComponentNameAnnotateHooks(ignoredComponents).transform,
   };
 }