SolidStart Quick Start

Quick start guide for Codecov Bundle Analysis and SolidStart.

Step 1: Install the Codecov SolidStart Plugin

To install the @codecov/solidstart-plugin to your project, use the following commands.

npm install @codecov/solidstart-plugin --save-dev
yarn add @codecov/solidstart-plugin --dev
pnpm add @codecov/solidstart-plugin --save-dev

Step 2: Configure the bundler plugin

Add the plugin to the end of your modules array found inside your app.config.ts file, and pass your configuration.

YYou 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.

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

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