diff --git a/assets/navigation.js b/assets/navigation.js index a7a09538..138b9fa6 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52TTU/DIBjHvwvnVROjO+zkxZOHGRf1sJiGwVNLSqGhUBeN393S4da1SFnTI/+X5wd9tt9Iw16jFbonkgKRDVogkjNOFQi02h6Pd0ZQDiqpuPlgIiFSQaussM7bw1JSw6G+Tl1G6tTpQZ1a9VWuS95aCiYoWt34W9aVZlLUp2QmNKgMk6lwZxyU3C1/Fsfsl4pLTNcNKMUozOgYBIS6cmztD0pJ1SvKjCDdmBMX1TOflyxvex1CqhJz9gWjS4vsGQaMut77bWav3eMH3t2qXEfUe1PIsOE6OHo/0+mDkyoo2T5pmIbpeTttarWXTO3cz9b82nqfBjUeiHGRPyRMJjk3VQRVp5tD1BljcM4aPO4gRy05o7XGKuKPOmln8GyseWPNEUzjpn9SwmwNcA0Fi0H7k84h67yPLAps2OPPCGLFrdPMRYrcIc/2RC7OJ+wqTIppACecwfB2cEZgDDp8fg9M+/0Cu9HOaKwHAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52UwU+DMBjF/xfOQxOjO+zkxYsmzrioh8WQrv026kpLSsFF4/9uYXVj0JVPwoEQ3nu/PujX5XdkYGeiWXRLFQOqqmgS0ZQLpkFGs+Xh9aqUTICOc1FuuIyp0mCVOTGpfZkpVgooLhOXkTh1slcntfoiNZmwli2XLJpd+Snz3HAli2Mylwb0mtChcGfsQG6mP5ND9ksuFGHzCrTmDEYwOgEhVkpq+53WSrdA61LSZpkDH6plPoVMr1sMqXRGBP+C3kdDcroBPdZ7m2ZvH0X8Cauc0K3bBoEdsNcnTu+4qD3gEh7t0/3ibe9/6uA8Df3A82HhtuXOIDpa1X+aMViTUphwjVam0wdXqiHju7jiBobX22iTWjvifzzX5lfrRfyLPsgfEm6mhChzRKtGN6ZRY8TUOSF43MEehRKcFYZoxI46akf0WdTmRW1GdOqTzqSEu1UgDGw5ptqfdEyzxvvAUcW6HH9GsBZunEYOEnKGPNODHBz0GT3+cMYfy/7zeOgkttcvWYisepoIAAA=" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index 1ff0df79..46e2a7f4 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VZTXOjOBD9L+RKHEsytvFpP2oOW1u1szWzM3tIpVzEKBMqGCgBmWRd/u8rgTDdWDLExkfsfk/d70ktCXaOSH/mzup+57xESeisqOskwZY7K+eXTRryTfp691gmYczFbRaXP6LkdpMK7rhOKWIZtE3DMub53VoHr3Xwug5eq+DJc7GNJWITB3nO5WCOs3cP43nzw4ifsyJKk/xAHiUFF0/Bpo9f4wzjuE4WCJ4UfeW0+ZApnR0SCrLom4gvyufmwPHxtBoiW3o15C/1cFGKiGf8NEP+WP64LMOG4grJifcvZXJhdg3H+OnxJHiM+W8V8NckiN/z6LL1cWNhHD91wQvx/ntaSqKLEkY846dZZnEahJ9fuRBRyC8U95jsWgn/k77wC6ctJholUdjNv10obAc/fnd/FEGyeR4lr5sD1xkydoWydvsoDkfKVlNdL9lNulV8X5+DcTJGfNdLOxPjpFvxXC/NfCxZ8yvrmcdn7PzmTONzDwD2VOdtos+BAn4SIhVtp3oqk03V4XqOtwA7Speaex5r++h6Xbxn/OKkbtAvB9IzBMXUUDjrdE3LOPz0FhVXqWKC+McsqJHJOGWSVGyDOPqPd68tA2vr4keZOobrW1K+FTrafm1TQTq7k9e1OTzWPwVlfNJSyKrDB1YJkz5ZneDb6O32NSp4b41V6FqFfrBSTfBF4b9L+N94IEPhx0OZOQaqcVzkaU3SOC6zfj2qsDO1qLADhEBjGMBDFUAlnaw+T+MozItA9M/6NvQ8Fb4q/FeF71fieCwLyUBFjss8rcorjwv+Eg0QpYk8U5MK/mc0RJLuSGaKoYJ0Kzypx6COcX6vGNYmDA3iw71hcFf4yR+zYPPSW7SOO6/uf2twf+mdUUzwgQJ06to/uPKkGfI3Z7Vz5KEvl+PKcDphE1/inyIeh+qFZ524q24qW8X4oP/7zjeFOsus7uuQu6nj3k9dOp14slzi+hM2c6l+fnhw7xuGKrD6oYIR+cRcNpv4no/CCAqj8mlmCqMojMknzxTGUNhMPs1NYTMU5smnhSnMQ2Fz+bQ0hc1R2EI++aawBQpbyicihVQCorAlCvNVGDHR+VjfqY2PdIxQghNqtAJ7QZTmxGwatoMo2YnRN4IdIUp5YrSOYFOIEp8Y3SPYF6L0J0YDCbaGKAuI0UOC3SGVPUYbCTaIKB/o1BiJLaLKCGr0kmKPaOWRS8hkMSculcvLmyx9D0M6C0c5Qo1mUWwWrczSC3fWrGTqmdYwxe5RZRE1ekKxe9RDFSyMFWAbqfKKGs2h2Ea6QOS+kRz7SZVpzOgSxX5SH5IzYiTHxjLlHjMuKYaNZchYxkzkDBvLlHvMuLZYpykyRO4ZybGhTLnGjIay2tBq+5D7RsHDP+ptRG4EzXV556z13iKXit76do5cIKvdft/uJepJUQdZpDZAAJu1KGoBNa8SwVgUjEVssPqdHkAxgLIOVt0m662whXotklmAnesoRE9b9LQHra55EEpBpdRWKboVITRUty/x+kaB4AsA93rg7fEbUYBZIRdkD0VzYIUMcv21DH4Pgzr7ITCwnPXJp89NCA+N7xGwUl8l0JwngQpzUMOsh6aywcCxBBzz0xytF8c8DMxGalunDU9jiIEGTEzWM6vNojAwOZltOWoGbY2BBCjL7MpW78qrd7ugHYDxid1bgSYU7V/K+tNsiwEp2jI8vDoCI4GpS23yhOJdlEgQsGRtK7b+4Fn3qeDwwbOlABPNNs/qd4Jcvx0GmgIssS33w3u+tHlPCKqGq92msAEHW7sFdTx5SMdMV7dYVzdLV3c9V7cuVzcgV/cS194TMrQBENBGiG0OVJ91N/Vn3RYK+qdNz+68BvON2OZA/YaYv+FeS0FvILZeW394AOOBKUdsE6b+tJq23z4BHgy6rGUlNudrmqL+QgsogJO2tLtbA/X69kZ58MmijMdRIoPuH/b7/wE4KKUoHCQAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7Va23LbNhD9F/qVVgSAkiw/NU0zbdqZpBM36YPHo6FE2GZNkRxeHDse/3sBXsRdaiHSIvViD+3dg91zFgsQxIuVRD9S6/L6xXrwQ8+65LYVultpXVq/bCJPbqLHd+s89AKZnMdBfueH55sokZZt5UmgjLaRlwcyfbeqjFeV8ao0XmnjyX22DZTHJnDTVKrBLOvV3o03m+9G/BJnfhSmO3A/zGRy62668Cs/Yhzbit1EhllXOk08bMqdXUBu7H9LgkHxnO0w3h5WDWQKr3T5rB8GhYhwxg/Tk+v8bliENcQJgkuev+bhwOhqjPHDk6G7DuSvheP70A2eU3/Y/DgzII4f+p2fXcnk0d8MrE6EM36Yke9thgVYIYwS2nw2E01DXK2y53ggfTq6yQ7o+CAnRZpmrf/I118+/fbhn+hBhu9zz5fhUOFB5BPzAAMzqqkxJJan8vfd0OOl04Y9bRKJzJLnD1GuQAdlgHDGn4l5HESu9+VRJonvyYFtbh/sVAEXBTlGsDXQKIHCfdW3gcS2/MffZ60TN9zcjxLX2Q7rCBrbRBn3XX7gjRRtBXW6YDfRVuNd3bvjRIzwThd2nIwTboFzujDTsWhNT8xnGhyxB6cjDY7diptDnTeB3rva8WOSREnTqW7zcFN0uI4XTeA7Spc6uB07Nqgz9JchWzMMDYkzlmuUB97HJz87SRYThD9mQvs7HFAyYZRs3cD/KdsHCD1za/uPUjrEQUoon7L/0vMfch27m4fKz3yUUpqvKvMq4oOHKXPY9guQzwrjz6t/S4i/8YAEO/SQZqyeTNGJH+Yqf8q6GVJGb+TFk7duHhwsf4hamffNEwR9MLtEbv2n80c/k505FqYrbXpcBXzV/t+Ve7f6+0PRGD3Z2E/yMCdREORxNx+F2ZFcFL49iEBjEM59GUApHcw+jQLfSzM36a76xvQ4Fq60/5X272ZifywDSE9G9tM8zMqjDDL54PcgpbY8kpPC/S+/DyXtkWiIvoS0MzzIR6+OcXyv6NcmiAbx5t7Quyv0XSwHrZK910d6YTxmSWyvhTe22pV78sm6fLHUBjlV4ypzPhGTpfK/9WXg6c80ZeC2fqvbasSb6n/f5SbT+77L69Lk3dSyr6c2Z5MFc2xmLyeLhc2r55sb+7pGKAyLPxRuTD0JW8wnSyaQGUNmXD05lBlHZkI9zSgzgcwc9TSnzBxkNlNPC8pshszm6umCMpsjs4V6WlJmC2R2oZ7YlLK7QHZLbcdswSZ8iQleYoI134yTFLek0JQzWgysBtOsM1IPhgVhmng2o8JkWBOmuWekKgzLwmZmTKwM0wowUkKGxWFaBEaqyLA+rBCIFJJhhZgWgpNSMqwR10JwRtY31ohrITipJm/NGC0EJ9XkWCMujKXEsUZcC8HpeYg14loITk5FjjXihUZVv5jXDYQvqNbBsWhcK8NJ0TgWjRei2Uy1t6mw+VLhT4TTcsHqcS2RINXjWD0xbTIQrM5AkM1PYDlF0f5IkQSWU3CYgXCoDESrGWrxBN0Osa7CQeBzEhwLLLSKgpxaAgss5gj8ggTHwgqtniDnmMDCCiSsMyXBsbBCq+eQk01gYZ0pAucUuIMFdbRqDimoUwparLtqwc2k96lcf9UKWp/JvFiralFW87HaM7xYS/Xj1bbUZFS/X5u1WD/pEdzY1xsI4O00ztzgVB9bgyEXjZdqjwa38vwYeF0Ar4XRS59clFuJxnXWeJpSax19QO9p4z3t8C6PA6AznwOGTLnCt2zkvATOFx3OxUsp9BZAWdEVeflCh9yBtsIk7v7bD4IAyatp3QFRvy8gBCC66KJPb71RcQLlRBd91bYV+fPG3+kgsFS+Aqm39EBJkAc3FW8FVQipc9mHUR28yYh1wBSKEhhwNnRMh0ZWAgfMYtWJD+PU2hIwoMZFBzM0KQ6s8+VhBKNADmDWMTNbfCEqvmiAxgQyYOYyS1Bt8u6mUl0NanzAbDJNpt0hICAYzAJuosdLnpMcEQLUNYlbXrgpO6a7u3DTQICaN03dOz+7z9f6S3+mvxG7u9sPgF5AFTNxpXDS+ipN4wqEMVVWeRQvq48yQB9QD9zU/XbH61F9PA8AwDTjJgbLCzYgV6CVqZKIsUCsptLdr3jWqkC7Wp/saqmxq0XDrrq/XbVwu2rEdtVTbXNvjNE6ykFyzFSIxU2MTXkTA8QK1iJmUqM1LTlIkJsiLD/ryCe86nC4rTFNtfJrIXACdcpNMpT3IaLmwgLIERQMEyWzzFQ4JU5W3qsAGKBFMFPgeSqbaYe8YR2ZMmgvsgKkbdxlEIsrBw2G3hipDWzsxzLwQ2V0ffP6+j8/Y8Ya0ysAAA=="; \ No newline at end of file diff --git a/functions/_codecov_bundler_plugin_core.handleErrors.html b/functions/_codecov_bundler_plugin_core.handleErrors.html index 506a36d3..094cfd3c 100644 --- a/functions/_codecov_bundler_plugin_core.handleErrors.html +++ b/functions/_codecov_bundler_plugin_core.handleErrors.html @@ -1,4 +1,4 @@ handleErrors | Codecov JavaScript Bundler Plugins

Function handleErrors

  • handleErrors(options): {
        shouldExit: boolean;
    }

  • This function logs the errors to the console, and will return shouldExit if there are errors that we should exit the build process for.

    Parameters

    • options: NormalizedOptionsFailure

      The normalized options that failed validation.

      -

    Returns {
        shouldExit: boolean;
    }

    • shouldExit: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns {
    shouldExit: boolean;
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_codecov_bundler_plugin_core.normalizeOptions.html b/functions/_codecov_bundler_plugin_core.normalizeOptions.html index 019a2f20..a94bf1ac 100644 --- a/functions/_codecov_bundler_plugin_core.normalizeOptions.html +++ b/functions/_codecov_bundler_plugin_core.normalizeOptions.html @@ -1,4 +1,4 @@ normalizeOptions | Codecov JavaScript Bundler Plugins

Function normalizeOptions

  • normalizeOptions(userOptions): NormalizedOptionsResult

  • This function is used to normalize the options provided by the user. Validating the options passed by the user, and providing default values for a given set of options if none were provided.

    -

    Parameters

    Returns NormalizedOptionsResult

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns NormalizedOptionsResult

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_codecov_nextjs_webpack_plugin.codecovNextJSWebpackPlugin.html b/functions/_codecov_nextjs_webpack_plugin.codecovNextJSWebpackPlugin.html new file mode 100644 index 00000000..35c2f3ed --- /dev/null +++ b/functions/_codecov_nextjs_webpack_plugin.codecovNextJSWebpackPlugin.html @@ -0,0 +1,5 @@ +codecovNextJSWebpackPlugin | Codecov JavaScript Bundler Plugins

Function codecovNextJSWebpackPlugin

  • codecovNextJSWebpackPlugin(options): WebpackPluginInstance

  • Details for the Codecov NextJS (Webpack) plugin.

    +

    Parameters

    • options: NextPluginOptions

    Returns WebpackPluginInstance

    Example

    // next.config.mjs
    import { codecovNextJSWebpackPlugin } from "@codecov/nextjs-webpack-plugin";

    export default {
      webpack: (config, options) => {
        config.plugins.push(
          codecovNextJSWebpackPlugin({
            enableBundleAnalysis: true,
            bundleName: "example-nextjs-webpack-bundle",
            uploadToken: process.env.CODECOV_TOKEN,
            webpack: options.webpack,
          }),
        );

        return config;
      },
    };
+
    +

    See

    Options for list of options.

    +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_codecov_nuxt_plugin.default.html b/functions/_codecov_nuxt_plugin.default.html index e67698d9..c6a45985 100644 --- a/functions/_codecov_nuxt_plugin.default.html +++ b/functions/_codecov_nuxt_plugin.default.html @@ -1,5 +1,5 @@ default | Codecov JavaScript Bundler Plugins

Function default

  • default(this, inlineOptions, nuxt): _ModuleSetupReturn

  • Details for the Codecov Nuxt module.

    -

    Parameters

    • this: void
    • inlineOptions: Options
    • nuxt: Nuxt

    Returns _ModuleSetupReturn

    Example

    // nuxt.config.ts
    import { defineNuxtConfig } from "nuxt/config";

    export default defineNuxtConfig({
      devtools: { enabled: true },
      w
      builder: "vite",
      // Ensure that the plugin is added to the modules array
      modules: [
        [
          "@codecov/nuxt-plugin",
          {
            enableBundleAnalysis: true,
            bundleName: "nuxt-bundle-analysis",
            uploadToken: process.env.CODECOV_UPLOAD_TOKEN,
          },
        ],
      ],
    });
+

    Parameters

    • this: void
    • inlineOptions: Options
    • nuxt: Nuxt

    Returns _ModuleSetupReturn

    Example

    // nuxt.config.ts
    import { defineNuxtConfig } from "nuxt/config";

    export default defineNuxtConfig({
      devtools: { enabled: true },
      w
      builder: "vite",
      // Ensure that the plugin is added to the modules array
      modules: [
        [
          "@codecov/nuxt-plugin",
          {
            enableBundleAnalysis: true,
            bundleName: "nuxt-bundle-analysis",
            gitService: "github",
          },
        ],
      ],
    });

    See

    Options for list of options.

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_codecov_remix_vite_plugin.codecovRemixVitePlugin.html b/functions/_codecov_remix_vite_plugin.codecovRemixVitePlugin.html index db5aa443..b5cab40b 100644 --- a/functions/_codecov_remix_vite_plugin.codecovRemixVitePlugin.html +++ b/functions/_codecov_remix_vite_plugin.codecovRemixVitePlugin.html @@ -1,5 +1,5 @@ codecovRemixVitePlugin | Codecov JavaScript Bundler Plugins

Function codecovRemixVitePlugin

  • codecovRemixVitePlugin(options): Plugin<any>[]

  • Details for the Codecov Remix plugin.

    -

    Parameters

    • options: Options

    Returns Plugin<any>[]

    Example

    // vite.config.ts
    import { vitePlugin as remix } from "@remix-run/dev";
    import { defineConfig } from "vite";
    import tsconfigPaths from "vite-tsconfig-paths";
    import { codecovRemixVitePlugin } from "@codecov/remix-vite-plugin";

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

    Parameters

    • options: Options

    Returns Plugin<any>[]

    Example

    // vite.config.ts
    import { vitePlugin as remix } from "@remix-run/dev";
    import { defineConfig } from "vite";
    import tsconfigPaths from "vite-tsconfig-paths";
    import { codecovRemixVitePlugin } from "@codecov/remix-vite-plugin";

    export default defineConfig({
      plugins: [
        remix(),
        tsconfigPaths()
        // Put the Codecov SvelteKit plugin after all other plugins
        codecovRemixVitePlugin({
          enableBundleAnalysis: true,
          bundleName: "example-remix-bundle",
          gitService: "github",
        }),
      ],
    });

    See

    Options for list of options.

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_codecov_rollup_plugin.codecovRollupPlugin.html b/functions/_codecov_rollup_plugin.codecovRollupPlugin.html index bcb48fda..cc5d4a1c 100644 --- a/functions/_codecov_rollup_plugin.codecovRollupPlugin.html +++ b/functions/_codecov_rollup_plugin.codecovRollupPlugin.html @@ -1,6 +1,6 @@ codecovRollupPlugin | Codecov JavaScript Bundler Plugins

Function codecovRollupPlugin

  • codecovRollupPlugin(options): Plugin<any>[]

  • Details for the Codecov Rollup plugin.

    Parameters

    • options: Options

      See Options for more details.

      -

    Returns Plugin<any>[]

    Example

    // rollup.config.js
    import { defineConfig } from "rollup";
    import { codecovRollupPlugin } from "@codecov/rollup-plugin";

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

Returns Plugin<any>[]

Example

// rollup.config.js
import { defineConfig } from "rollup";
import { codecovRollupPlugin } from "@codecov/rollup-plugin";

export default defineConfig({
  plugins: [
    // Put the Codecov rollup plugin after all other plugins
    codecovRollupPlugin({
      enableBundleAnalysis: true,
      bundleName: "example-rollup-bundle",
      gitService: "github",
    }),
  ],
});
-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_codecov_solidstart_plugin.codecovSolidStartPlugin.html b/functions/_codecov_solidstart_plugin.codecovSolidStartPlugin.html index 69a25cb7..03d5fe1b 100644 --- a/functions/_codecov_solidstart_plugin.codecovSolidStartPlugin.html +++ b/functions/_codecov_solidstart_plugin.codecovSolidStartPlugin.html @@ -1,5 +1,5 @@ codecovSolidStartPlugin | Codecov JavaScript Bundler Plugins

Function codecovSolidStartPlugin

  • codecovSolidStartPlugin(options): Plugin<any>[]

  • Details for the Codecov SolidStart plugin.

    -

    Parameters

    • options: Options

    Returns Plugin<any>[]

    Example

    // app.config.ts
    import { defineConfig } from "@solidjs/start/config";
    import solidPlugin from "vite-plugin-solid";
    import { codecovSolidStartPlugin } from "@codecov/solidstart-plugin";

    export default defineConfig({
      vite: {
        plugins: [
          // Put the Codecov SolidStart plugin after all other plugins
          solidPlugin(),
          codecovSolidStartPlugin({
            enableBundleAnalysis: true,
            bundleName: "example-solidstart-bundle",
            uploadToken: process.env.CODECOV_TOKEN,
          }),
        ],
      },
    });
+

    Parameters

    • options: Options

    Returns Plugin<any>[]

    Example

    // app.config.ts
    import { defineConfig } from "@solidjs/start/config";
    import solidPlugin from "vite-plugin-solid";
    import { codecovSolidStartPlugin } from "@codecov/solidstart-plugin";

    export default defineConfig({
      vite: {
        plugins: [
          // Put the Codecov SolidStart plugin after all other plugins
          solidPlugin(),
          codecovSolidStartPlugin({
            enableBundleAnalysis: true,
            bundleName: "example-solidstart-bundle",
            gitService: "github",
          }),
        ],
      },
    });

    See

    Options for list of options.

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_codecov_sveltekit_plugin.codecovSvelteKitPlugin.html b/functions/_codecov_sveltekit_plugin.codecovSvelteKitPlugin.html index 73f60afc..77b0262c 100644 --- a/functions/_codecov_sveltekit_plugin.codecovSvelteKitPlugin.html +++ b/functions/_codecov_sveltekit_plugin.codecovSvelteKitPlugin.html @@ -1,5 +1,5 @@ codecovSvelteKitPlugin | Codecov JavaScript Bundler Plugins

Function codecovSvelteKitPlugin

  • codecovSvelteKitPlugin(options): Plugin<any>[]

  • Details for the Codecov SvelteKit plugin.

    -

    Parameters

    • options: Options

    Returns Plugin<any>[]

    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,
        }),
      ],
    });
    
+

    Parameters

    • options: Options

    Returns Plugin<any>[]

    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",
          gitService: "github",
        }),
      ],
    });

    See

    Options for list of options.

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_codecov_vite_plugin.codecovVitePlugin.html b/functions/_codecov_vite_plugin.codecovVitePlugin.html index 0a1273fc..65597d90 100644 --- a/functions/_codecov_vite_plugin.codecovVitePlugin.html +++ b/functions/_codecov_vite_plugin.codecovVitePlugin.html @@ -1,5 +1,5 @@ codecovVitePlugin | Codecov JavaScript Bundler Plugins

Function codecovVitePlugin

  • codecovVitePlugin(options): Plugin<any>[]

  • Details for the Codecov Vite plugin.

    -

    Parameters

    • options: Options

    Returns Plugin<any>[]

    Example

    // vite.config.js
    import { defineConfig } from "vite";
    import { codecovVitePlugin } from "@codecov/vite-plugin";

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

    Parameters

    • options: Options

    Returns Plugin<any>[]

    Example

    // vite.config.js
    import { defineConfig } from "vite";
    import { codecovVitePlugin } from "@codecov/vite-plugin";

    export default defineConfig({
      plugins: [
        // Put the Codecov vite plugin after all other plugins
        codecovVitePlugin({
          enableBundleAnalysis: true,
          bundleName: "example-vite-bundle",
          gitService: "github",
        }),
      ],
    });

    See

    Options for list of options.

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_codecov_webpack_plugin.codecovWebpackPlugin.html b/functions/_codecov_webpack_plugin.codecovWebpackPlugin.html index 9ae96cc1..e2ab641b 100644 --- a/functions/_codecov_webpack_plugin.codecovWebpackPlugin.html +++ b/functions/_codecov_webpack_plugin.codecovWebpackPlugin.html @@ -1,5 +1,5 @@ codecovWebpackPlugin | Codecov JavaScript Bundler Plugins

Function codecovWebpackPlugin

  • codecovWebpackPlugin(options): WebpackPluginInstance

  • Details for the Codecov Webpack plugin.

    -

    Parameters

    • options: Options

    Returns WebpackPluginInstance

    Example

    // webpack.config.js
    const path = require("path");
    const { codecovWebpackPlugin } = require("@codecov/webpack-plugin");

    module.exports = {
      entry: "./src/index.js",
      mode: "production",
      output: {
        filename: "main.js",
        path: path.resolve(__dirname, "dist"),
      },
      plugins: [
        // Put the Codecov vite plugin after all other plugins
        codecovWebpackPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-webpack-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
        }),
       ],
    };
+

    Parameters

    • options: Options

    Returns WebpackPluginInstance

    Example

    // webpack.config.js
    const path = require("path");
    const { codecovWebpackPlugin } = require("@codecov/webpack-plugin");

    module.exports = {
      entry: "./src/index.js",
      mode: "production",
      output: {
        filename: "main.js",
        path: path.resolve(__dirname, "dist"),
      },
      plugins: [
        // Put the Codecov vite plugin after all other plugins
        codecovWebpackPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-webpack-bundle",
          gitService: "github",
        }),
       ],
    };

    See

    Options for list of options.

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html index 22145a2e..33b0347b 100644 --- a/index.html +++ b/index.html @@ -4,10 +4,7 @@

-

Codecov Bundler Plugins

-

[!WARNING]
These plugins are currently in beta and are subject to change.

-
-

Codecov plugins for various JavaScript bundlers. Currently supporting Rollup, Vite, Webpack 5.

+

Codecov Bundler Plugins

Codecov plugins for various JavaScript bundlers. Currently supporting Rollup, Vite, Webpack 5.

Checkout the individual packages for more information and examples:

  • Rollup
    • diff --git a/interfaces/_codecov_bundler_plugin_core.Options.html b/interfaces/_codecov_bundler_plugin_core.Options.html index 487b79ca..861c8fb9 100644 --- a/interfaces/_codecov_bundler_plugin_core.Options.html +++ b/interfaces/_codecov_bundler_plugin_core.Options.html @@ -1,31 +1,63 @@ -Options | Codecov JavaScript Bundler Plugins

    Interface Options

    Configuration ptions for the Codcove bundler plugin.

    -
    interface Options {
        apiUrl?: string;
        bundleName?: string;
        debug?: boolean;
        dryRun?: boolean;
        enableBundleAnalysis?: boolean;
        retryCount?: number;
        uploadOverrides?: UploadOverrides;
        uploadToken?: string;
    }

    Properties

    apiUrl? +Options | Codecov JavaScript Bundler Plugins

    Interface Options

    Configuration options for the Codecov bundler plugin.

    +
    interface Options {
        apiUrl?: string;
        bundleName?: string;
        debug?: boolean;
        dryRun?: boolean;
        enableBundleAnalysis?: boolean;
        gitService?: "github" | "gitlab" | "bitbucket" | "github_enterprise" | "gitlab_enterprise" | "bitbucket_server";
        oidc?: {
            gitHubOIDCTokenAudience?: string;
            useGitHubOIDC: boolean;
        };
        retryCount?: number;
        uploadOverrides?: UploadOverrides;
        uploadToken?: string;
    }

    Properties

    apiUrl? bundleName? debug? dryRun? enableBundleAnalysis? +gitService? +oidc? retryCount? uploadOverrides? uploadToken?

    Properties

    Optional apiUrl

    apiUrl?: string

    The api url used to fetch the upload url.

    Only required if self-hosting codecov.

    +

    Example: apiUrl: 'https://api.codecov.io'

    Defaults to https://api.codecov.io.

    -

    Optional bundleName

    bundleName?: string

    The name for the bundle being built.

    +

    Optional bundleName

    bundleName?: string

    The name for the bundle being built.

    Required for uploading bundle analysis information.

    The name must match the pattern /^[\w\d_:/@\.{}\[\]$-]+$/.

    -

    Example: @codecov/rollup-plugin

    -

    Optional debug

    debug?: boolean

    Option to enable debug logs for the plugin.

    -

    Optional dryRun

    dryRun?: boolean

    When enabled information will not be uploaded to Codecov.

    +

    Example: bundleName: '@codecov/rollup-plugin'

    +

    Optional debug

    debug?: boolean

    Option to enable debug logs for the plugin.

    +

    Optional dryRun

    dryRun?: boolean

    When enabled information will not be uploaded to Codecov.

    +

    Example: dryRun: true

    Defaults to false

    -

    Optional enableBundleAnalysis

    enableBundleAnalysis?: boolean

    Whether you would like bundle analysis to be enabled. *

    +

    Optional enableBundleAnalysis

    enableBundleAnalysis?: boolean

    Whether you would like bundle analysis to be enabled. *

    +

    Example: enableBundleAnalysis: true

    Defaults to false

    -

    Optional retryCount

    retryCount?: number

    The amount of times the upload function will retry to upload bundle analysis information.

    +

    Optional gitService

    gitService?: "github" | "gitlab" | "bitbucket" | "github_enterprise" | "gitlab_enterprise" | "bitbucket_server"

    Override value for git service used for tokenless uploads. Using tokenless uploads is only +supported for public repositories.

    +

    Note: If an uploadToken is provided you do not need to provide a gitService.

    +

    The value must be one of the following:

    +
      +
    • github
      • +
    • gitlab
      • +
    • bitbucket
      • +
    • github_enterprise
      • +
    • gitlab_enterprise
      • +
    • bitbucket_server
      • +
    +

    Example gitService: 'github'

    +

    Optional oidc

    oidc?: {
        gitHubOIDCTokenAudience?: string;
        useGitHubOIDC: boolean;
    }

    Options for OIDC authentication.

    +

    Type declaration

    • Optional gitHubOIDCTokenAudience?: string

      The OIDC audience to use for authentication.

      +

      If you're using a self hosted version of Codecov, you will need to provide the audience for +the OIDC token.

      +

      Defaults to https://codecov.io

      +
    • useGitHubOIDC: boolean

      When using GitHub Actions this option can be enabled to use OIDC authentication, which +removes the requirement for an upload token.

      +

      OpenID Connect +(OIDC) +is required to be configured in order to use GitHub OIDC.

      +

      Defaults to false

      +

    Optional retryCount

    retryCount?: number

    The amount of times the upload function will retry to upload bundle analysis information.

    Defaults to 3

    -

    Optional uploadOverrides

    uploadOverrides?: UploadOverrides

    Override values for passing custom information to API.

    -

    Optional uploadToken

    uploadToken?: string

    The upload token to use for uploading the bundle analysis information.

    -

    This value can either be an global upload token or a repo token.

    +

    Optional uploadOverrides

    uploadOverrides?: UploadOverrides

    Override values for passing custom information to API.

    +

    Optional uploadToken

    uploadToken?: string

    The upload token to use for uploading the bundle analysis information.

    +

    This field is required for uploading bundle analysis information in private repositories. +Alternatively if you're using GitHub Actions and have configured OIDC authentication you can +omit this field, and enable the oidc.useGitHubOIDC option.

    +

    This value can either be a global upload token or a repo token.

    • The global upload token can be found under the organization settings page.
    • The repo token can be found under the repo settings page under the general tab.
    -

    Settings

    Member Visibility

    Theme

    On This Page

    apiUrlbundleNamedebugdryRunenableBundleAnalysisretryCountuploadOverridesuploadToken

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    apiUrlbundleNamedebugdryRunenableBundleAnalysisgitServiceoidcretryCountuploadOverridesuploadToken

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_codecov_bundler_plugin_core.UploadOverrides.html b/interfaces/_codecov_bundler_plugin_core.UploadOverrides.html index 1f8f2ace..b4a88482 100644 --- a/interfaces/_codecov_bundler_plugin_core.UploadOverrides.html +++ b/interfaces/_codecov_bundler_plugin_core.UploadOverrides.html @@ -1,14 +1,14 @@ UploadOverrides | Codecov JavaScript Bundler Plugins

    Interface UploadOverrides

    A set of overrides that are passed to Codecov.

    -
    interface UploadOverrides {
        branch?: string;
        build?: string;
        compareSha?: string;
        pr?: string;
        sha?: string;
        slug?: string;
    }

    Properties

    branch? +
    interface UploadOverrides {
        branch?: string;
        build?: string;
        compareSha?: string;
        pr?: string;
        sha?: string;
        slug?: string;
    }

    Properties

    branch? build? compareSha? pr? sha? slug?

    Properties

    Optional branch

    branch?: string

    Specify the branch manually.

    -

    Optional build

    build?: string

    Specify the build number manually.

    -

    Optional compareSha

    compareSha?: string

    Specify the compare SHA manually. GH Actions only.

    -

    Optional pr

    pr?: string

    Specify the pull request number manually.

    -

    Optional sha

    sha?: string

    Specify the commit SHA manually.

    -

    Optional slug

    slug?: string

    Specify the slug manually.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    branchbuildcompareShaprshaslug

    Generated using TypeDoc

    \ No newline at end of file +

    Optional build

    build?: string

    Specify the build number manually.

    +

    Optional compareSha

    compareSha?: string

    Specify the compare SHA manually. GH Actions only.

    +

    Optional pr

    pr?: string

    Specify the pull request number manually.

    +

    Optional sha

    sha?: string

    Specify the commit SHA manually.

    +

    Optional slug

    slug?: string

    Specify the slug manually.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    branchbuildcompareShaprshaslug

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_codecov_bundler_plugin_core.html b/modules/_codecov_bundler_plugin_core.html index dce41bc9..bb2a0bc3 100644 --- a/modules/_codecov_bundler_plugin_core.html +++ b/modules/_codecov_bundler_plugin_core.html @@ -1,4 +1,4 @@ -@codecov/bundler-plugin-core - v0.0.1-beta.12 | Codecov JavaScript Bundler Plugins

    Module @codecov/bundler-plugin-core - v0.0.1-beta.12

    +@codecov/bundler-plugin-core - v1.0.0 | Codecov JavaScript Bundler Plugins

    Module @codecov/bundler-plugin-core - v1.0.0

    Codecov by Sentry logo diff --git a/modules/_codecov_nextjs_webpack_plugin.html b/modules/_codecov_nextjs_webpack_plugin.html new file mode 100644 index 00000000..9421d730 --- /dev/null +++ b/modules/_codecov_nextjs_webpack_plugin.html @@ -0,0 +1,40 @@ +@codecov/nextjs-webpack-plugin - v1.0.0 | Codecov JavaScript Bundler Plugins

    Module @codecov/nextjs-webpack-plugin - v1.0.0

    + + Codecov by Sentry logo + +

    + +

    Codecov NextJS (Webpack) Plugin

    A NextJS (Webpack) plugin that provides bundle analysis support for Codecov.

    +
    +

    [!NOTE] +The plugin does not support code coverage, see our docs to set up coverage today!

    +
    +

    Installation

    Using npm:

    +
    npm install @codecov/nextjs-webpack-plugin --save-dev
+
    +

    Using yarn:

    +
    yarn add @codecov/nextjs-webpack-plugin --dev
+
    +

    Using pnpm:

    +
    pnpm add @codecov/nextjs-webpack-plugin --save-dev
+
    +

    Public Repo Example - GitHub Actions

    This configuration will automatically upload the bundle analysis to Codecov for public repositories. When an internal PR is created it will use the Codecov token set in your secrets, and if running from a forked PR, it will use the tokenless setting automatically. For setups not using GitHub Actions see the following example. For private repositories see the following example.

    +
    // next.config.mjs
    import { codecovNextJSWebpackPlugin } from "@codecov/nextjs-webpack-plugin";

    export default {
      webpack: (config, options) => {
        config.plugins.push(
          codecovNextJSWebpackPlugin({
            enableBundleAnalysis: true,
            bundleName: "example-nextjs-webpack-bundle",
            uploadToken: process.env.CODECOV_TOKEN,
            gitService: "github",
            webpack: options.webpack,
          }),
        );

        return config;
      },
    };
+
    +

    Public Repo Example - Non-GitHub Actions

    This setup is for public repositories that are not using GitHub Actions, this configuration will automatically upload the bundle analysis to Codecov. You will need to configure the it similar to the GitHub Actions example, however you will need to provide a branch override, and ensure that it will pass the correct branch name, and with forks including the fork-owner i.e. fork-owner:branch.

    +
    // next.config.mjs
    import { codecovNextJSWebpackPlugin } from "@codecov/nextjs-webpack-plugin";

    export default {
      webpack: (config, options) => {
        config.plugins.push(
          codecovNextJSWebpackPlugin({
            enableBundleAnalysis: true,
            bundleName: "example-nextjs-webpack-bundle",
            uploadToken: process.env.CODECOV_TOKEN,
            gitService: "github",
            webpack: options.webpack,
            uploadOverrides: {
              branch: "<branch value>",
            },
          }),
        );

        return config;
      },
    };
+
    +

    Private Repo Example

    This is the required way to use the plugin for private repositories. This configuration will automatically upload the bundle analysis to Codecov.

    +
    // next.config.mjs
    import { codecovNextJSWebpackPlugin } from "@codecov/nextjs-webpack-plugin";

    export default {
      webpack: (config, options) => {
        config.plugins.push(
          codecovNextJSWebpackPlugin({
            enableBundleAnalysis: true,
            bundleName: "example-nextjs-webpack-bundle",
            uploadToken: process.env.CODECOV_TOKEN,
            webpack: options.webpack,
          }),
        );

        return config;
      },
    };
+
    +

    OIDC Configuration Example

    For users with OpenID Connect (OIDC) enabled, setting the uploadToken is not necessary. You can use OIDC with the oidc configuration as following.

    +
    // next.config.mjs
    import { codecovNextJSWebpackPlugin } from "@codecov/nextjs-webpack-plugin";

    export default {
      webpack: (config, options) => {
        config.plugins.push(
          codecovNextJSWebpackPlugin({
            enableBundleAnalysis: true,
            bundleName: "example-nextjs-webpack-bundle",
            webpack: options.webpack,
            oidc: {
              useGitHubOIDC: true,
            },
          }),
        );

        return config;
      },
    };
+
    +

    More information

    +

    Index

    Functions

    codecovNextJSWebpackPlugin +

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov NextJS (Webpack) Plugin

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_codecov_nuxt_plugin.html b/modules/_codecov_nuxt_plugin.html index 9f5c7ef4..9685ed59 100644 --- a/modules/_codecov_nuxt_plugin.html +++ b/modules/_codecov_nuxt_plugin.html @@ -1,18 +1,14 @@ -@codecov/nuxt-plugin - v0.0.1-beta.12 | Codecov JavaScript Bundler Plugins

    Module @codecov/nuxt-plugin - v0.0.1-beta.12

    +@codecov/nuxt-plugin - v1.0.0 | Codecov JavaScript Bundler Plugins

    Module @codecov/nuxt-plugin - v1.0.0

    Codecov by Sentry logo

    -

    Codecov Nuxt Plugin

    -

    [!WARNING] -These plugins are currently in beta and are subject to change.

    -

    A Nuxt plugin that provides bundle analysis support for Codecov.

    -

    The plugin does not support code coverage, see our docs to set up coverage today!

    -
    +

    Codecov Nuxt Plugin

    A Nuxt plugin that provides bundle analysis support for Codecov.

    [!NOTE] This plugin only supports Nuxt 3.x when building with Vite.

    +

    The plugin does not support code coverage, see our docs to set up coverage today!

    Installation

    Using npm:

    npm install @codecov/nuxt-plugin --save-dev
@@ -23,7 +19,17 @@
 
    Using pnpm:
    
 
    pnpm add @codecov/nuxt-plugin --save-dev
 
    
-
    Example
    // nuxt.config.ts
    import { defineNuxtConfig } from "nuxt/config";

    export default defineNuxtConfig({
      devtools: { enabled: true },
      // Ensure that the builder is set to "vite"
      builder: "vite",
      // Ensure that the plugin is added to the modules array
      modules: [
        [
          "@codecov/nuxt-plugin",
          {
            enableBundleAnalysis: true,
            bundleName: "nuxt-bundle-analysis",
            uploadToken: process.env.CODECOV_UPLOAD_TOKEN,
          },
        ],
      ],
    });
+
    Public Repo Example - GitHub Actions
    This configuration will automatically upload the bundle analysis to Codecov for public repositories. When an internal PR is created it will use the Codecov token set in your secrets, and if running from a forked PR, it will use the tokenless setting automatically. For setups not using GitHub Actions see the following example. For private repositories see the following example.
    
+
    // nuxt.config.ts
    import { defineNuxtConfig } from "nuxt/config";

    export default defineNuxtConfig({
      devtools: { enabled: true },
      // Ensure that the builder is set to "vite"
      builder: "vite",
      // Ensure that the plugin is added to the modules array
      modules: [
        [
          "@codecov/nuxt-plugin",
          {
            enableBundleAnalysis: true,
            bundleName: "nuxt-bundle-analysis",
            uploadToken: process.env.CODECOV_UPLOAD_TOKEN,
            gitService: "github",
          },
        ],
      ],
    });
+
    
+
    Public Repo Example - Non-GitHub Actions
    This setup is for public repositories that are not using GitHub Actions, this configuration will automatically upload the bundle analysis to Codecov. You will need to configure the it similar to the GitHub Actions example, however you will need to provide a branch override, and ensure that it will pass the correct branch name, and with forks including the fork-owner i.e. fork-owner:branch.
    
+
    // nuxt.config.ts
    import { defineNuxtConfig } from "nuxt/config";

    export default defineNuxtConfig({
      devtools: { enabled: true },
      // Ensure that the builder is set to "vite"
      builder: "vite",
      // Ensure that the plugin is added to the modules array
      modules: [
        [
          "@codecov/nuxt-plugin",
          {
            enableBundleAnalysis: true,
            bundleName: "nuxt-bundle-analysis",
            uploadToken: process.env.CODECOV_UPLOAD_TOKEN,
            gitService: "github",
            uploadOverrides: {
              branch: "<branch value>",
            },
          },
        ],
      ],
    });
+
    
+
    Private Repo Example
    This is the required way to use the plugin for private repositories. This configuration will automatically upload the bundle analysis to Codecov.
    
+
    // nuxt.config.ts
    import { defineNuxtConfig } from "nuxt/config";

    export default defineNuxtConfig({
      devtools: { enabled: true },
      // Ensure that the builder is set to "vite"
      builder: "vite",
      // Ensure that the plugin is added to the modules array
      modules: [
        [
          "@codecov/nuxt-plugin",
          {
            enableBundleAnalysis: true,
            bundleName: "nuxt-bundle-analysis",
            uploadToken: process.env.CODECOV_UPLOAD_TOKEN,
          },
        ],
      ],
    });
+
    
+
    OIDC Configuration Example
    For users with OpenID Connect (OIDC) enabled, setting the uploadToken is not necessary. You can use OIDC with the oidc configuration as following.
    
+
    // nuxt.config.ts
    import { defineNuxtConfig } from "nuxt/config";

    export default defineNuxtConfig({
      devtools: { enabled: true },
      // Ensure that the builder is set to "vite"
      builder: "vite",
      // Ensure that the plugin is added to the modules array
      modules: [
        [
          "@codecov/nuxt-plugin",
          {
            enableBundleAnalysis: true,
            bundleName: "nuxt-bundle-analysis",
            oidc: {
              useGitHubOIDC: true,
            },
          },
        ],
      ],
    });
 
    
 
    More information

    Index

    Functions

    default -

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov Nuxt Plugin

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov Nuxt Plugin

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_codecov_remix_vite_plugin.html b/modules/_codecov_remix_vite_plugin.html index b004edac..39d6e980 100644 --- a/modules/_codecov_remix_vite_plugin.html +++ b/modules/_codecov_remix_vite_plugin.html @@ -1,18 +1,14 @@ -@codecov/remix-vite-plugin - v0.0.1-beta.12 | Codecov JavaScript Bundler Plugins

    Module @codecov/remix-vite-plugin - v0.0.1-beta.12

    +@codecov/remix-vite-plugin - v1.0.0 | Codecov JavaScript Bundler Plugins

    Module @codecov/remix-vite-plugin - v1.0.0

    Codecov by Sentry logo

    -

    Codecov Remix Plugin

    -

    [!WARNING] -These plugins are currently in beta and are subject to change.

    -

    A Remix plugin that provides bundle analysis support for Codecov.

    -

    The plugin does not support code coverage, see our docs to set up coverage today!

    -
    +

    Codecov Remix Plugin

    A Remix plugin that provides bundle analysis support for Codecov.

    [!NOTE] This plugin only supports Remix 2.x when building with Vite.

    +

    The plugin does not support code coverage, see our docs to set up coverage today!

    Installation

    Using npm:

    npm install @codecov/remix-vite-plugin --save-dev
@@ -23,7 +19,17 @@
 
    Using pnpm:
    
 
    pnpm add @codecov/remix-vite-plugin --save-dev
 
    
-
    Example
    // vite.config.ts
    import { vitePlugin as remix } from "@remix-run/dev";
    import { defineConfig } from "vite";
    import tsconfigPaths from "vite-tsconfig-paths";
    import { codecovRemixPlugin } from "@codecov/remix-vite-plugin";

    export default defineConfig({
      plugins: [
        remix(),
        tsconfigPaths()
        // Put the Codecov Remix plugin after all other plugins
        codecovRemixPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-remix-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
        }),
      ],
    });
+
    Public Repo Example - GitHub Actions
    This configuration will automatically upload the bundle analysis to Codecov for public repositories. When an internal PR is created it will use the Codecov token set in your secrets, and if running from a forked PR, it will use the tokenless setting automatically. For setups not using GitHub Actions see the following example. For private repositories see the following example.
    
+
    // vite.config.ts
    import { vitePlugin as remix } from "@remix-run/dev";
    import { defineConfig } from "vite";
    import tsconfigPaths from "vite-tsconfig-paths";
    import { codecovRemixPlugin } from "@codecov/remix-vite-plugin";

    export default defineConfig({
      plugins: [
        remix(),
        tsconfigPaths()
        // Put the Codecov Remix plugin after all other plugins
        codecovRemixPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-remix-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
          gitService: "github",
        }),
      ],
    });
+
    
+
    Public Repo Example - Non-GitHub Actions
    This setup is for public repositories that are not using GitHub Actions, this configuration will automatically upload the bundle analysis to Codecov. You will need to configure the it similar to the GitHub Actions example, however you will need to provide a branch override, and ensure that it will pass the correct branch name, and with forks including the fork-owner i.e. fork-owner:branch.
    
+
    // vite.config.ts
    import { vitePlugin as remix } from "@remix-run/dev";
    import { defineConfig } from "vite";
    import tsconfigPaths from "vite-tsconfig-paths";
    import { codecovRemixPlugin } from "@codecov/remix-vite-plugin";

    export default defineConfig({
      plugins: [
        remix(),
        tsconfigPaths()
        // Put the Codecov Remix plugin after all other plugins
        codecovRemixPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-remix-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
          gitService: "github",
          uploadOverrides: {
            branch: "<branch value>",
          },
        }),
      ],
    });
+
    
+
    Private Repo Example
    This is the required way to use the plugin for private repositories. This configuration will automatically upload the bundle analysis to Codecov.
    
+
    // vite.config.ts
    import { vitePlugin as remix } from "@remix-run/dev";
    import { defineConfig } from "vite";
    import tsconfigPaths from "vite-tsconfig-paths";
    import { codecovRemixPlugin } from "@codecov/remix-vite-plugin";

    export default defineConfig({
      plugins: [
        remix(),
        tsconfigPaths()
        // Put the Codecov Remix plugin after all other plugins
        codecovRemixPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-remix-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
        }),
      ],
    });
+
    
+
    OIDC Configuration Example
    For users with OpenID Connect (OIDC) enabled, setting the uploadToken is not necessary. You can use OIDC with the oidc configuration as following.
    
+
    // vite.config.ts
    import { vitePlugin as remix } from "@remix-run/dev";
    import { defineConfig } from "vite";
    import tsconfigPaths from "vite-tsconfig-paths";
    import { codecovRemixPlugin } from "@codecov/remix-vite-plugin";

    export default defineConfig({
      plugins: [
        remix(),
        tsconfigPaths()
        // Put the Codecov Remix plugin after all other plugins
        codecovRemixPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-remix-bundle",
          oidc: {
            useGitHubOIDC: true,
          },
        }),
      ],
    });
 
    
 
    More information

    Index

    Functions

    codecovRemixVitePlugin -

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov Remix Plugin

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov Remix Plugin

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_codecov_rollup_plugin.html b/modules/_codecov_rollup_plugin.html index c588763f..a15b3217 100644 --- a/modules/_codecov_rollup_plugin.html +++ b/modules/_codecov_rollup_plugin.html @@ -1,15 +1,13 @@ -@codecov/rollup-plugin - v0.0.1-beta.12 | Codecov JavaScript Bundler Plugins

    Module @codecov/rollup-plugin - v0.0.1-beta.12

    +@codecov/rollup-plugin - v1.0.0 | Codecov JavaScript Bundler Plugins

    Module @codecov/rollup-plugin - v1.0.0

    Codecov by Sentry logo

    -

    Codecov Rollup Plugin

    -

    [!WARNING]
    These plugins are currently in beta and are subject to change.

    -
    +

    Codecov Rollup Plugin

    A Rollup plugin that provides bundle analysis support for Codecov.

    -

    A Rollup plugin that provides bundle analysis support for Codecov.

    -

    The plugin does not support code coverage, see our docs to set up coverage today!

    +

    [!NOTE] +The plugin does not support code coverage, see our docs to set up coverage today!

    Installation

    Using npm:

    npm install @codecov/rollup-plugin --save-dev
@@ -20,7 +18,17 @@
 
    Using pnpm:
    
 
    pnpm add @codecov/rollup-plugin --save-dev
 
    
-
    Example
    // rollup.config.js
    import { defineConfig } from "rollup";
    import { codecovRollupPlugin } from "@codecov/rollup-plugin";

    export default defineConfig({
      plugins: [
        // Put the Codecov rollup plugin after all other plugins
        codecovRollupPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-rollup-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
        }),
      ],
    });
+
    Public Repo Example - GitHub Actions
    This configuration will automatically upload the bundle analysis to Codecov for public repositories. When an internal PR is created it will use the Codecov token set in your secrets, and if running from a forked PR, it will use the tokenless setting automatically. For setups not using GitHub Actions see the following example. For private repositories see the following example.
    
+
    // rollup.config.js
    import { defineConfig } from "rollup";
    import { codecovRollupPlugin } from "@codecov/rollup-plugin";

    export default defineConfig({
      plugins: [
        // Put the Codecov rollup plugin after all other plugins
        codecovRollupPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-rollup-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
          gitService: "github",
        }),
      ],
    });
+
    
+
    Public Repo Example - Non-GitHub Actions
    This setup is for public repositories that are not using GitHub Actions, this configuration will automatically upload the bundle analysis to Codecov. You will need to configure the it similar to the GitHub Actions example, however you will need to provide a branch override, and ensure that it will pass the correct branch name, and with forks including the fork-owner i.e. fork-owner:branch.
    
+
    // rollup.config.js
    import { defineConfig } from "rollup";
    import { codecovRollupPlugin } from "@codecov/rollup-plugin";

    export default defineConfig({
      plugins: [
        // Put the Codecov rollup plugin after all other plugins
        codecovRollupPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-rollup-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
          gitService: "github",
          uploadOverrides: {
            branch: "<branch value>",
          },
        }),
      ],
    });
+
    
+
    Private Repo Example
    This is the required way to use the plugin for private repositories. This configuration will automatically upload the bundle analysis to Codecov.
    
+
    // rollup.config.js
    import { defineConfig } from "rollup";
    import { codecovRollupPlugin } from "@codecov/rollup-plugin";

    export default defineConfig({
      plugins: [
        // Put the Codecov rollup plugin after all other plugins
        codecovRollupPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-rollup-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
        }),
      ],
    });
+
    
+
    OIDC Configuration Example
    For users with OpenID Connect (OIDC) enabled, setting the uploadToken is not necessary. You can use OIDC with the oidc configuration as following.
    
+
    // rollup.config.js
    import { defineConfig } from "rollup";
    import { codecovRollupPlugin } from "@codecov/rollup-plugin";

    export default defineConfig({
      plugins: [
        // Put the Codecov rollup plugin after all other plugins
        codecovRollupPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-rollup-bundle",
          oidc: {
            useGitHubOIDC: true,
          },
        }),
      ],
    });
 
    
 
    More information

    Index

    Functions

    codecovRollupPlugin -

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov Rollup Plugin

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov Rollup Plugin

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_codecov_solidstart_plugin.html b/modules/_codecov_solidstart_plugin.html index 6cd2e01f..e23edb02 100644 --- a/modules/_codecov_solidstart_plugin.html +++ b/modules/_codecov_solidstart_plugin.html @@ -1,18 +1,14 @@ -@codecov/solidstart-plugin - v0.0.1-beta.12 | Codecov JavaScript Bundler Plugins

    Module @codecov/solidstart-plugin - v0.0.1-beta.12

    +@codecov/solidstart-plugin - v1.0.0 | Codecov JavaScript Bundler Plugins

    Module @codecov/solidstart-plugin - v1.0.0

    Codecov by Sentry logo

    -

    Codecov SolidStart Plugin

    -

    [!WARNING] -These plugins are currently in beta and are subject to change.

    -

    A SolidStart plugin that provides bundle analysis support for Codecov.

    -

    The plugin does not support code coverage, see our docs to set up coverage today!

    -
    +

    Codecov SolidStart Plugin

    A SolidStart plugin that provides bundle analysis support for Codecov.

    [!NOTE] This plugin only supports SolidStart 1.x when building with Vite.

    +

    The plugin does not support code coverage, see our docs to set up coverage today!

    Installation

    Using npm:

    npm install @codecov/solidstart-plugin --save-dev
@@ -23,7 +19,17 @@
 
    Using pnpm:
    
 
    pnpm add @codecov/solidstart-plugin --save-dev
 
    
-
    Example
    // app.config.ts
    import { defineConfig } from "@solidjs/start/config";
    import solidPlugin from "vite-plugin-solid";
    import { codecovSolidStartPlugin } from "@codecov/solidstart-plugin";

    export default defineConfig({
      vite: {
        plugins: [
          // Put the Codecov SolidStart plugin after all other plugins
          solidPlugin(),
          codecovSolidStartPlugin({
            enableBundleAnalysis: true,
            bundleName: "example-solidstart-bundle",
            uploadToken: process.env.CODECOV_TOKEN,
          }),
        ],
      },
    });
+
    Public Repo Example - GitHub Actions
    This configuration will automatically upload the bundle analysis to Codecov for public repositories. When an internal PR is created it will use the Codecov token set in your secrets, and if running from a forked PR, it will use the tokenless setting automatically. For setups not using GitHub Actions see the following example. For private repositories see the following example.
    
+
    // app.config.ts
    import { defineConfig } from "@solidjs/start/config";
    import solidPlugin from "vite-plugin-solid";
    import { codecovSolidStartPlugin } from "@codecov/solidstart-plugin";

    export default defineConfig({
      vite: {
        plugins: [
          // Put the Codecov SolidStart plugin after all other plugins
          solidPlugin(),
          codecovSolidStartPlugin({
            enableBundleAnalysis: true,
            bundleName: "example-solidstart-bundle",
            uploadToken: process.env.CODECOV_TOKEN,
            gitService: "github",
          }),
        ],
      },
    });
+
    
+
    Public Repo Example - Non-GitHub Actions
    This setup is for public repositories that are not using GitHub Actions, this configuration will automatically upload the bundle analysis to Codecov. You will need to configure the it similar to the GitHub Actions example, however you will need to provide a branch override, and ensure that it will pass the correct branch name, and with forks including the fork-owner i.e. fork-owner:branch.
    
+
    // app.config.ts
    import { defineConfig } from "@solidjs/start/config";
    import solidPlugin from "vite-plugin-solid";
    import { codecovSolidStartPlugin } from "@codecov/solidstart-plugin";

    export default defineConfig({
      vite: {
        plugins: [
          // Put the Codecov SolidStart plugin after all other plugins
          solidPlugin(),
          codecovSolidStartPlugin({
            enableBundleAnalysis: true,
            bundleName: "example-solidstart-bundle",
            uploadToken: process.env.CODECOV_TOKEN,
            gitService: "github",
            uploadOverrides: {
              branch: "<branch value>",
            },
          }),
        ],
      },
    });
+
    
+
    Private Repo Example
    This is the required way to use the plugin for private repositories. This configuration will automatically upload the bundle analysis to Codecov.
    
+
    // app.config.ts
    import { defineConfig } from "@solidjs/start/config";
    import solidPlugin from "vite-plugin-solid";
    import { codecovSolidStartPlugin } from "@codecov/solidstart-plugin";

    export default defineConfig({
      vite: {
        plugins: [
          // Put the Codecov SolidStart plugin after all other plugins
          solidPlugin(),
          codecovSolidStartPlugin({
            enableBundleAnalysis: true,
            bundleName: "example-solidstart-bundle",
            uploadToken: process.env.CODECOV_TOKEN,
          }),
        ],
      },
    });
+
    
+
    OIDC Configuration Example
    For users with OpenID Connect (OIDC) enabled, setting the uploadToken is not necessary. You can use OIDC with the oidc configuration as following.
    
+
    // app.config.ts
    import { defineConfig } from "@solidjs/start/config";
    import solidPlugin from "vite-plugin-solid";
    import { codecovSolidStartPlugin } from "@codecov/solidstart-plugin";

    export default defineConfig({
      vite: {
        plugins: [
          // Put the Codecov SolidStart plugin after all other plugins
          solidPlugin(),
          codecovSolidStartPlugin({
            enableBundleAnalysis: true,
            bundleName: "example-solidstart-bundle",
            oidc: {
              useGitHubOIDC: true,
            },
          }),
        ],
      },
    });
 
    
 
    More information

    Index

    Functions

    codecovSolidStartPlugin -

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov SolidStart Plugin

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov SolidStart Plugin

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_codecov_sveltekit_plugin.html b/modules/_codecov_sveltekit_plugin.html index 7709ae70..1a35deff 100644 --- a/modules/_codecov_sveltekit_plugin.html +++ b/modules/_codecov_sveltekit_plugin.html @@ -1,18 +1,14 @@ -@codecov/sveltekit-plugin - v0.0.1-beta.12 | Codecov JavaScript Bundler Plugins

    Module @codecov/sveltekit-plugin - v0.0.1-beta.12

    +@codecov/sveltekit-plugin - v1.0.0 | Codecov JavaScript Bundler Plugins

    Module @codecov/sveltekit-plugin - v1.0.0

    Codecov by Sentry logo

    -

    Codecov SvelteKit Plugin

    -

    [!WARNING] -These plugins are currently in beta and are subject to change.

    -

    A SvelteKit plugin that provides bundle analysis support for Codecov.

    -

    The plugin does not support code coverage, see our docs to set up coverage today!

    -
    +

    Codecov SvelteKit Plugin

    A SvelteKit plugin that provides bundle analysis support for Codecov.

    [!NOTE] This plugin only supports SvelteKit 2.x when building with Vite.

    +

    The plugin does not support code coverage, see our docs to set up coverage today!

    Installation

    Using npm:

    npm install @codecov/sveltekit-plugin --save-dev
@@ -23,7 +19,17 @@
 
    Using pnpm:
    
 
    pnpm add @codecov/sveltekit-plugin --save-dev
 
    
-
    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,
        }),
      ],
    });
+
    Public Repo Example - GitHub Actions
    This configuration will automatically upload the bundle analysis to Codecov for public repositories. When an internal PR is created it will use the Codecov token set in your secrets, and if running from a forked PR, it will use the tokenless setting automatically. For setups not using GitHub Actions see the following example. For private repositories see the following 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,
          gitService: "github",
        }),
      ],
    });
+
    
+
    Public Repo Example - Non-GitHub Actions
    This setup is for public repositories that are not using GitHub Actions, this configuration will automatically upload the bundle analysis to Codecov. You will need to configure the it similar to the GitHub Actions example, however you will need to provide a branch override, and ensure that it will pass the correct branch name, and with forks including the fork-owner i.e. fork-owner:branch.
    
+
    // 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,
          gitService: "github",
          uploadOverrides: {
            branch: "<branch value>",
          },
        }),
      ],
    });
+
    
+
    Private Repo Example
    This is the required way to use the plugin for private repositories. This configuration will automatically upload the bundle analysis to Codecov.
    
+
    // 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,
        }),
      ],
    });
+
    
+
    OIDC Configuration Example
    For users with OpenID Connect (OIDC) enabled, setting the uploadToken is not necessary. You can use OIDC with the oidc configuration as following.
    
+
    // 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",
          oidc: {
            useGitHubOIDC: true,
          },
        }),
      ],
    });
 
    
 
    More information

    Index

    Functions

    codecovSvelteKitPlugin -

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov SvelteKit Plugin

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov SvelteKit Plugin

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_codecov_vite_plugin.html b/modules/_codecov_vite_plugin.html index 8d5d4bdc..36771eea 100644 --- a/modules/_codecov_vite_plugin.html +++ b/modules/_codecov_vite_plugin.html @@ -1,15 +1,13 @@ -@codecov/vite-plugin - v0.0.1-beta.12 | Codecov JavaScript Bundler Plugins

    Module @codecov/vite-plugin - v0.0.1-beta.12

    +@codecov/vite-plugin - v1.0.0 | Codecov JavaScript Bundler Plugins

    Module @codecov/vite-plugin - v1.0.0

    Codecov by Sentry logo

    -

    Codecov Vite Plugin

    -

    [!WARNING]
    These plugins are currently in beta and are subject to change.

    -
    +

    Codecov Vite Plugin

    A Vite plugin that provides bundle analysis support for Codecov.

    -

    A Vite plugin that provides bundle analysis support for Codecov.

    -

    The plugin does not support code coverage, see our docs to set up coverage today!

    +

    [!NOTE] +The plugin does not support code coverage, see our docs to set up coverage today!

    Installation

    Using npm:

    npm install @codecov/vite-plugin --save-dev
@@ -20,7 +18,18 @@
 
    Using pnpm:
    
 
    pnpm add @codecov/vite-plugin --save-dev
 
    
-
    Example
    // vite.config.js
    import { defineConfig } from "vite";
    import { codecovVitePlugin } from "@codecov/vite-plugin";

    export default defineConfig({
      plugins: [
        // Put the Codecov vite plugin after all other plugins
        codecovVitePlugin({
          enableBundleAnalysis: true,
          bundleName: "example-vite-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
        }),
      ],
    });
+
    Public Repo Example - GitHub Actions
    This configuration will automatically upload the bundle analysis to Codecov for public repositories. When an internal PR is created it will use the Codecov token set in your secrets, and if running from a forked PR, it will use the tokenless setting automatically. For setups not using GitHub Actions see the following example. For private repositories see the following example.
    
+
    // vite.config.js
    import { defineConfig } from "vite";
    import { codecovVitePlugin } from "@codecov/vite-plugin";

    export default defineConfig({
      plugins: [
        // Put the Codecov vite plugin after all other plugins
        codecovVitePlugin({
          enableBundleAnalysis: true,
          bundleName: "example-vite-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
          gitService: "github",
        }),
      ],
    });
+
    
+
    Public Repo Example - Non-GitHub Actions
    This setup is for public repositories that are not using GitHub Actions, this configuration will automatically upload the bundle analysis to Codecov. You will need to configure the it similar to the GitHub Actions example, however you will need to provide a branch override, and ensure that it will pass the correct branch name, and with forks including the fork-owner i.e. fork-owner:branch.
    
+
    // vite.config.js
    import { defineConfig } from "vite";
    import { codecovVitePlugin } from "@codecov/vite-plugin";

    export default defineConfig({
      plugins: [
        // Put the Codecov vite plugin after all other plugins
        codecovVitePlugin({
          enableBundleAnalysis: true,
          bundleName: "example-vite-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
          gitService: "github",
          uploadOverrides: {
            branch: "<branch value>",
          },
        }),
      ],
    });
+
    
+
    Private Repo Example
    This is the required way to use the plugin for private repositories. This configuration will automatically upload the bundle analysis to Codecov.
    
+
    This configuration will automatically upload the bundle analysis to Codecov for public repositories. When an internal PR is created it will use the Codecov token set in your secrets, and if running from a forked PR, it will use the tokenless setting automatically. For setups not using GitHub Actions see the following example. For private repositories see the following example.
    
+
    // vite.config.js
    import { defineConfig } from "vite";
    import { codecovVitePlugin } from "@codecov/vite-plugin";

    export default defineConfig({
      plugins: [
        // Put the Codecov vite plugin after all other plugins
        codecovVitePlugin({
          enableBundleAnalysis: true,
          bundleName: "example-vite-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
        }),
      ],
    });
+
    
+
    OIDC Configuration Example
    For users with OpenID Connect (OIDC) enabled, setting the uploadToken is not necessary. You can use OIDC with the oidc configuration as following.
    
+
    // vite.config.js
    import { defineConfig } from "vite";
    import { codecovVitePlugin } from "@codecov/vite-plugin";

    export default defineConfig({
      plugins: [
        // Put the Codecov vite plugin after all other plugins
        codecovVitePlugin({
          enableBundleAnalysis: true,
          bundleName: "example-vite-bundle",
          oidc: {
            useGitHubOIDC: true,
          },
        }),
      ],
    });
 
    
 
    More information

    Index

    Functions

    codecovVitePlugin -

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov Vite Plugin

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov Vite Plugin

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_codecov_webpack_plugin.html b/modules/_codecov_webpack_plugin.html index a7dc0a3b..7a09d73d 100644 --- a/modules/_codecov_webpack_plugin.html +++ b/modules/_codecov_webpack_plugin.html @@ -1,15 +1,13 @@ -@codecov/webpack-plugin - v0.0.1-beta.12 | Codecov JavaScript Bundler Plugins

    Module @codecov/webpack-plugin - v0.0.1-beta.12

    +@codecov/webpack-plugin - v1.0.0 | Codecov JavaScript Bundler Plugins

    Module @codecov/webpack-plugin - v1.0.0

    Codecov by Sentry logo

    -

    Codecov Webpack Plugin

    -

    [!WARNING]
    These plugins are currently in beta and are subject to change.

    -
    +

    Codecov Webpack Plugin

    A Webpack plugin that provides bundle analysis support for Codecov.

    -

    A Webpack plugin that provides bundle analysis support for Codecov.

    -

    The plugin does not support code coverage, see our docs to set up coverage today!

    +

    [!NOTE] +The plugin does not support code coverage, see our docs to set up coverage today!

    Installation

    Using npm:

    npm install @codecov/webpack-plugin --save-dev
@@ -20,7 +18,17 @@
 
    Using pnpm:
    
 
    pnpm add @codecov/webpack-plugin --save-dev
 
    
-
    Example
    // webpack.config.js
    const path = require("path");
    const { codecovWebpackPlugin } = require("@codecov/webpack-plugin");

    module.exports = {
      entry: "./src/index.js",
      mode: "production",
      output: {
        filename: "main.js",
        path: path.resolve(__dirname, "dist"),
      },
      plugins: [
        // Put the Codecov vite plugin after all other plugins
        codecovWebpackPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-webpack-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
        }),
      ],
    };
+
    Public Repo Example - GitHub Actions
    This configuration will automatically upload the bundle analysis to Codecov for public repositories. When an internal PR is created it will use the Codecov token set in your secrets, and if running from a forked PR, it will use the tokenless setting automatically. For setups not using GitHub Actions see the following example. For private repositories see the following example.
    
+
    // webpack.config.js
    const path = require("path");
    const { codecovWebpackPlugin } = require("@codecov/webpack-plugin");

    module.exports = {
      entry: "./src/index.js",
      mode: "production",
      output: {
        filename: "main.js",
        path: path.resolve(__dirname, "dist"),
      },
      plugins: [
        // Put the Codecov vite plugin after all other plugins
        codecovWebpackPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-webpack-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
          gitService: "github",
        }),
      ],
    };
+
    
+
    Public Repo Example - Non-GitHub Actions
    This setup is for public repositories that are not using GitHub Actions, this configuration will automatically upload the bundle analysis to Codecov. You will need to configure the it similar to the GitHub Actions example, however you will need to provide a branch override, and ensure that it will pass the correct branch name, and with forks including the fork-owner i.e. fork-owner:branch.
    
+
    // webpack.config.js
    const path = require("path");
    const { codecovWebpackPlugin } = require("@codecov/webpack-plugin");

    module.exports = {
      entry: "./src/index.js",
      mode: "production",
      output: {
        filename: "main.js",
        path: path.resolve(__dirname, "dist"),
      },
      plugins: [
        // Put the Codecov vite plugin after all other plugins
        codecovWebpackPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-webpack-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
          gitService: "github",
          uploadOverrides: {
            branch: "<branch value>",
          },
        }),
      ],
    };
+
    
+
    Private Repo Example
    This is the required way to use the plugin for private repositories. This configuration will automatically upload the bundle analysis to Codecov.
    
+
    // webpack.config.js
    const path = require("path");
    const { codecovWebpackPlugin } = require("@codecov/webpack-plugin");

    module.exports = {
      entry: "./src/index.js",
      mode: "production",
      output: {
        filename: "main.js",
        path: path.resolve(__dirname, "dist"),
      },
      plugins: [
        // Put the Codecov vite plugin after all other plugins
        codecovWebpackPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-webpack-bundle",
          uploadToken: process.env.CODECOV_TOKEN,
        }),
      ],
    };
+
    
+
    OIDC Configuration Example
    For users with OpenID Connect (OIDC) enabled, setting the uploadToken is not necessary. You can use OIDC with the oidc configuration as following.
    
+
    // webpack.config.js
    const path = require("path");
    const { codecovWebpackPlugin } = require("@codecov/webpack-plugin");

    module.exports = {
      entry: "./src/index.js",
      mode: "production",
      output: {
        filename: "main.js",
        path: path.resolve(__dirname, "dist"),
      },
      plugins: [
        // Put the Codecov vite plugin after all other plugins
        codecovWebpackPlugin({
          enableBundleAnalysis: true,
          bundleName: "example-webpack-bundle",
          oidc: {
            useGitHubOIDC: true,
          },
        }),
      ],
    };
 
    
 
    More information

    Index

    Functions

    codecovWebpackPlugin -

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov Webpack Plugin

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Codecov Webpack Plugin

    Generated using TypeDoc

    \ No newline at end of file