performance.buildCache#

• Type:

type BuildCacheConfig =
  | boolean
  | {
      cacheDirectory?: string;
      cacheDigest?: Array<string | undefined>;
    };

• Default: false
• Version: >= 1.2.5

To enable or configure persistent build cache.

When enabled, Rspack will store the build snapshots in the cache directory. In subsequent builds, if the cache is hit, Rspack can reuse the cached results instead of rebuilding from scratch, which can reduce the build time.

Enable cache#

Setting performance.buildCache to true will enable the persistent build cache:

export default defineConfig({
  performance: {
    buildCache: true,
  },
});

Or only enable cache in development mode:

const isDev = process.env.NODE_ENV === 'development';

export default defineConfig({
  performance: {
    buildCache: isDev,
  },
});

Options#

cacheDirectory#

• Type: string
• Default: node_modules/.cache

Set the output directory of the cache files.

import path from 'node:path';

export default defineConfig({
  performance: {
    buildCache: {
      cacheDirectory: path.resolve(__dirname, 'node_modules/.my-cache'),
    },
  },
});

cacheDigest#

• Type: Array<string | undefined>
• Default: undefined

Add additional cache digests, the previous build cache will be invalidated when any value in the array changes.

cacheDigest can be used to add some variables that will affect the build result, for example process.env.SOME_ENV.

export default defineConfig({
  performance: {
    buildCache: {
      cacheDigest: [process.env.SOME_ENV],
    },
  },
});