feat: Add BA support for SvelteKit #126

nicholas-codecov · 2024-05-01T12:47:26Z

Description

This PR adds in direct support for SvelteKit apps through the introduction of a new plugin that is tailored for SvelteKit.

Closes #94

Code Example

// vite.config.ts
import { sveltekit } from "@sveltejs/kit/vite";
import { defineConfig } from "vite";
import { codecovSvelteKitPlugin } from "@codecov/sveltekit-plugin";

export default defineConfig({
  plugins: [
    sveltekit(),
    // Put the Codecov SvelteKit plugin after all other plugins
    codecovSvelteKitPlugin({
      enableBundleAnalysis: true,
      bundleName: "example-sveltekit-bundle",
      uploadToken: process.env.CODECOV_TOKEN,
    }),
  ],
});

Notable Changes

Add in new @codecov/sveltekit-plugin
Add in example SvelteKit app
Add in integration tests for new plugin
Small tweaks

codecov · 2024-05-01T12:49:38Z

Codecov Report

Attention: Patch coverage is 28.85906% with 106 lines in your changes are missing coverage. Please review.

Project coverage is 77.88%. Comparing base (ddcd055) to head (72b56fd).

✅ All tests successful. No failed tests found.

Files	Patch %	Lines
packages/sveltekit-plugin/src/index.ts	0.00%	72 Missing and 1 partial ⚠️
...t-bundle-analysis/sveltekitBundleAnalysisPlugin.ts	50.00%	21 Missing ⚠️
packages/rollup-plugin/src/index.ts	0.00%	4 Missing ⚠️
packages/vite-plugin/src/index.ts	0.00%	4 Missing ⚠️
packages/webpack-plugin/src/index.ts	0.00%	4 Missing ⚠️

Additional details and impacted files

Components	Coverage Δ
Plugin core	`97.87% <ø> (ø)`
Rollup plugin	`10.44% <0.00%> (-0.12%)`	⬇️
Vite plugin	`10.60% <0.00%> (-0.13%)`	⬇️
Webpack plugin	`26.20% <0.00%> (-0.24%)`	⬇️

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

codecov · 2024-05-01T13:17:02Z

Bundle Report

Changes will decrease total bundle size by 27.8kB ⬇️

Bundle name	Size	Change
@codecov/example-next-app-client-array-push	894.72kB	446 bytes ⬆️
@codecov/sveltekit-plugin-cjs	1.3kB	1.3kB ⬆️
@codecov/example-rollup-app-iife	95.45kB	0 bytes
@codecov/sveltekit-plugin-esm	909 bytes	909 bytes ⬆️
@codecov/bundler-plugin-core-cjs	41.95kB	0 bytes
@codecov/nuxt-plugin-cjs	1.38kB	0 bytes
@codecov/nuxt-plugin-esm	855 bytes	0 bytes
@codecov/bundler-plugin-core-esm	6.56kB	31.05kB ⬇️
@codecov/rollup-plugin-cjs	2.93kB	0 bytes
@codecov/vite-plugin-cjs	2.92kB	0 bytes
@codecov/webpack-plugin-cjs	3.56kB	0 bytes
@codecov/rollup-plugin-esm	1.32kB	155 bytes ⬆️
@codecov/vite-plugin-esm	1.26kB	153 bytes ⬆️
@codecov/webpack-plugin-esm	1.44kB	156 bytes ⬆️
@codecov/example-vite-app-esm	150.61kB	0 bytes
@codecov/example-webpack-app-array-push	71.19kB	0 bytes
@codecov/example-next-app-server-cjs	325.72kB	131 bytes ⬆️
@codecov/example-next-app-edge-server-array-push	306 bytes	0 bytes

codecov-staging · 2024-05-01T13:17:04Z

Bundle Report

Changes will decrease total bundle size by 210.88kB ⬇️

Bundle name	Size	Change
@codecov/rollup-plugin-cjs	2.93kB	0 bytes
@codecov/rollup-plugin-esm	1.32kB	155 bytes ⬆️
@codecov/bundler-plugin-core-esm	37.6kB	31.05kB ⬆️
@codecov/webpack-plugin-cjs	3.56kB	3.56kB ⬆️
@codecov/example-next-app-client-array-push	894.72kB	446 bytes ⬆️
@codecov/example-webpack-app-array-push	71.19kB	0 bytes
@codecov/nuxt-plugin-esm	855 bytes	0 bytes
@codecov/vite-plugin-cjs	2.92kB	0 bytes
@codecov/webpack-plugin-esm	1.44kB	156 bytes ⬆️
@codecov/sveltekit-plugin-esm	909 bytes	909 bytes ⬆️
@codecov/vite-plugin-esm	1.26kB	153 bytes ⬆️
@codecov/bundler-plugin-core-cjs	41.95kB	0 bytes
@codecov/example-next-app-server-cjs	325.72kB	131 bytes ⬆️
@codecov/example-next-app-edge-server-array-push	306 bytes	0 bytes
@codecov/example-rollup-app-iife	(removed)	95.45kB ⬇️
@codecov/example-vite-app-esm	(removed)	150.61kB ⬇️
@codecov/nuxt-plugin-cjs	(removed)	1.38kB ⬇️

…erence

AbhiPrasad · 2024-05-22T14:46:00Z

packages/sveltekit-plugin/src/sveltekit-bundle-analysis/getBundleName.ts

+    bundleName = `${bundleName}-${dir}`;
+  }
+
+  format = format === "es" ? "esm" : format;


l: let's avoid rebinding passed in parameters.

Done, both here and in the Nuxt plugin 🫡

AbhiPrasad · 2024-05-23T11:33:24Z

packages/webpack-plugin/LICENSE

@@ -1,6 +1,6 @@
 MIT License

-Copyright (c) 2023 Codecov
+Copyright (c) 2024 Codecov


you actually want to use a date range here (2023-2024) if you update to latest year.

Ouu ty ty for the catch

AbhiPrasad · 2024-05-23T11:35:38Z

packages/sveltekit-plugin/src/sveltekit-bundle-analysis/sveltekitBundleAnalysisPlugin.ts

+import { getBundleName } from "./getBundleName";
+
+// @ts-expect-error this value is being replaced by rollup
+const PLUGIN_NAME = __PACKAGE_NAME__ as string;


Let's define

declare global { __PACKAGE_NAME__: string; __PACKAGE_VERSION__: string; }

in a TS declaration file somewhere so we can remove these. Feel free to do it in a follow up PR.

AbhiPrasad · 2024-05-23T11:41:49Z

packages/sveltekit-plugin/src/sveltekit-bundle-analysis/getBundleName.ts

+export function getBundleName(
+  initialName = "",
+  initialDir = "",
+  format: string,


nit: this can be typed as ModuleFormat from rollup. Same as other places that use this.

Would it be alright to re-export this type from the Vite bundler plugin package? And then import and use it in here.

yeah that's fine!

Hrrm it actually doesn't seem like Vite re-exports these types, soooo I'd have to install Rollup as a dev dep eh?

Can you grab the type from UnpluginOptions? Otherwise don't worry too much, we can leave it as is.

Checked the options ... and no dice with that.

codecov-notifications · 2024-05-23T13:06:58Z

Codecov Report

Attention: Patch coverage is 28.85906% with 106 lines in your changes are missing coverage. Please review.

✅ All tests successful. No failed tests found.

Files	Patch %	Lines
packages/sveltekit-plugin/src/index.ts	0.00%	72 Missing and 1 partial ⚠️
...t-bundle-analysis/sveltekitBundleAnalysisPlugin.ts	50.00%	21 Missing ⚠️
packages/rollup-plugin/src/index.ts	0.00%	4 Missing ⚠️
packages/vite-plugin/src/index.ts	0.00%	4 Missing ⚠️
packages/webpack-plugin/src/index.ts	0.00%	4 Missing ⚠️

Components	Coverage Δ
Plugin core	`97.87% <ø> (ø)`
Rollup plugin	`10.44% <0.00%> (-0.12%)`	⬇️
Vite plugin	`10.60% <0.00%> (-0.13%)`	⬇️
Webpack plugin	`26.20% <0.00%> (-0.24%)`	⬇️

📢 Thoughts on this report? Let us know!

This reverts commit ea60f47.

nicholas-codecov added 11 commits April 30, 2024 15:24

add in example sveltekit app

682c49d

add in example sveltekit app for integration tests

92020d3

add in new sveltekit plugin

fcb8955

add in changeset

6e8de77

slight tweak to gen config util

67a85bb

add in integration tests for sveltekit

161162b

update eslint config

6426fce

updates to the lock file

faeab27

bump license version

5cee458

mark internal unpligin plugins as internal and remove from typedocs

7278541

update CI pipeline

0382ce5

nicholas-codecov added 2 commits May 1, 2024 09:56

small tweak to sveltekit integration tests

9c538d3

run e2e tests individually for each plugin

d9648da

remove running integration tests by plugin, not noticable enough diff…

74f9c25

…erence

AbhiPrasad self-requested a review May 22, 2024 14:44

AbhiPrasad approved these changes May 23, 2024

View reviewed changes

nicholas-codecov added 2 commits May 23, 2024 09:10

correct license year

348a53e

fix up type in getBundleName functions

ea60f47

nicholas-codecov added 2 commits May 23, 2024 10:10

Revert "fix up type in getBundleName functions"

2db45c9

This reverts commit ea60f47.

Merge branch 'main' into gh-cjbp-94-add-support-for-svelte-kit

08e515d

AbhiPrasad approved these changes May 23, 2024

View reviewed changes

nicholas-codecov added 2 commits May 23, 2024 10:32

resolve updates that happened before merging the sveltekit plugin

0e5855f

bump pnpm version in CI to 9

72b56fd

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add BA support for SvelteKit #126

feat: Add BA support for SvelteKit #126

nicholas-codecov commented May 1, 2024

codecov bot commented May 1, 2024 •

edited

codecov bot commented May 1, 2024 •

edited

codecov-staging bot commented May 1, 2024 •

edited

AbhiPrasad May 22, 2024

nicholas-codecov May 23, 2024

AbhiPrasad May 23, 2024

nicholas-codecov May 23, 2024

AbhiPrasad May 23, 2024

AbhiPrasad May 23, 2024

nicholas-codecov May 23, 2024 •

edited

AbhiPrasad May 23, 2024

nicholas-codecov May 23, 2024

AbhiPrasad May 23, 2024

nicholas-codecov May 23, 2024

codecov-notifications bot commented May 23, 2024 •

edited

feat: Add BA support for SvelteKit #126

Are you sure you want to change the base?

feat: Add BA support for SvelteKit #126

Conversation

nicholas-codecov commented May 1, 2024

Description

Code Example

Notable Changes

codecov bot commented May 1, 2024 • edited

Codecov Report

codecov bot commented May 1, 2024 • edited

Bundle Report

codecov-staging bot commented May 1, 2024 • edited

Bundle Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicholas-codecov May 23, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-notifications bot commented May 23, 2024 • edited

Codecov Report

codecov bot commented May 1, 2024 •

edited

codecov bot commented May 1, 2024 •

edited

codecov-staging bot commented May 1, 2024 •

edited

nicholas-codecov May 23, 2024 •

edited

codecov-notifications bot commented May 23, 2024 •

edited