Webpack 5 Quick Start (Angular, CRACO)

🚧

Webpack 5 is currently the only supported version.

Step 1: Install the Codecov Webpack Plugin

Install the @codecov/webpack-plugin to your project.

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

yarn add @codecov/webpack-plugin --dev

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

Step 2: Configure the bundler plugin

Import the bundler plugin, and add it to the end of your plugins array found inside your webpack.config.js file.

For NextJS users, please see their docs for configuring Webpack inside the next.config.js file here.

You can find a Codecov upload token on the Configuration page for your repository, under General, or your organization settings page in the Codecov UI. For more information, see the documentation.

Note: You can find your global upload inside your org settings on Codecov

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

module.exports = {
  /* ... */
  plugins: [
    // Put the Codecov Webpack plugin after all other plugins
    codecovWebpackPlugin({
      enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined,
      bundleName: "<bundle project name>",
      uploadToken: process.env.CODECOV_TOKEN,
    }),
  ],
};

Step 3: Commit and push your latest changes

The plugin requires at least one commit to be made to properly upload bundle analysis information to Codecov.

git add -A && git commit -m "Add Codecov bundler plugin" && git push

Step 4: Build the application

When building your application the plugin will automatically upload the stats information to Codecov.

npm run build

yarn run build

pnpm run build

Sending Telemetry Data on Issues and Performance

By default, Codecov's bundler plugins collects telemetry data on issues and performance metrics internally, enabling us to analyze the plugins for performance and monitor potential issues.

You can opt-out of sending this telemetry data by setting the options.telemetry option in the plugin config to false. For example if you're using the Webpack plugin, the Codecov plugin configuration might look like the following:

codecovWebpackPlugin({
  enableBundleAnalysis: process.env.CODECOV_TOKEN !== undefined,
  bundleName: "<bundle project name>",
  uploadToken: process.env.CODECOV_TOKEN,
	telemetry: false // Setting to `false`
  // ... other options
})