Options

Replacement Values

Top-level Properties

You can specify replacements directly as top-level properties:

replace({
  __VERSION__: JSON.stringify("1.0.0"),
  __AUTHOR__: JSON.stringify("test"),
});

Values Option

Alternatively, use the values option to keep replacements separate from other options:

replace({
  include: /\.js$/,
  values: {
    __VERSION__: JSON.stringify("1.0.0"),
    __AUTHOR__: JSON.stringify("test"),
  },
});

Function Values

Values can be functions that receive the file path and return a string:

replace({
  __BUILD_TIME__: (id) => JSON.stringify(new Date().toISOString()),
  __FILE_PATH__: (id) => JSON.stringify(id),
});

Filtering Options

include

• Type: RegExp
• Default: /.*/

Filter files that should be processed.

replace({
  include: /\.js$/,
  values: { __VERSION__: '"1.0.0"' },
});

exclude

• Type: RegExp
• Default: null

Filter files that should be skipped.

replace({
  exclude: /node_modules/,
  values: { __VERSION__: '"1.0.0"' },
});

TIP

When both include and exclude are set, include takes precedence.

Delimiters

delimiters

• Type: [string, string]
• Default: ['\\b', '\\b'] (word boundaries)

Customize the boundaries around replacement keys:

// Match without word boundaries
replace({
  delimiters: ["", ""],
  "@/src/": "./src/",
});

// Default word boundaries
replace({
  "@/src/": "./src/",  // Won't match "@/src/" in "my@/src/"
});