Integrations

Webpack Integration

Copy for LLMs
Deprecated: This integration will be removed in v1.0. Use CLI or CI instead. See deprecation notice.

Lighthouse auditing for webpack-based applications during development.

Install

yarn add -D @unlighthouse/webpack

Git ignore reports

Unlighthouse will save your reports in outputDir (.unlighthouse by default), it's recommended you .gitignore these files.

.unlighthouse

Usage

To begin using Unlighthouse, you'll need to add extend your webpack configuration.

When you run your webpack app, it will give you the URL of client, only once you visit the client will Unlighthouse start.

webpack.config.js example

import Unlighthouse from '@unlighthouse/webpack'

export default {
  // ...
  plugins: [
    Unlighthouse({
      // config
    }),
  ],
}

CJS example

const Unlighthouse = require('@unlighthouse/webpack')

export default {
  // ...
  plugins: [
    Unlighthouse({
      // config
    }),
  ],
}

Configuration

You can either configure Unlighthouse via the plugin, or you can provide a config file in the root directory.

Example

import Unlighthouse from '@unlighthouse/webpack'

export default {
  // ...
  plugins: [
    Unlighthouse({
      scanner: {
        // simulate a desktop device
        device: 'desktop',
      }
    }),
  ],
}
Edit this page
Markdown For LLMs
Did this page help you?

Vite

Integrate Lighthouse audits into your Vite development server with automatic route discovery and HMR support.

API Reference

Complete API reference for Unlighthouse core functions, context methods, and hooks system.