Service Worker Build Pipeline

Design a build helper that produces a precache-ready service worker. It should let consumers opt into compiling the worker source (including extra compilation plugins) or fall back to copying the source as-is while still emitting clear warnings about ignored compilation options.

Capabilities

Compiled service worker

• When compilation is enabled, the service worker source is built through a dedicated compilation stage that accepts optional compilation plugins and writes the bundled worker to the requested destination, including the generated precache manifest. @test

Raw copy fallback

• When compilation is disabled, the service worker source is copied unchanged to the destination, and a warning notes that compilation-only plugins were ignored. @test

Shared build context

• Service worker compilation reuses the parent build’s filesystem/context so shared aliases or loaders resolve without additional configuration. @test

Implementation

@generates

API

export interface ServiceWorkerBuildOptions {
  /** Path to the source service worker file */
  swSrc: string;
  /** Destination filename for the emitted service worker */
  swDest: string;
  /** Whether to compile the source through a bundler pipeline */
  compile: boolean;
  /** Additional bundler plugins applied only during service worker compilation */
  compilationPlugins?: any[];
  /** The parent webpack compiler used to share context and filesystem */
  parentCompiler: import('webpack').Compiler;
  /** Optional hook for surfaced warnings */
  warn?: (message: string) => void;
}

export interface BuildResult {
  /** Absolute path to the emitted service worker */
  swOutputPath: string;
  /** Any warnings raised during the build */
  warnings: string[];
}

/**
 * Builds or copies the service worker based on the provided options.
 */
export function buildServiceWorker(options: ServiceWorkerBuildOptions): Promise<BuildResult>;

Dependencies { .dependencies }

workbox-webpack-plugin { .dependency }

Provides the manifest-injection tooling needed to emit the final service worker with its precache manifest.