Move the vite plugin over to unplugin using the bundler core (#4)

Move vite plugin to use the bundler core package as it's base.

Author: nsdeschenes

bundlers/vite/src/App.tsx

@@ -1,10 +1,13 @@
-import { useState } from 'react'
-import reactLogo from './assets/react.svg'
-import viteLogo from '/vite.svg'
-import './App.css'
+import { useState, lazy, Suspense } from "react";
+import reactLogo from "./assets/react.svg";
+import viteLogo from "/vite.svg";
+import "./App.css";
+
+const IndexedLazyComponent = lazy(() => import("./IndexedLazyComponent"));
+const LazyComponent = lazy(() => import("./LazyComponent/LazyComponent"));
 
 function App() {
-  const [count, setCount] = useState(0)
+  const [count, setCount] = useState(0);
 
   return (
     <>
@@ -28,8 +31,14 @@ function App() {
       <p className="read-the-docs">
         Click on the Vite and React logos to learn more
       </p>
+      <Suspense fallback={null}>
+        <IndexedLazyComponent />
+      </Suspense>
+      <Suspense fallback={null}>
+        <LazyComponent />
+      </Suspense>
     </>
-  )
+  );
 }
 
-export default App
+export default App;

bundlers/vite/src/IndexedLazyComponent/IndexedLazyComponent.tsx

@@ -0,0 +1,7 @@
+export default function IndexedLazyComponent() {
+  return (
+    <div>
+      <h1>Indexed Lazy Component</h1>
+    </div>
+  );
+}

bundlers/vite/src/IndexedLazyComponent/index.ts

@@ -0,0 +1 @@
+export { default } from "./IndexedLazyComponent";

bundlers/vite/src/LazyComponent/LazyComponent.tsx

@@ -0,0 +1,14 @@
+import { lazy, Suspense } from "react";
+
+const IndexedLazyComponent = lazy(() => import("../IndexedLazyComponent"));
+
+export default function LazyComponent() {
+  return (
+    <div>
+      <h1>Lazy Component</h1>
+      <Suspense fallback={null}>
+        <IndexedLazyComponent />
+      </Suspense>
+    </div>
+  );
+}

bundlers/vite/vite.config.ts

@@ -1,8 +1,8 @@
 import { defineConfig } from "vite";
 import react from "@vitejs/plugin-react";
-import { viteStatsPlugin } from "@codecov/vite-plugin";
+import { codecovVitePlugin } from "@codecov/vite-plugin";
 
 // https://vitejs.dev/config/
 export default defineConfig({
-  plugins: [react(), viteStatsPlugin()],
+  plugins: [react(), codecovVitePlugin({ enableBundleAnalysis: true })],
 });

packages/bundler-plugin-core/package.json

@@ -22,7 +22,7 @@
     "dist"
   ],
   "scripts": {
-    "typecheck": "tsc",
+    "type-check": "tsc --noEmit",
     "build": "unbuild",
     "dev": "unbuild --stub && node --watch-path=src dist/index.mjs",
     "clean": "rm -rf dist .turbo node_modules",
@@ -35,13 +35,17 @@
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
-    "unplugin": "^1.5.0"
+    "unplugin": "^1.5.0",
+    "zod": "^3.22.4"
   },
   "devDependencies": {
     "@types/node": "^20.8.6",
     "typescript": "^5.0.4",
     "unbuild": "^2.0.0"
   },
+  "peerDependencies": {
+    "zod": "^3.22.4"
+  },
   "volta": {
     "extends": "../../package.json"
   },

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

@@ -1,7 +1,64 @@
-import { createUnplugin } from "unplugin";
+import { type UnpluginOptions, createUnplugin } from "unplugin";
+import {
+  type BundleAnalysisUploadPlugin,
+  type Asset,
+  type Chunk,
+  type Module,
+  type Options,
+  type Output,
+} from "./types.js";
 
-export const unplugin = createUnplugin((_options) => {
-  return {
-    name: "unplugin-stats",
-  };
-});
+import { jsonSchema } from "./schemas.js";
+import { z } from "zod";
+interface CodecovUnpluginFactoryOptions {
+  bundleAnalysisUploadPlugin: BundleAnalysisUploadPlugin;
+}
+
+export function codecovUnpluginFactory({
+  bundleAnalysisUploadPlugin,
+}: CodecovUnpluginFactoryOptions) {
+  return createUnplugin<Options, true>((userOptions, _unpluginMetaContext) => {
+    const plugins: UnpluginOptions[] = [];
+
+    if (userOptions?.enableBundleAnalysis) {
+      const statsFileName = z
+        .string()
+        .endsWith(".json")
+        .optional()
+        .parse(userOptions?.statsFileName);
+
+      const output: Output = {
+        version: "1",
+      };
+
+      let startTime = NaN;
+      const { pluginVersion, version, ...pluginOpts } =
+        bundleAnalysisUploadPlugin({
+          output,
+          statsFileName,
+        });
+
+      plugins.push({
+        ...pluginOpts,
+        buildStart() {
+          startTime = Date.now();
+          output.version = version;
+          output.plugin = {
+            name: pluginOpts.name,
+            version: pluginVersion,
+          };
+          output.builtAt = startTime;
+        },
+        buildEnd(this) {
+          const duration = Date.now() - startTime;
+          output.duration = duration;
+        },
+      });
+    }
+
+    return plugins;
+  });
+}
+
+export type { BundleAnalysisUploadPlugin, Asset, Chunk, Module, Options };
+export { jsonSchema };

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

@@ -0,0 +1,11 @@
+import { z } from "zod";
+
+const literalSchema = z.union([z.string(), z.number(), z.boolean(), z.null()]);
+
+type Literal = z.infer<typeof literalSchema>;
+
+type Json = Literal | { [key: string]: Json } | Json[];
+
+export const jsonSchema: z.ZodType<Json> = z.lazy(() =>
+  z.union([literalSchema, z.array(jsonSchema), z.record(jsonSchema)]),
+);

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

@@ -0,0 +1,64 @@
+import { type UnpluginOptions } from "unplugin";
+
+export interface Dependency {
+  name: string;
+  version: string;
+}
+
+export interface Asset {
+  name: string;
+  size: number;
+  fileName?: string;
+}
+
+export interface Chunk {
+  id: string;
+  preliminaryFileName: string;
+  entry: boolean;
+  initial: boolean;
+  files: string[];
+  names: string[];
+}
+
+export interface Module {
+  name: string;
+  size?: number;
+  chunks: (string | number)[];
+  chunkPreliminaryFileNames: string[];
+}
+
+export interface Output {
+  version?: string;
+  bundler?: {
+    name: string;
+    version: string;
+  };
+  outputPath?: string;
+  builtAt?: number;
+  duration?: number;
+  assets?: Asset[];
+  chunks?: Chunk[];
+  modules?: Module[];
+  plugin?: {
+    name: string;
+    version: string;
+  };
+}
+
+export interface BundleAnalysisUploadPluginArgs {
+  output: Output;
+  statsFileName?: string;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface Options {
+  statsFileName?: string;
+  enableBundleAnalysis?: boolean;
+}
+
+export type BundleAnalysisUploadPlugin = (
+  args: BundleAnalysisUploadPluginArgs,
+) => UnpluginOptions & {
+  pluginVersion: string;
+  version: string;
+};

packages/vite-plugin/package.json

@@ -22,7 +22,7 @@
     "dist"
   ],
   "scripts": {
-    "typecheck": "tsc",
+    "type-check": "tsc --noEmit",
     "build": "unbuild",
     "dev": "unbuild --stub && node --watch-path=src dist/index.mjs",
     "clean": "rm -rf dist .turbo node_modules",
@@ -45,5 +45,9 @@
   },
   "engines": {
     "node": ">=20.0.0"
+  },
+  "dependencies": {
+    "@codecov/bundler-plugin-core": "workspace:^",
+    "unplugin": "^1.5.0"
   }
 }