refactor how we define and access the plugin name and version

Author: nsdeschenes

packages/astro-plugin/src/astro-bundle-analysis/__tests__/astroBundleAnalysisPlugin.test.ts

@@ -2,6 +2,11 @@ import { Output } from "@codecov/bundler-plugin-core";
 import { describe, it, expect } from "vitest";
 import { astroBundleAnalysisPlugin } from "../astroBundleAnalysisPlugin";
 
+// @ts-expect-error this value is being replaced by rollup
+const PLUGIN_NAME = __PACKAGE_NAME__ as string;
+// @ts-expect-error this value is being replaced by rollup
+const PLUGIN_VERSION = __PACKAGE_VERSION__ as string;
+
 describe("astroBundleAnalysisPlugin", () => {
   describe("when called", () => {
     it("returns a plugin object", () => {
@@ -16,6 +21,8 @@ describe("astroBundleAnalysisPlugin", () => {
           retryCount: 1,
           uploadToken: "test-token",
         }),
+        pluginName: PLUGIN_NAME,
+        pluginVersion: PLUGIN_VERSION,
       });
 
       expect(plugin).toMatchSnapshot();

packages/astro-plugin/src/astro-bundle-analysis/astroBundleAnalysisPlugin.ts

@@ -5,11 +5,6 @@ import {
 } from "@codecov/bundler-plugin-core";
 import { getBundleName } from "./getBundleName";
 
-// @ts-expect-error this value is being replaced by rollup
-const PLUGIN_NAME = __PACKAGE_NAME__ as string;
-// @ts-expect-error this value is being replaced by rollup
-const PLUGIN_VERSION = __PACKAGE_VERSION__ as string;
-
 interface AstroBundleAnalysisArgs extends BundleAnalysisUploadPluginArgs {
   target: "client" | "server";
 }
@@ -21,10 +16,12 @@ type AstroBundleAnalysisPlugin = (
 export const astroBundleAnalysisPlugin: AstroBundleAnalysisPlugin = ({
   output,
   target,
+  pluginName,
+  pluginVersion,
 }) => ({
   version: output.version,
-  name: PLUGIN_NAME,
-  pluginVersion: PLUGIN_VERSION,
+  name: pluginName,
+  pluginVersion,
   vite: {
     generateBundle(this, options) {
       // TODO - remove this once we hard fail on not having a bundle name
@@ -46,7 +43,7 @@ export const astroBundleAnalysisPlugin: AstroBundleAnalysisPlugin = ({
       output.lockBundleName();
 
       // manually set this to avoid resetting in the vite plugin
-      output.setPlugin(PLUGIN_NAME, PLUGIN_VERSION);
+      output.setPlugin(pluginName, pluginVersion);
     },
   },
 });

packages/astro-plugin/src/index.ts

@@ -12,8 +12,10 @@ import { type PluginOption } from "vite";
 
 import { astroBundleAnalysisPlugin } from "./astro-bundle-analysis/astroBundleAnalysisPlugin";
 
-// @ts-expect-error - This is a placeholder for the package name.
+// @ts-expect-error this value is being replaced by rollup
 const PLUGIN_NAME = __PACKAGE_NAME__ as string;
+// @ts-expect-error this value is being replaced by rollup
+const PLUGIN_VERSION = __PACKAGE_VERSION__ as string;
 
 interface AstroPluginFactoryOptions extends Options {
   // type can be found from the AstroIntegration type
@@ -41,8 +43,17 @@ const astroPluginFactory = createVitePlugin<AstroPluginFactoryOptions, true>(
     const options = normalizedOptions.options;
     if (options.enableBundleAnalysis) {
       plugins.push(
-        astroBundleAnalysisPlugin({ output, target }),
-        _internal_viteBundleAnalysisPlugin({ output }),
+        astroBundleAnalysisPlugin({
+          output,
+          target,
+          pluginName: PLUGIN_NAME,
+          pluginVersion: PLUGIN_VERSION,
+        }),
+        _internal_viteBundleAnalysisPlugin({
+          output,
+          pluginName: PLUGIN_NAME,
+          pluginVersion: PLUGIN_VERSION,
+        }),
       );
     }
 

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

@@ -51,6 +51,8 @@ export interface OutputPayload {
 
 export interface BundleAnalysisUploadPluginArgs {
   output: Output;
+  pluginName: string;
+  pluginVersion: string;
 }
 
 export interface ExtendedBAUploadArgs<TArgs extends object>

packages/nextjs-webpack-plugin/src/index.ts

@@ -15,6 +15,11 @@ import {
 
 import { nextJSWebpackBundleAnalysisPlugin } from "./nextjs-webpack-bundle-analysis/nextJSWebpackBundleAnalysisPlugin.ts";
 
+// @ts-expect-error this value is being replaced by rollup
+const PLUGIN_NAME = __PACKAGE_NAME__ as string;
+// @ts-expect-error this value is being replaced by rollup
+const PLUGIN_VERSION = __PACKAGE_VERSION__ as string;
+
 interface NextPluginOptions extends Options {
   webpack: typeof webpack | null;
 }
@@ -47,6 +52,8 @@ const codecovNextJSWebpackPluginFactory = createWebpackPlugin<
         options: {
           webpack: userOptions.webpack,
         },
+        pluginName: PLUGIN_NAME,
+        pluginVersion: PLUGIN_VERSION,
       }),
     );
   }

packages/nextjs-webpack-plugin/src/nextjs-webpack-bundle-analysis/__tests__/nextJSWebpackBundleAnalysisPlugin.test.ts

@@ -3,6 +3,11 @@ import { describe, it, expect } from "vitest";
 import * as webpack from "webpack";
 import { nextJSWebpackBundleAnalysisPlugin } from "../nextJSWebpackBundleAnalysisPlugin";
 
+// @ts-expect-error this value is being replaced by rollup
+const PLUGIN_NAME = __PACKAGE_NAME__ as string;
+// @ts-expect-error this value is being replaced by rollup
+const PLUGIN_VERSION = __PACKAGE_VERSION__ as string;
+
 describe("webpackBundleAnalysisPlugin", () => {
   describe("when called", () => {
     it("returns a plugin object", () => {
@@ -19,6 +24,8 @@ describe("webpackBundleAnalysisPlugin", () => {
         options: {
           webpack: webpack,
         },
+        pluginName: PLUGIN_NAME,
+        pluginVersion: PLUGIN_VERSION,
       });
 
       expect(plugin).toMatchSnapshot();

packages/nextjs-webpack-plugin/src/nextjs-webpack-bundle-analysis/nextJSWebpackBundleAnalysisPlugin.ts

@@ -7,20 +7,15 @@ import {
   _internal_processModules as processModules,
 } from "@codecov/webpack-plugin";
 
-// @ts-expect-error this value is being replaced by rollup
-const PLUGIN_NAME = __PACKAGE_NAME__ as string;
-// @ts-expect-error this value is being replaced by rollup
-const PLUGIN_VERSION = __PACKAGE_VERSION__ as string;
-
 export const nextJSWebpackBundleAnalysisPlugin: ExtendedBAUploadPlugin<{
   webpack: typeof webpack | null;
-}> = ({ output, options: { webpack } }) => ({
+}> = ({ output, pluginName, pluginVersion }) => ({
   version: output.version,
-  name: PLUGIN_NAME,
-  pluginVersion: PLUGIN_VERSION,
+  name: pluginName,
+  pluginVersion,
   buildStart: () => {
     output.start();
-    output.setPlugin(PLUGIN_NAME, PLUGIN_VERSION);
+    output.setPlugin(pluginName, pluginVersion);
   },
   buildEnd: () => {
     output.end();
@@ -29,7 +24,7 @@ export const nextJSWebpackBundleAnalysisPlugin: ExtendedBAUploadPlugin<{
     await output.write();
   },
   webpack(compiler) {
-    compiler.hooks.thisCompilation.tap(PLUGIN_NAME, (compilation) => {
+    compiler.hooks.thisCompilation.tap(pluginName, (compilation) => {
       if (!webpack) {
         red(
           "Unable to run bundle analysis, Webpack wasn't passed successfully.",
@@ -39,7 +34,7 @@ export const nextJSWebpackBundleAnalysisPlugin: ExtendedBAUploadPlugin<{
 
       compilation.hooks.processAssets.tapPromise(
         {
-          name: PLUGIN_NAME,
+          name: pluginName,
           stage: webpack.Compilation.PROCESS_ASSETS_STAGE_REPORT,
         },
         async () => {

packages/nuxt-plugin/src/index.ts

@@ -13,8 +13,10 @@ import { addVitePlugin, defineNuxtModule } from "@nuxt/kit";
 import { nuxtBundleAnalysisPlugin } from "./nuxt-bundle-analysis/nuxtBundleAnalysisPlugin";
 import { type NuxtModule } from "nuxt/schema";
 
-// @ts-expect-error - This is a placeholder for the package name.
+// @ts-expect-error this value is being replaced by rollup
 const PLUGIN_NAME = __PACKAGE_NAME__ as string;
+// @ts-expect-error this value is being replaced by rollup
+const PLUGIN_VERSION = __PACKAGE_VERSION__ as string;
 
 const codecovNuxtPluginFactory = createVitePlugin<Options, true>(
   (userOptions, unpluginMetaContext) => {
@@ -37,8 +39,16 @@ const codecovNuxtPluginFactory = createVitePlugin<Options, true>(
     const options = normalizedOptions.options;
     if (options.enableBundleAnalysis) {
       plugins.push(
-        nuxtBundleAnalysisPlugin({ output }),
-        _internal_viteBundleAnalysisPlugin({ output }),
+        nuxtBundleAnalysisPlugin({
+          output,
+          pluginName: PLUGIN_NAME,
+          pluginVersion: PLUGIN_VERSION,
+        }),
+        _internal_viteBundleAnalysisPlugin({
+          output,
+          pluginName: PLUGIN_NAME,
+          pluginVersion: PLUGIN_VERSION,
+        }),
       );
     }
 

packages/nuxt-plugin/src/nuxt-bundle-analysis/__tests__/nuxtBundleAnalysisPlugin.test.ts

@@ -2,6 +2,11 @@ import { Output } from "@codecov/bundler-plugin-core";
 import { describe, it, expect } from "vitest";
 import { nuxtBundleAnalysisPlugin } from "../nuxtBundleAnalysisPlugin";
 
+// @ts-expect-error this value is being replaced by rollup
+const PLUGIN_NAME = __PACKAGE_NAME__ as string;
+// @ts-expect-error this value is being replaced by rollup
+const PLUGIN_VERSION = __PACKAGE_VERSION__ as string;
+
 describe("nuxtBundleAnalysisPlugin", () => {
   describe("when called", () => {
     it("returns a plugin object", () => {
@@ -15,6 +20,8 @@ describe("nuxtBundleAnalysisPlugin", () => {
           retryCount: 1,
           uploadToken: "test-token",
         }),
+        pluginName: PLUGIN_NAME,
+        pluginVersion: PLUGIN_VERSION,
       });
 
       expect(plugin).toMatchSnapshot();

packages/nuxt-plugin/src/nuxt-bundle-analysis/nuxtBundleAnalysisPlugin.ts

@@ -4,17 +4,14 @@ import {
 } from "@codecov/bundler-plugin-core";
 import { getBundleName } from "./getBundleName";
 
-// @ts-expect-error this value is being replaced by rollup
-const PLUGIN_NAME = __PACKAGE_NAME__ as string;
-// @ts-expect-error this value is being replaced by rollup
-const PLUGIN_VERSION = __PACKAGE_VERSION__ as string;
-
 export const nuxtBundleAnalysisPlugin: BundleAnalysisUploadPlugin = ({
   output,
+  pluginName,
+  pluginVersion,
 }) => ({
   version: output.version,
-  name: PLUGIN_NAME,
-  pluginVersion: PLUGIN_VERSION,
+  name: pluginName,
+  pluginVersion,
   vite: {
     generateBundle(this, options) {
       // TODO - remove this once we hard fail on not having a bundle name
@@ -36,7 +33,7 @@ export const nuxtBundleAnalysisPlugin: BundleAnalysisUploadPlugin = ({
       output.lockBundleName();
 
       // manually set this to avoid resetting in the vite plugin
-      output.setPlugin(PLUGIN_NAME, PLUGIN_VERSION);
+      output.setPlugin(pluginName, pluginVersion);
     },
   },
 });