Create options for skipping annotations on components

Author: 0Calories

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

@@ -610,7 +610,10 @@ export function createRollupDebugIdUploadHooks(
   };
 }
 
-export function createComponentNameAnnotateHooks() {
+export function createComponentNameAnnotateHooks(
+  ignoredFiles?: string[],
+  ignoredComponents?: string[]
+) {
   type ParserPlugins = NonNullable<
     NonNullable<Parameters<typeof transformAsync>[1]>["parserOpts"]
   >["plugins"];

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

@@ -302,6 +302,14 @@ export interface Options {
      * Whether the component name annotate plugin should be enabled or not.
      */
     enabled?: boolean;
+    /**
+     * A list of strings representing local paths to files to ignore. The plugin will not perform any annotations on components in these files
+     */
+    ignoredFiles?: string[];
+    /**
+     * A list of strings representing the names of components to ignore. The plugin will not perform any annotations on these components
+     */
+    ignoredComponents?: string[];
   };
 
   /**

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

@@ -359,6 +359,20 @@ type IncludeEntry = {
         fullDescription: "Whether the component name annotate plugin should be enabled or not.",
         supportedBundlers: ["webpack", "vite", "rollup"],
       },
+      {
+        name: "ignoredFiles",
+        type: "string[]",
+        fullDescription:
+          "A list of strings representing local paths to files to ignore. The plugin will not perform any annotations on components in these files.",
+        supportedBundlers: ["webpack", "vite", "rollup"],
+      },
+      {
+        name: "ignoredComponents",
+        type: "string[]",
+        fullDescription:
+          "A list of strings representing the names of components to ignore. The plugin will not perform any annotations on these components.",
+        supportedBundlers: ["webpack", "vite", "rollup"],
+      },
     ],
   },
   {

packages/rollup-plugin/src/index.ts

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

packages/vite-plugin/src/index.ts

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

packages/webpack-plugin/src/index.ts

@@ -47,15 +47,18 @@ function webpackReleaseInjectionPlugin(injectionCode: string): UnpluginOptions {
   };
 }
 
-function webpackComponentNameAnnotatePlugin(): UnpluginOptions {
+function webpackComponentNameAnnotatePlugin(
+  ignoredFiles?: string[],
+  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().transform,
+    transform: createComponentNameAnnotateHooks(ignoredFiles, ignoredComponents).transform,
   };
 }